API Versioning

Updated on 16 Jan 2025
1 Minute to read

Article summary

Did you find this summary helpful?

Thank you for your feedback

With the 6.22.1.0 release on January 15, 2025, we have introduced a second version of the REST API. Version 1.0. will continue to be the default version until further notice. Users require no change unless they choose to adopt Version 2.0.

How to Use Version 2.0

To adopt Version 2.0 into your solution, simply include an api-version key with the value 2.0 in the header of your request. If the api-version key is not included in a request, then the request will default to Version 1.0 of the API.

Version 2.0 Significance

The main difference between the Version 1.0 endpoints and Version 2.0 endpoints is that the InvoiceNumber field has been changed from integer to decimal to allow clients using the Reverse and Rebill functionality to retrieve the full InvoiceNumber value.

The GET Invoices endpoint also includes two additional fields (InvoiceNumberMajor and InvoiceNumberVersion) that have been added to allow clients to query for invoices that have been reversed and rebilled. Version 2.0 includes the following endpoints:

GET Invoices
GET InvoiceRevenues
GET InvoiceTaxes
GET Payments (InvoiceNumber field is within the child PaymentAllocations collection)
GET WorkTicketTimes
GET WorkTickets

Known Issue

When using the $filter option in Version 2.0 on the InvoiceNumber field with a decimal value (any Reverse&Rebill invoices), the original invoice data is returned instead of the requested data.

Workaround

while we continue to investigate and resolve this error, please use the InvoiceNumberMajor and InvoiceNumberVersion in any $filter option to ensure the correct Invoice record is returned.

Example:

Instead of $filter=InvoiceNumber eq 1234.002 use $filter=InvoiceNumberMajor eq 1234 and InvoiceNumberVersion eq 2

Was this article helpful?

What's Next

Overview

Table of contents