API reference
Embedded engine endpoints
Bearer-scoped, environment-isolated. Mutations require Idempotency-Key.
Invoice Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/invoices | invoices:write | Creates a draft invoice with line items for a customer. |
| GET | /v1/invoices/{invoiceId} | invoices:read | Returns the external invoice shape. |
| PATCH | /v1/invoices/{invoiceId} | invoices:write | Updates mutable fields on a draft invoice. |
| POST | /v1/invoices/{invoiceId}/issue | invoices:issue | Moves a draft invoice to issued — locks the legal fields. |
| POST | /v1/invoices/{invoiceId}/send | invoices:send | Sends the issued invoice to the customer. |
| POST | /v1/invoices/{invoiceId}/void | invoices:write | Voids a draft or issued invoice. |
| GET | /v1/invoices/{invoiceId}/payments | invoices:read | Payments recorded against an invoice. |
| POST | /v1/invoices/{invoiceId}/payment-links | invoices:write | Attaches a hosted payment link to an invoice. |
| GET | /v1/invoices/{invoiceId}/audit | invoices:read | Actor + workspace-scoped evidence events for an invoice. |
| GET | /v1/invoices/{invoiceId}/document | invoices:read | The rendered document backing an invoice. |
| POST | /v1/invoices/{invoiceId}/preview | invoices:read | Renders a preview without mutating invoice state. |
Payments Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| GET | /v1/payments | payments:read | Payments for the environment, newest first. |
| POST | /v1/payments | payments:read | Creates a payment / payment link. |
| GET | /v1/payments/{paymentId} | payments:read | Returns a single payment. |
Collections Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| GET | /v1/collections/cases | collections:manage | Overdue-debt cases in the collection ledger. |
| GET | /v1/collections/actions | collections:manage | Dunning and recovery actions. |
| POST | /v1/collections/actions | collections:manage | Creates a recovery action against a case. |
| GET | /v1/collections/actions/{actionId} | collections:manage | A single collection action with state. |
Sign Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| GET | /v1/sign/envelopes | sign:envelopes:read | Signature envelopes, newest first. |
| POST | /v1/sign/envelopes | sign:envelopes:create | Creates an envelope for signing. |
| GET | /v1/sign/envelopes/{envelopeId} | sign:envelopes:read | Envelope status and recipients. |
| POST | /v1/sign/envelopes/{envelopeId}/complete | sign:envelopes:create | Completes an envelope after recipients sign. |
Paper Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/documents | documents:generate | Creates a document from structured content. |
| GET | /v1/documents/{documentId} | documents:read | Document metadata and render state. |
| POST | /v1/documents/{documentId}/render | documents:generate | Queues a document render (PDF). |
| GET | /v1/documents/{documentId}/versions | documents:read | Version history for a document. |
| POST | /v1/templates | documents:generate | Creates a reusable document template. |
| GET | /v1/templates/{templateId} | documents:read | Template metadata and variables. |
Proposal Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/proposals | proposals:write | Creates a commercial proposal. |
| GET | /v1/proposals/{proposalId} | proposals:read | Proposal with sections and status. |
| POST | /v1/proposals/{proposalId}/send | proposals:send | Sends a proposal to the recipient. |
| POST | /v1/proposals/{proposalId}/accept | proposals:write | Marks a proposal accepted (public accept flow). |
Pact / Contract Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/pact/contracts | pact:contracts:create | Creates a Pact contract. |
| GET | /v1/pact/contracts/{contractId} | pact:contracts:read | Contract with parties and clauses. |
| POST | /v1/pact/contracts/{contractId}/send | pact:contracts:send | Sends a contract to counterparties. |
| POST | /v1/pact/contracts/{contractId}/sign | pact:contracts:send | Records a signature on a contract. |
Pricing Oracle
| Method | Path | Scope | Summary |
|---|---|---|---|
| GET | /v1/pricing/catalog | pricing:read | Public-safe meter rates and module pricing. |
| POST | /v1/pricing/quotes | pricing:read | Quotes a module/usage combination from the Oracle. |
Payroll Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/payroll/calculate | payroll:calculate | Calculates a payroll run preview. |
| POST | /v1/payroll/runs | payroll:runs:create | Creates a payroll run. |
| GET | /v1/payroll/runs/{runId} | payroll:runs:read | Payroll run status and line items. |
Global Tax Engine
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/tax/calculate | tax:calculate | Calculates tax for a transaction. |
| GET | /v1/tax/jurisdictions | tax:read | Supported jurisdictions for calculations. |
Hosted Workflows
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/hosted/sessions | hosted:sessions:create | Hosted checkout / billing session. |
| GET | /v1/hosted/sessions | hosted:sessions:create | Sessions created in this environment. |
Embeddable Components
| Method | Path | Scope | Summary |
|---|---|---|---|
| POST | /v1/embed/sessions | embed:sessions:create | Embedded component session token. |
| GET | /v1/embed/sessions | embed:sessions:create | Sessions created in this environment. |