Get Sales Invoice Summary
GET/api/sales-invoices/summary
KPI figures for the invoices matching the same filters as List Sales Invoices: outstanding, overdue and due-within-7-days balances and counts, the number of shipped-but-uninvoiced shipments (the same shipments List Uninvoiced Shipments returns), and column totals (filtered_totals, null when the filter matches more than 20,000 invoices). matching_count is how many invoices match the filters; amount_sort_available is false above 20,000 matches, when List Sales Invoices refuses a total / balance_due sort or filter.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires orders:read and sales_invoices.index.
Due dates: due_date is the effective due date: the stored due date, else the invoice date plus the customer's payment terms, else the invoice date. due_date_is_derived is true when no due date is stored and it was worked out from terms. Drafts are never overdue. Due-status and due-date filters and sorts use the same effective date.
Channel-settled orders: an order invoice (order_mirror) whose order the sales channel marks paid, refunded or partially refunded has balance_due 0 and payment_status paid, whether or not payment records exist.
Request
Responses
- 200
- 401
- 403
- 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.
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.