2025 R1 (General Availability)

2025-02-07

Introducing the Sage Intacct REST API

We are pleased to announce the general availability of our REST API! The 2025 R1 release introduces additional functionality and more parity with the Sage Intacct XML API.

Sage Intacct encourages your feedback, which you can provide using the Feedback tab on the right side of the page.

New endpoints

This release includes several new endpoints that were not part of the Early Adopter program, which aligned with 2024 R4. With 2025 R1 and the general availability of the REST API, the following new endpoints are now available.

Accounts Payable

• vendor-restricted-department
• vendor-restricted-location

Accounts Receivable

• customer-restricted-department
• customer-restricted-location

Company Configuration

• department-group
• department-group-member
• location-group
• location-group-member

Fixed Assets Management

• transfer-history

Inventory Control

• price-list-entry

Order Entry

• price-list-entry
• document-line-subtotal

Purchasing

• price-list-entry
• document-line-subtotal

• Revised endpoints

Endpoints that have been revised since the Early Adopter program in 2024 R4, are listed in the following sections.

memberFilter for dimension groups

The fields to filter the dimension group members in these two dimension group objects have been replaced with a memberFilter object that uses the standard query function of the REST API:

• company-config/affiliate-entity-group
• inventory-control/item-group

Other updates

Bulk request service (Open Beta)

Now you can use the bulk service to process large volumes of data for improved efficiency. The bulk service enables scalability by handling large-scale non-blocking data processing.

To learn more about this service, see Bulk requests.

Outbound webhooks (Early Adopter)

Our new option for Platform trigger POST requests offers reliable and consistent webhook delivery with automatic retries for handling delivery failures.

To learn more about using this feature, see:

• Outbound webhooks (Early Adopter) .
• Add Platform triggers to automate tasks

Client credential grant type

With this release of the REST API, client applications can now use the client credentials OAuth 2.0 grant type to gain secure access to Sage Intacct REST API endpoints. This grant type is ideal for automated server to server connections, enabling secure and direct API calls without user involvement. Use this grant type for:

• Backend systems and headless applications
• Automating processes from webhook events

To learn more, see Client credentials grant type.

Sub-entity access tokens

Multi-entity companies include one top-level entity with one or more sub-entities. Sub-entities may contain their own unique records and so the Sage Intacct REST API provides the ability to access those records. You can send a single request to a sub-entity or use a sub-entity access token. To learn more, see Entity-level access.

Common services

This release introduces new common services as follows:

• Model service - Use the model service to find all of an object's queryable fields, their data types, valid values (for enums) and relationships to other objects.
• Allowed operations - Returns allowed operations for specified objects.

Planned improvements

The following enhancements are planned for a future release.

• Accounts Payable adjustment-line object - the response code for a successful PATCH operation will be changed from 201 Created to 200 OK .
• The Composite request service does not currently support Construction Forecasting objects or Fixed Assets objects. Including these objects in composite requests will result in error responses.

Notes

When working with the Sage Intacct REST API, be aware of these behaviors.

PATCH operations for arrays

A PATCH operation on an array of owned objects behaves differently from PATCH operations on all other arrays. Keep the following differences in mind when using PATCH with arrays:

• When using PATCH to update an owning object that has an array of owned objects, you can add new entries, edit existing entries, and delete entries from the array.
• When using PATCH to update any other type of array in an object, the values in the request body will replace the entire array. The prior values will be overwritten and cannot be restored.

Fields returned by the GET and query operations

You can use the standard HTTP GET operation or the query service to retrieve information about a specified object or objects.

• Use the GET operation, with a key, to retrieve all fields for an object. Note that, the href property is not included in the response for objects in Construction Forecasting and Fixed Assets Management application areas.
• Use the query service to retrieve specified fields for objects that match the query filter. Note that, if you include the href property in the list of requested fields, the operation returns the REST-1107 error for objects in Construction Forecasting and Fixed Assets Management application areas.