What we do
Tools
Industries
Department
How we workLet's talk →
Home/Sage Intacct/Sage Intacct API Documentation, REST and XML
Sage Intacct developer docs

Where the Sage Intacct API Documentation Lives, and What It Asks For Before Your First Call

Search for the Intacct docs and you land on two sites that both look official. developer.intacct.com still hosts the XML Web Services reference, and developer.sage.com/intacct carries the newer REST API. Both are current. Which one you read depends on whether you're writing new code or keeping an old integration alive, and neither will authenticate a call until the licensing and company setup are done.

The short version

Writing something new? Read the REST API docs on developer.sage.com/intacct. Sage recommends REST for client applications and releases new objects and features there. Calls go to https://api.intacct.com/ia/api/v1 with OAuth 2.0, using the authorization code or client credentials grant.

Maintaining an XML integration? The reference is still on developer.intacct.com. Every request is a POST of XML to https://api.intacct.com/ia/xml/xmlgw.phtml. It doesn't accept JSON, and GET requests are blocked.

Before either works: a Web Services developer license (it comes with a sender ID and password), the Web Services subscription switched on in the company, and your sender ID added to that company's authorizations list.

Company Admin Subscriptions

Intacct REST API or XML Web Services: which docs to follow

REST API

For new integrations

  • JSON over HTTPS, with OAuth 2.0 instead of credentials in every request body.
  • Where Sage now ships new objects and features, so newer modules show up here first.
  • Docs, tutorials and a downloadable OpenAPI spec on developer.sage.com/intacct.
XML Web Services

For the integrations already running

  • One gateway URL. Each request carries a control block, an operation block and your functions, with dtdversion set to 3.0.
  • Sessions come from getAPISession, which also hands back the endpoint to use for the rest of the run.
  • Official SDKs for .NET, Node.js and PHP, plus a Postman collection of first calls.

Sage says it keeps supporting the XML API, and existing integrations keep working. Move one to REST when it needs an object or feature that only REST has, not just because REST is newer.

From a new developer license to a list of vendors

The XML route, because that's where most people get stuck. The credential steps carry over to REST.

  1. 1

    Get the Web Services developer license

    It comes from Sage, through your account manager or, for software vendors, Sage's Marketplace partner program. It includes the sender ID and sender password: the credentials that identify your application, separate from any user login.

  2. 2

    Switch on Web Services in the company

    Company Admin Subscriptions

    A company admin turns on the Web Services subscription for the Intacct company you'll be calling. Without it, nothing authenticates however well-formed the request is.

  3. 3

    Authorize the sender ID in that company

    The admin adds your sender ID to the Web Services authorizations list on the Security tab of Company Configuration. Each company you call needs this, including any test company.

    Watch for: error XL03000006, "Invalid Web Services Authorization". It means this step was skipped for the company in the request.

  4. 4

    Create a Web Services user

    Sage strongly recommends a dedicated Web Services user for the integration rather than a person's login. Give it only the permissions the integration needs, and nobody's password change breaks the sync.

  5. 5

    Open a session with getAPISession

    Send your sender credentials plus the company ID, user ID and password once, and the response gives you a session ID and an endpoint. Use both for the calls that follow, and check the endpoint is an intacct.com address before you trust it.

  6. 6

    Run a first read

    A readByQuery on VENDOR returns a page of vendors, which proves the whole chain works. Then inspect an object such as CUSTOMER (add details="1" for field attributes) to see the fields your company really has, custom ones included.

Intacct calls that authenticate fine and still let you down

Logging in with credentials on every request

How you'll know: It works, but each call carries a password and runs slower than it should.

Fix: Sage advises against login authentication for every request. Open one session with getAPISession and reuse the session ID until it times out; each response tells you when that will be.

Pulling the whole ledger in one query

How you'll know: Big reads time out, or return a fraction of what you expected.

Fix: Keep each query under 1,000 records and page through the rest. Very large requests can run into a 15-minute timeout, so split them by date or entity.

Writing hundreds of records in one request

How you'll know: A batch import half-fails and you can't tell which lines posted.

Fix: Keep each write under 100 records and log the result of every function in the response, so a failure points at one record, not a whole file.

Firing calls in parallel to go faster

How you'll know: Requests sit in a queue and response times climb.

Fix: Intacct caps concurrent connections per company ID and holds the rest. Throughput depends on your level of service, so a busy integration may need that conversation with your account manager, not more threads.

Entries posted without their dimensions

How you'll know: The API accepted every invoice, but the department and location reports are empty.

Fix: Unless the company makes them required, Intacct accepts many records without entity, department, class or location. Set them from the source data on every write, and reject records that can't be mapped rather than posting them untagged.

Once the first call works, the finance logic is the job

Getting a session open takes a day. The weeks go on making the data land the way your reporting expects: a closed CRM deal that becomes a contract with its billing schedule, entity, department and class set from the start; a leadership dashboard fed straight from the API instead of an exported report reformatted each month; multi-entity postings that consolidate without a journal fix.

n-frames builds those integrations against Intacct's APIs, REST for new work and XML where an existing integration already runs. For change notices we use Smart Events set up in the company, which can send an HTTP post when a record changes, or scheduled reads filtered on when records were last modified, depending on how fast the other system needs to know. For connectors and partners, see Sage Intacct integrations; for the bills side, Intacct AP automation.

Sage Intacct API and developer license questions

What is a Sage Intacct sender ID?

It's the Web Services credential that identifies your application, issued with a sender password under a Web Services developer license. It's separate from user credentials: a request carries the sender ID to say which app is calling, and a user or session to say which company and whose permissions.

What's the difference between Sage Intacct's REST API and its Web Services API?

The Web Services API (often called the XML gateway, after its xmlgw endpoint) is the older interface: XML posted to one URL, with credentials in the request. The REST API uses JSON and OAuth 2.0, and it's where Sage now releases new objects and features. Both are supported.

Do I need a developer license to use the Sage Intacct API?

Yes. The sender ID and password come with an active Web Services developer license. The company also has to have the Web Services subscription turned on and your sender ID authorized. Software vendors usually get the license through Sage's Marketplace partner program; customers through their account manager.

Is the Sage Intacct API documentation publicly available?

Yes. The REST docs, tutorials and OpenAPI spec are on developer.sage.com/intacct, and the XML Web Services reference, SDK guides and Postman collection are on developer.intacct.com. Both are open to read; you need the license and company setup to make calls.

Can I build a custom integration without going through a Sage Intacct partner?

Technically yes, once you have the license and the company setup above. Many businesses still bring in their implementation partner for anything touching revenue recognition or multi-entity rules. n-frames builds the integration itself and works alongside your partner on the accounting decisions.

Let's talk

Tell us the one thing your team does manually that eats up time. We read every message and reply within a day.