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
|
Related Article
BMS Rest APIs V2