Get Sales Order Billing
GET/api/sales-orders/:salesOrder/billing
Get a sales order's billing state under its payment term's billing schedule: the term snapshot (preset, summary sentence, revenue timing), one row per schedule line (document type, amount, trigger, due date, status, the raised document, and whether it can be raised now or retried), the automatic final-invoice row for prepay / deposit schedules, the release gate's progress, any over-billing (raised documents above a reduced order total block further lines) and the order's open payment requests.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Line status: pending, raised, satisfied (its document is fully paid), cancelled, skipped, error. each_shipment lines list one entry per shipment in occurrences. runs is false (with reason) when the schedule is recorded but billed by the channel or overridden by an invoicing policy.
Requires permission sales_invoices.index.
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.