How do I use the latest version of the TaxJar API?

As improvements are made to the TaxJar API, we strongly recommend updating your custom integrations to utilize the latest version of the API to take advantage of any fixes and improvements. Additionally, all new accounts that generate an API token will default to the latest available version.

The available API versions can be found in the TaxJar API documentation.

To ensure all of your API transactions continue to import into our system properly and your sales tax reporting remains accurate, please have your technical team complete the following changes based on your type of API integration prior to the end of August 2022: 

Option 1. Add the below code to the header of code for your custom TaxJar API integration calls if applicable. This code will enable your site to use the latest version of the TaxJar API.

  • Code: "x-api-version": [latest-version-here]
  • Alternate code: "x-api-version" => [latest-version-here]

Once you’ve added the code above to your header, please test your current requests against the new version. 

  • This version should return an error message with the type of incorrect data sent to TaxJar, so you can fix any errors.
  • Once you are able to successfully test your data on the new API version, we recommend that you or your IT/development team take proper steps to prevent bad math for your transactions and to only use product tax codes that are supported by TaxJar or no tax codes at all if your line items are fully taxable.
  • You can find examples of how to manually implement the API version in your integration in our API documentation here by switching between the provided languages on the righthand side with the demo box.


Option 2. If you do not use a custom API integration, but instead use our API via a TaxJar integration, all you’ll need to do is update your first-party TaxJar integration to the latest version. At present, this includes:


Option 3. If you use the TaxJar API via a certified partner integration, we work with those partners to get their integrations updated as soon as possible to leverage the latest version.

On August 31st, 2022, we will auto-upgrade existing users to the latest version of our API. Once this happens, the new API version will reject transactions that fail data validation. We recommend upgrading today and adding logic to ensure a smooth transition to the new API. Upgrading before August 31st will allow you enough time for testing, and you'll be able to get ahead of issues with your data imports.

Please see the TaxJar API Versioning Update FAQ and the History section below for more information. 

For specific instructions and examples, please refer to the following related articles on how to address:

Please also feel free to reach out to our support team at support@taxjar.com if you have any questions as we want to work with you on this proactively and ensure you have a seamless transition.

History

  • In February 2022, we released API version ‘2022-01-24’ to provide validation for only supported product tax codes (PTC) as defined here and here. API requests to the /v2/transactions endpoint that contain line items using unaccepted product tax codes will result in a 400 Bad Request error. All newly-created TaxJar accounts after February 4, 2022 will be defaulted to using the latest API version.
  • In January 2021, we released support for API version ‘2020-08-07’, to provide increased validations around order and refund POST requests as well as to provide a better experience to ensure the totals of ‘line_items’ and ‘shipping’ details matched with the item ‘amount’ details. In July 2021, we began enforcing the 2020-08-07 release as the default version.