TypeScript integrations can use the signed methods in the ApiClient invoice reference. Endpoint schemas are also available in the generated API reference.
Endpoints
Authentication
Generate theAuthorization value from the API secret, HTTP method, exact path without the /v3 prefix, and current timestamp. The ApiClient generates this automatically when you pass apiSecret.
Create and publish
POST /invoices validates the complete invoice, creates a linked SALE order, and emails the recipient a PDF and hosted payment link.
id and provide the complete required blocks shown above.
Save or update a draft
POST /invoices/drafts accepts partial content. Omit id to create a draft or include an unpublished draft ID to update it.
List invoices
GET /invoices accepts:
The response contains
data: InvoiceResponse[] and pagination metadata.
Retrieve, archive, or delete
GET /invoices/{invoice_id}returns the invoice details and linked orders.POST /invoices/{invoice_id}/archiveretains the invoice and setsarchived_at.DELETE /invoices/{invoice_id}returns204for a deleted unpublished draft. Published invoices cannot be deleted.
Response fields
order_id and orders for payment reconciliation. A published invoice is not necessarily paid; fulfillment depends on the linked order reaching COMPLETED.