Get Sales Order Billing Summary
GET/api/sales-orders/:salesOrder/invoices
How a sales order is invoiced: its invoicing policy and where it came from, invoice status and a one-line verdict, ordered / invoiced / paid / credited totals, one lane per shipment (invoiced, ready to invoice, skipped, or voided after invoicing), per-line reconciliation (ordered, shipped, invoiced, credited, billable), fee remainders and the order's invoices.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires orders:read and sales_invoices.index.
Lane state: invoiced, ready, skipped, voided_after_invoice, or covered (shipped and not linked to an invoice, but every unit it shipped is already billed by the invoice of a shipment voided after invoicing — it becomes ready once that invoice is voided or credited). Lane invoice includes invoice_date.
Consolidated invoices that bill this order alongside other orders are listed in invoices too; the order's invoiced_total, paid_total and credited_total count only this order's share of them.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.