Aged receivables
API Documentation / Resources / Reports

Get an aged receivables report
GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/reports/aged-receivables
Required OAuth scope: reports:read
Groups authorised, unvoided customer documents with an open balance by contact and aging bucket.
| Parameter | Meaning | Default |
|---|---|---|
as_at |
Snapshot date, inclusive | Required |
basis |
Age from invoice date or due date | due_date |
contact_id |
Restrict to one customer | All customers |
currency_code |
Restrict document currency | All currencies |
Credits retain their sign. Bucket totals therefore reconcile to each contact's net open balance at the reporting date.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
tenant_id |
path | Yes | string (uuid) | UUID of the authorized company group. |
subsidiary_id |
path | Yes | string (uuid) | UUID of the subsidiary whose ledger is reported. |
as_at |
query | Yes | string (date) | |
basis |
query | No | string: invoice_date, due_date | |
contact_id |
query | No | string (uuid) | |
currency_code |
query | No | string |
Request
GET /v1/tenants/{tenant_id}/subsidiaries/{subsidiary_id}/reports/aged-receivables HTTP/1.1
Host: api.finov.io
Authorization: Bearer {access_token}
Responses
| Status | Description |
|---|---|
200 |
Aged receivables report. |
401 |
Access token is missing, expired, revoked, or invalid. |
403 |
Token lacks reports:read or the granted accounting context. |
404 |
A requested subsidiary, account, contact, or bank account is not available in the grant. |
422 |
One or more report parameters failed validation. |
200 example
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"report": "aged_receivables",
"as_at": "2026-07-31",
"basis": "due_date",
"currency_code": "NZD",
"rows": [
{
"contact_id": "a68d68ec-5866-42e5-8864-57829d3f91b5",
"contact_name": "Koru Office Limited",
"current": "1725.0000",
"days_1_30": "850.0000",
"days_31_60": "0.0000",
"days_61_90": "0.0000",
"days_90_plus": "0.0000",
"total": "2575.0000"
}
],
"total": "2575.0000",
"generated_at": "2026-08-10T17:15:00Z"
}
}