Frequently asked questions

How can I access documentation for the REST API?

Sage Intacct provides comprehensive documentation on our REST API developer documentation portal, which includes:

A Quick start that explains how to authenticate with the API, send test requests, and build an efficient client application.
API reference pages that provide detailed information about the services and objects available with the REST API.

Is there any cost associated with using the API?

To access the Sage Intacct REST API, you must have a web services developer subscription. Please contact your account manager for more information.

What support is available for developers?

Sage Intacct Developers Club: This is a community forum where you can post questions, share insights, and engage with fellow developers. Our Developer Experience product managers actively monitor the forum and respond to queries.

Support cases for REST API issues: If you encounter issues specifically related to the REST API, you can also open a support case through the official support channels for more direct assistance. To open a support case:

Log in to Sage Intacct Community , then click the Support tab.
Click Log a Case to begin the support case process.

Can I use the REST API in a production environment?

Yes, you can use the REST API in a production environment. To do so, be sure to set the client scope to Production when getting API keys as described in our Quick start.

How are breaking changes to objects and services handled?

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. New API versions will be released only with regular quarterly releases of Sage Intacct. Previous API versions are supported for two years after the introduction of a new API version. To learn more, see API versions.

How can I determine which fields I'm allowed to request and get back for each object?

Use the model service to find all of a specific object's queryable fields, their data types, valid values, and relationships to other objects. For more information, see Models in the REST API Reference.

How can I find out more about the operations that are allowed for specific objects, like specific vendors?

Use the allowed operations service as described in Allowed operations in the REST API Reference.

In the XML API, I was able to use the query function to query data in my company. How do I query my company data using the REST API?

Use the query service to find objects that match certain conditions. To learn more about the fields that can be queried and the filters, filter expressions, and filter parameters you can use, see Query.

Am I allowed to combine requests using the REST API?

Yes, you can combine multiple REST API requests using batch, bulk, and composite requests.

Batch requests process multiple records for a single REST API object in one request. For example, you can create multiple contact records in a single request.
Bulk requests process multiple operations for one REST object with a single HTTPS call. The bulk request service provides two functions: (1) file upload to submit a bulk request for asynchronous processing, and (2) job status to get the status of asynchronous jobs.
Composite requests process multiple sub-requests for different objects or services in a single HTTPS call. For example, you can create a new contact, update an existing vendor, query bills, and more, in a single request.

Are transaction operations from the XML API supported in the REST API?

In the XML API, transactions are a group of function calls that succeed or fail as a single unit. This same functionality is available in the REST API using batch requests that are processed atomically. See Atomic requests to learn more.

How do I issue requests to specific entities in a multi-entity company?

To issue REST API requests to a specific entity, use the X-IA-API-Param-Entity header to specify the entity ID as described in Entity-level access in the OAuth 2.0 authorization guide. You can also use a sub-entity access token to issue multiple requests to a sub-entity as described in Change to a sub-entity access token.

What is the best way to save my queries so that I can re-use them?

To save queries that you want to use again, create user views as described in Create a user view.

How do I get more information about REST API error messages?

To understand the codes returned by the REST API, both the HTTP status codes and the JSON response payload, refer to Error handling.

How can I provide feedback about the REST API documentation?

The REST API documentation includes a Feedback tab on each page. You can use this tab to report any issues, omissions, or other feedback regarding the documentation.