The API reference isn't available right now
This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.
Back to the API reference
No such model
This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.
Back to the API reference
This reference may be out of date
This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.
API reference
/
Models
InvoiceAgingReportDtoA model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The result of an accounts-receivable aging report: outstanding balances bucketed
by days past due, grouped by biller or recipient, with per-currency grand totals.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
Field
Type
Description asOfDate
required string (date-time)
The date balances were aged against.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
groupBy
required InvoiceAgingGroupBy
InvoiceAgingGroupBy The dimension the report grouped by.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
RecipientGroup outstanding balances by the recipient being billed (the customer). BillerGroup outstanding balances by the biller issuing the invoices.
groups
required array of InvoiceAgingGroupDto
array of InvoiceAgingGroupDto One row per (group, currency), ordered by group name then currency.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each InvoiceAgingGroupDto:
Field
Type
Description current
required number (double)
Outstanding balance not yet due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days1To30
required number (double)
Outstanding balance 1 to 30 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days31To60
required number (double)
Outstanding balance 31 to 60 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days61To90
required number (double)
Outstanding balance 61 to 90 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days90Plus
required number (double)
Outstanding balance more than 90 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
total
required number (double)
Sum of all buckets: the total outstanding balance.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
groupId
required string (uuid)
The grouped entity's id (recipient id or biller id depending on the report's group-by).
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
groupName
required string
Display name from the invoice party snapshot, or empty when unavailable.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
currency
required string
ISO 4217 currency code these totals are expressed in.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
invoiceCount
required integer (int32)
Number of outstanding invoices in this group.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lines
required array of InvoiceAgingLineDto
array of InvoiceAgingLineDto The individual outstanding invoices making up this group. Populated only when
`includeLineDetail` is requested.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
currencyTotals
required array of InvoiceAgingCurrencyTotalsDto
array of InvoiceAgingCurrencyTotalsDto Grand totals, one entry per currency present in `groups`.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields of each InvoiceAgingCurrencyTotalsDto:
Field
Type
Description current
required number (double)
Outstanding balance not yet due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days1To30
required number (double)
Outstanding balance 1 to 30 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days31To60
required number (double)
Outstanding balance 31 to 60 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days61To90
required number (double)
Outstanding balance 61 to 90 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
days90Plus
required number (double)
Outstanding balance more than 90 days past due.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
total
required number (double)
Sum of all buckets: the total outstanding balance.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
currency
required string
ISO 4217 currency code these totals are expressed in.
nullable Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
invoiceCount
required integer (int32)
Number of outstanding invoices contributing to these totals.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
This body has no documented fields.
This model has no documented fields.
Next steps