API reference
Embedded engine endpoints
Filtered to Invoice Engine. 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. |