List Customer Receivables
GET/api/customers/:customer/receivables
Paginated receivables worklist for one customer — each row is a sales order reduced to its receivable shape.
Row fields: number, date, due_date (order date + payment terms), days_until_due (negative when past due), payment_due_status (overdue, due_soon — due within 7 days, current, or no_due_date), order_status, payment_status, total, total_paid, and balance_due in the order's own currency, balance_due_in_tenant_currency converted to the account's base currency at the order's exchange rate, and currency.
Filtering:
filter[status]—open(default: any order with a balance due),overdue(balance due and past the due date),due_7d(balance due within the next 7 days),paid(settled orders),all.filter[search]— matches the order number.
Sorting: sort accepts due_date (default), -due_date, date, -date.
Pagination: page (default 1) and per_page (default 10, max 100).
Authentication: Requires Bearer token (PAT). Requires permissions customers.show and sales_orders.index, and a token with the orders scope.
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.