Get Payables Aging Report
GET/api/purchase-invoices/aging-report
Supplier payables aging report over outstanding (unpaid and partially paid) purchase invoices and, optionally, bills.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Records are bucketed by days past the selected age-by date: current (not yet past, or no date), 1-30, 31-60, 61-90, and 90+ days. Amounts are converted to the tenant currency using each record's exchange-rate snapshot. The summary block reports total outstanding, total overdue (past due date), and the amount due within the next 7 days. Rows are grouped by supplier, sorted by total outstanding descending, and each row includes the individual invoice/bill records that make up its buckets.
Purchase invoices with no due date and no payment schedule, on a purchase order that is no longer open, are not listed individually in items. Their outstanding amounts still count in every bucket and total, and each supplier row reports them as undated_invoice_count / undated_invoice_amount. The summary carries the same two fields for the whole report.
Request
Responses
- 200
- 401
- 403
- 429
OK
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.