Reports: Retrieves the accounts-receivable aging report.
GET
/api/invoicing/reports/aging
deprecated
Requires: Invoicing.Reports, merchant scope.
Buckets each outstanding balance by days past due as of the requested date (current UTC when omitted), grouped by biller or recipient, with per-currency grand totals. Balances are never summed across currencies: a party holding balances in two currencies yields two group rows. The report covers at most 50,000 outstanding invoices; a wider receivable set is rejected so a partial total is never mistaken for a complete one. Narrow by biller, recipient, or currency.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
AsOfDate
required |
query | string (date-time) | The date the report ages outstanding balances against. When null the application service uses the current UTC date. Buckets are computed as the number of days each invoice's due date precedes this date. |
BillerId
required |
query | string (uuid) | Restrict to a single biller. |
BillerType
required |
query | InvoicePartyType | Restrict to a single biller type. |
RecipientId
required |
query | string (uuid) | Restrict to a single recipient. |
Currency
required |
query | string | Restrict to a single ISO 4217 currency code. |
GroupBy
required |
query | InvoiceAgingGroupBy | Dimension to group outstanding balances by. Defaults to recipient. |
IncludeLineDetail
required |
query | boolean | When true, each group also carries the individual outstanding invoices that make it up (number, due date, days past due, bucket, balance). When false, only the bucketed totals are returned. |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 The aging report.
Body: InvoiceAgingReportDto
Each item has these fields.
| Field | Type | Description |
|---|---|---|
asOfDate
required |
string (date-time) | The date balances were aged against. |
groupBy
required |
all of InvoiceAgingGroupBy | The dimension the report grouped by. |
groups
required |
array of InvoiceAgingGroupDto | One row per (group, currency), ordered by group name then currency. nullable |
currencyTotals
required |
array of InvoiceAgingCurrencyTotalsDto | Grand totals, one entry per currency present in `groups`. nullable |
This response has no documented body fields.
400 The receivable set exceeds the report row ceiling (`Invoicing:Report:RowLimitExceeded`). Narrow by biller, recipient, or currency and retry.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
404 The caller's biller scope does not cover the requested biller (`Invoicing:Biller:ForeignBillerNotAllowed`). Reported as not-found rather than forbidden so the response cannot be used to probe which billers exist.
Body:
Each item has these fields.
| Field | Type | Description |
|---|
This response has no body.
403 Forbidden
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
401 Unauthorized
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
501 Not Implemented
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
500 Internal Server Error
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
Body: RemoteServiceErrorResponse
Each item has these fields.
| Field | Type | Description |
|---|---|---|
error
required |
RemoteServiceErrorInfo |
This response has no documented body fields.
429 The request was refused because a rate limit was exceeded. Wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling.
Body: RateLimitProblemDetails
Each item has these fields.
| Field | Type | Description |
|---|---|---|
type
required |
string | The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. nullable |
title
required |
string | A short, human-readable summary of the problem type. nullable |
status
required |
integer (int32) | The HTTP status code, repeated in the body as the problem-details format defines. |
detail
required |
string | A human-readable explanation of this occurrence of the problem. nullable |
retryAfterSeconds
required |
integer (int32) | How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. |
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.