Skip to main content

Integration guideSeal API and Scripts

QuickBooks

Exchange purchasing, vendor and financial records.

Illustration of a seal beside a laptop showing a data table and an evidence binder linked by a red thread.

QuickBooks and SealSeal API and Scripts

Seal reads
Purchase orders, vendor records and related financial data
Writes back
The purchase-order and vendor data you agree
Source of truth
Agreed when scoped
Set up
Scoped with your team
Neil › Supplier review
draft

Bring the purchasing records into this supplier review.

Neil

  • Once the connection is configured, I’ll use the records it provides and cite each one. Anything it doesn’t supply stays listed as missing.
Reads
Purchase orders, vendor records and related financial data
Returns
  • Orders, vendor details and related quality records
  • Missing or unmatched information
  • Next steps for your team to review
Illustrative work with QuickBooks: a request to Neil, the source it reads and the draft it returns for your review.

1What’s connected.

Exchange purchase orders, vendor records and related financial data between QuickBooks and Seal through a connection set up with Seal’s API or Scripts. Confirm whether you use QuickBooks Online or Desktop, because their interfaces differ.

Connection setup and permissions

Use Seal’s APIs or scripting engine for a connection tailored to your process. Agree the data mapping, access and direction of transfer before implementation.

Related blueprints

2Exchange purchase orders and vendors with QuickBooks.

Route

QuickBooks Online’s Accounting API is REST: a create or update is a POST to the entity under the company’s realm ID, which appears in every request.⁠¹² A PurchaseOrder is a non-posting transaction with item or account lines and a status of Open or Closed. Vendor holds suppliers, and Item the products and services bought.⁠³⁴⁵ QuickBooks Desktop is reached through the Web Connector, a Windows application that runs beside QuickBooks, starts every exchange and carries qbXML messages.⁠⁶⁷

Record identity

Online entities carry a system-defined Id, and a purchase order links to its vendor by Vendor Id. A vendor’s DisplayName must be unique across vendors, customers and employees, and an item’s Sku is the company’s own identifier.⁠³⁴⁵ On Desktop, a purchase order is changed by its TxnID, and from qbXML 7.0 its lines carry a UnitOfMeasure, where units of measure are switched on for the company.⁠⁸⁹

Revisions

Online’s SyncToken is a version number, and an update sent with an older one fails. Desktop’s EditSequence does the same, refusing a stale one with status 3200.⁠³⁸¹⁰ Change data capture returns entities changed in a window of up to 30 days, at most 1,000 objects, with deletions marked Deleted.⁠¹¹

When it fails

Requests are refused with 429
QuickBooks Online allows 500 requests a minute per realm ID and 10 a second per realm and app. A throttled request returns 429, and Intuit advises waiting 60 seconds.⁠¹² Queue writes from Seal and retry after the wait.
A retried write made a second purchase order
Request IDs make writes, changes and deletions idempotent.⁠² Send every write with a request ID tied to the Seal record.
Lines vanished from a Desktop purchase order
In a Desktop modify request, existing lines left out of the request are deleted.⁠¹³ Send every line of the purchase order in each modify request.
A value Seal sent did not stick
A value sent in a read-only attribute is silently overwritten, with no error.⁠¹ Read the purchase order back after each write and compare it with the Seal record.

Check one record

Raise one purchase order for a qualified supplier in a test company. The Seal record should hold its QuickBooks Id, the Vendor Id and the SyncToken last read. Change the order in QuickBooks, then confirm that an update from Seal with the old SyncToken is refused rather than overwriting the change.

3Start with the job.

Tell us what Neil needs to do and which records it needs. We’ll confirm the interface, permissions and implementation scope with your team.

Discuss this connection →

4Before it goes live.

Access and any write-back

Define which records are in scope and whose permissions apply. Whether the connection writes back at all is a separate decision, with its own mapping and approval.

Verification and release

Review the configured connection for its intended use. Keep the requirements, checks and evidence with the change, and approve the release through your team’s controls.

Read the assurance detail →

References

  1. 1QuickBooks Online: REST API features.
  2. 2QuickBooks Online: basic field definitions.
  3. 3QuickBooks Online API: PurchaseOrder.
  4. 4QuickBooks Online API: Vendor.
  5. 5QuickBooks Online API: Item.
  6. 6QuickBooks Desktop: Web Connector.
  7. 7QuickBooks Desktop: communicating with QuickBooks.
  8. 8QuickBooks Desktop API: PurchaseOrderMod.
  9. 9QuickBooks Desktop API: UnitOfMeasureSetAdd.
  10. 10QuickBooks Desktop: status codes.
  11. 11QuickBooks Online: change data capture.
  12. 12QuickBooks Online: limits and throttles.
  13. 13QuickBooks Desktop: requests and responses.