API versions

All Sage Intacct endpoints support explicit versioning in the path of the request URL. For example, when the current version of the API is version 1, the following is the endpoint for the General Ledger account object: https://api.intacct.com/ia/api/v1/objects/general-ledger/account

When breaking changes are made to the API, Sage Intacct releases a new API version. Individual endpoints are not versioned independently. Instead, all Sage Intacct endpoints are moved to the next version when a breaking change is introduced.

Breaking and non-breaking changes

When changes are made to API objects or services that are not backwards-compatible, those changes are considered to be breaking changes that require a new API version. Examples of breaking changes include, but are not limited to, changes like the following to existing objects, services, or workflows:

  • Removing or renaming existing resources, or their existing properties
  • Adding new required properties without defaults
  • Removing or changing existing properties in request/response payloads

Changes that are backwards-compatible are non-breaking changes. Non-breaking changes include, but are not limited to, changes like the following to existing objects, services, or workflows:

  • Adding a property to POST/PATCH request payloads that is nullable or has a default value
  • Adding a property to a response
  • Adding optional new properties

API updates

API versions are managed as follows:

  • New API versions will be released only with regular quarterly releases of Sage Intacct. New API versions will not be included in interim off-cycle releases.
  • Previous versions are supported for two years after the introduction of a new API version. For example, if version 2 is released on August 14th 2024, then version 1 would no longer be available as of August 15th 2026.
  • When a new API version is released, Sage Intacct:
    • Recommends that you test and adopt the new version as soon as possible.
    • Returns headers in API responses, informing you that a new version is available.
  • For versions that are no longer supported, any requests issued to that version will generate an error.