Public OpenAPI 3.0. The same contract our frontend uses.
This page summarizes what to expect from the spec, how auth works, how we version and where to start. For the architectural detail, see the platform page.
Four things worth knowing before you integrate
Every business resource
Standard CRUD, per-field PATCH, state transitions as POST sub-resources. Typed contracts with examples.
OAuth 2.0 + per-domain scopes
Tokens with explicit scopes by ERP domain. Service tokens for backend integrations, user tokens for UI.
SemVer in the path
Major versions at <code>/v1/</code>, <code>/v2/</code>. Compatible changes without bumping. Deprecations announced six months ahead.
OpenAPI contents
- Every resource across the 54 domains — from
invoicesandjournalEntriestoshipments,commissionPlansandlandedCosts. - Uniform filtering and pagination.
?field.operator=valueconvention on every list endpoint; cursor-based pagination on high-volume ones. - Enriched 409 responses. When
RowVersiondoesn't match, the response carries the full current entity — not just the error. - Typed webhooks. Business events (
invoice.posted,period.closed), not CRUD events. Payload documented per type. - Runnable examples. Every endpoint carries at least one request and response payload in the spec.
Spec, sandbox and credentials
Today we share the OpenAPI with customers in evaluation under NDA and with active integration partners. The public sandbox is in preparation; once released, it will live on this domain with generous rate limits for contract-free testing.
Open sandboxSandbox URL pending — contact sales for early access. We'll send you the spec, test credentials and a notebook with the first flows (create customer, create invoice, post it, close a period).
Review it with your integrators
We'll send the current OpenAPI and set up a 45-minute technical session to answer your team's specific questions.