QuickBooks Desktop API: The Four Ways In, Since There's No REST Endpoint
You went looking for API keys and landed on developer.intuit.com, where nearly every example uses QuickBooks Online's REST endpoints and OAuth. None of that reaches a Desktop or Enterprise company file. Desktop speaks qbXML, through an SDK on the Windows machine that opens the file, and anything outside that machine gets in through the Web Connector or a service built on it.
Four routes into a Desktop company file
One qbXML round trip, from request to response
This is what every route above is doing underneath. Knowing it is what makes Web Connector errors readable.
- 1
Authorize the app in the company file
Edit › Preferences › Integrated Applications › Company PreferencesThe first time an SDK or Web Connector app asks for access, an admin signed into the file has to approve it and choose whether it may connect even when QuickBooks isn't running. Unattended syncs need that second option.
Watch for: a new Windows user or a moved company file can make QuickBooks ask again, and the sync waits on a dialog nobody sees.
- 2
Open a session and send a request
Your app sends a qbXML message such as InvoiceAddRq or CustomerQueryRq, wrapped in a version header that has to match what that QuickBooks year supports. QBFC can build the XML for you if you'd rather not write it by hand.
- 3
Read the status code, not just the response
Each response carries a statusCode and a message. 0 means it worked. 3100 usually means a name is already in use, and 3200 means the record changed since you read it.
Watch for: Web Connector apps that ignore these codes are where "create failed" with no further detail comes from.
- 4
Modify with the EditSequence you just read
To change a record you send its ListID or TxnID plus the EditSequence from your last read. If someone edited it in QuickBooks in between, you get error 3200 and have to read it again first.
- 5
Page through large queries with iterators
Pulling every invoice in one request can stall a busy file. Query in chunks with an iterator, and filter by modified date so each run only asks for what changed.
Questions about your setup that decide the route
Which edition and year is the company file?
Intuit says 2024 was the last annual Desktop release, and older years lose connected services. The year also sets which qbXML version you can send. Our Desktop going away guide has the dates by edition.
Where does the file live?
A local PC, an office server or a hosted desktop each change where the SDK or Web Connector can run, and who can install it. Multi-user mode adds its own locking to plan around.
Is there a Windows machine that stays on?
Every route except a one-off export needs one. If the only candidate is a laptop that goes home at night, that changes the design.
Which way does the data go, and how fast?
Read-only reporting points to ODBC. Orders that must land within minutes point to the SDK or a tight Web Connector schedule. Nightly batches fit the Web Connector comfortably.
Do you use Enterprise inventory features?
Sites, bins and serial numbers through Advanced Inventory change which fields a request has to fill.
Is a move to QuickBooks Online on the table?
If the file moves in a year, the other system should talk to an integration layer you can repoint, not straight to qbXML.
Shopify retailer
Shopify to QuickBooks sync
A retailer's Shopify sales synced into QuickBooks as one number a day, and every month someone spent half a day working out why a payout didn't match. We rebuilt the sync to itemize by product category, use real product costs, and match each payout to the orders, fees and refunds behind it. The half-day reconciliation became a five-minute check.
More on integrating QuickBooks Desktop and Enterprise
A Desktop integration that logs what it did, and what it couldn't
n-frames builds QuickBooks Desktop and Enterprise integrations on the SDK or the Web Connector: the qbXML requests, the error handling for 3100s and 3200s, the Windows service that keeps it running, and a log your team can read when an order doesn't post. Reporting-only needs get ODBC instead.
Estimate the Desktop integration →QuickBooks Desktop API questions from developers and ops leads
Does QuickBooks Desktop have a REST API like QuickBooks Online?
Not from Intuit. QuickBooks Online has the cloud REST API with OAuth. Desktop and Enterprise use qbXML through the Desktop SDK, usually reached from outside through the Web Connector. Third parties such as Conductor sell a REST layer on top, which still depends on the Web Connector and a Windows machine that's switched on.
Can you connect QuickBooks Desktop to Salesforce?
Yes. The usual design is a small web service that the Web Connector polls: Salesforce opportunities marked closed-won become qbXML invoice or sales order requests, and payments read back from QuickBooks update the account. If Salesforce only needs to show balances, a read-only ODBC feed is simpler. Our QuickBooks and Salesforce page covers the Online side.
Why does our Web Connector sync keep failing?
The usual causes are a qbXML status code the app doesn't handle (3100 duplicate names, 3200 stale EditSequence), a session that times out on a large query, special characters in names, or an authorization that lapsed when the Windows user changed. The Web Connector's own log shows which request failed. n-frames reads that log first, then fixes the service so it reports the error instead of skipping the record.
Is the quote for QuickBooks Desktop API work really free, with no obligation?
Yes. We'll look at your edition, where the file lives and what needs to flow each way, then tell you which route fits and what it costs to build. What you do with that quote is up to you.