API Notes from Release Notes (Tracking Changes from Jan 2022)

Introduction

The following is a summary of API notes from various release notes from Jan 2022 till date.

SN Included From Module Description
1 Release Notes Vorex 5.8.0 & BMS 5.8.0 – Jan 2022 -
  • API users will no longer be enforced for MFA.
    • If your tenant has "Require MFA for non-SSO users" set to "Yes", the API user will be able to generate the access token.
Service Desk
2 Release Notes Vorex 5.9.0 & BMS 5.9.0 – Feb 2022 CRM

V2 API

Additional endpoints listed below are added to our V2 APIs.

  • GET /v2/crm/accounts/summary/{id} is added. This endpoint returns one account record from the CRM with the matching identifier (Id).
  • GET /v2/crm/contacts/summary/{Id} is added. This endpoint returns one contact with emails and phones in the CRM with the matching identifier (Id).

V2 API - Document Update

Lookups are now added to API V2 documentation. This link shows the table names that can be used for the Lookup Endpoints. 

3 Release Notes Vorex 5.10.0 & BMS 5.10.0 – Mar 2022

Finance/

System

V2 API

Additional endpoints listed below are added to our V2 APIs.

  • GET /v2/finance/invoices/{id}} is added. This endpoint returns one invoice object for the matching identifier (Id).
  • GET /v2/finance/invoices/summary is added. This endpoint returns a list of all the invoices.
  • POST /v2/finance/invoices/details is added. This endpoint returns an array list of Invoice Details.
  • POST /v2/system/tenantlookup/{tableName} is added. This endpoint will accept one object of type lookup for the table name used.
4 Release Notes Vorex 5.13.0 & BMS 5.13.0 – July 2022 Finance / CRM / Service Desk

V2 API 

Additional endpoints listed below are added to our V2 APIs.

  • Change Invoice Status
    • PATCH /v2/finance/invoices/marksent is added. This endpoint provides the ability to change the status of invoice(s) from ready to send to sent.
    • This is applicable only to invoices of status ”ready to send” and no pdf/invoices will be generated.
  • GET /v2/crm/opportunities/summary/{id} is added. This endpoint is used to load one opportunity based on a supplied id.
  • GET /v2/crm/opportunities. This endpoint is used to load all opportunities with the ability to filter and sort, and support for paging the result.
  • PUT /crm/opportunities/{id}. This endpoint is used to update an existing opportunity with the matching identifier {id}.
  • POST /v2/crm/opportunities is added. This endpoint is used to create a new Opportunity.
  • GET v2/time/timelogs is added. This endpoint returns the list of all Time logs
CRM

V1 API 

  •  /api/crm/servicequotations supports free items when adding or updating a Service Quotation.
5 Release Notes Vorex 5.14.0 & BMS 5.14.0 – Aug 2022 CRM

V2 API

GET /v2/crm/quotes/{quotationId} results now include

  • SalesRepresentativeId
  • SalesRepresentativeName
6 Release Notes Vorex 5.15.0 & BMS 5.15.0 – Sep 2022 Service Desk, CRM

V2 API 

  • POST /v2/servicedesk/hardwareasset, This endpoint gives the ability to create hardware assets.

  • PUT /v2/servicedesk/hardwareasset/{assetId}, This endpoint allows users to update a hardware asset based on the Id.
  • PUT V2/crm/accounts/{Id} This endpoint gives the ability to update an account.
  • V2 API POST V2/crm/accounts is added. This endpoint enables users to add accounts.
7 Release Notes Vorex 5.17.0 and BMS 5.17.0 - Dec 2022 CRM

V2 API

  • POST /v2/crm/opportunities/{opportunityId}/notes results now include 
    • creating opportunity notes
  • PUT /v2/crm/opportunities/{opportunityId}/notes/{notedId} results now include
    • updating an existing note added to opportunity
  • GET /v2/crm/opportunities/{opportunityId}/notes results now include
    • getting all notes related to an existing quote
8 Release Notes Vorex 5.18.0 and BMS 5.18.0 - Jan 2023 CRM

V2 API

  • GET /v2/system/accounttypes/lookup
    • returns the CRM account types
9 Release Notes Vorex 5.19.0 and BMS 5.19.0 - Feb 2023 CRM, Finance

V2 API

  • POST /v2/finance/contracts/recurringservices (25333)
    • creates a new recurring service contract
  • PUT /v2/crm/contacts/{id} (23965)
    • updates a contact object
10 Release Notes Vorex 5.20.0 and BMS 5.20.0 - Apr 2023 CRM, Finance

V2 API

  • GET /v2/crm/opportunities/statuses/Lookup 
    • returns all opportunity statuses
  • PUT /v2/finance/contracts/recurringservices/{id} 
    • updates existing recurring services
11 Release Notes Vorex 5.21.0 and BMS 5.21.0 - May 2023 CRM, Finance

V2 API 

  • PUT /v2/finance/contracts/{Id}/activate
    • updates the status of the recurring services contract and activate the contract per ID 
  • PUT /v2/finance/contracts/{Id}/deactivate
    • updates the status of the recurring service contract to deactivate the active recurring services contract per ID 
  • POST /v2/finance/contracts/recurringservices/{id}/services
    • creates a service in an existing recurring service contract 
  • GET /v2/crm/dashboard/quotations/summary
    • returns all pending quotes in the last seven days from the current date
12 Release Notes Vorex 5.22.0 and BMS 5.22.0 June 2023 Inventory

V2 API

  • POST /v2/inventory/products/categories
    • creates new products categories in Inventory 
  • GET /v2/inventory/products/categories/lookup
    • gets all products' categories in Inventory in a lookup format  
13 Release Notes Vorex 5.24.0 and BMS 5.24.0 CRM, Admin, System

V2 API

  • PATCH /v2/crm/contacts/{id}
    • Gives the ability to partially update one or multiple properties of the contact 
  • PATCH /v2/crm/accounts/{id}
    • Gives the ability to partially update one or multiple properties of the account 
  • GET /v2/admin/security/roles/lookup
    • Retrieves all the security roles available per tenant 
  • GET /v2/admin/hr/jobtitles/lookup
    • Retrieves all the job titles available per tenant 
  • GET /v2/admin/hr/departments/lookup
    • Returns all departments that the tenant has in BMS 
  • GET /v2/system/locations/lookup
    • Returns all locations that the tenant has in BMS
14 Vorex 5.25.0 and BMS 5.25.0 HR

V2 API

  • GET /v2/hr/employees/lookup
    • Returns all employees' records stored in database
15 Vorex 5.27.0 and BMS 5.27.0 Admin/System

V2 API

  • GET V2/admin/workflows/{workflowId}
    • Gets workflow by ID 
  • PUT /v2/system/customfields/data/{moduleId}/{entityId}/{customFieldId}
    • Updates the custom field's data in BMS depending on the moduleId, entityId, and CustomFieldId   
  Vorex 5.28.0 and BMS 5.28.0  HR, CRM, Service Desk

V2 API

  • GET /v2/hr/employees/searchselect 
    • Allows you to search for employees within the system
  • GET /v2/crm/contacts/searchselect 
    • Allows you to search for contacts within the system
  • DELETE V2/crm/contacts/{Id}  
    • Deletes contacts by ID 
  • DELETE V2/servicedesk/hardwareasset/{Id}  
    • Deletes hardware assets by asset ID
  • GET /v2/servicedesk/hardwareasset/searchselect  
    • Exposes attributes (account ID, account name, and status) to the response payload

 

Related Article

BMS Rest APIs V2

Have more questions?

Contact us

Was this article helpful?
0 out of 0 found this helpful

Provide feedback for the Documentation team!

Browse this section