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:

  1. Log in to Sage Intacct Community , then click the Support tab.
  2. 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 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 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.