Reports: Exports the accounts-receivable aging report as CSV.
GET
/api/invoicing/reports/aging/export/csv
deprecated
Requires: Invoicing.Reports, Invoicing.Reports.Export, merchant scope.
Returns a downloadable UTF-8 .csv file: the aging summary, or the per-invoice detail rows when the detail flag is set. Filters, currency handling, and the 50,000-invoice ceiling match the report endpoint. Requires the report export permission in addition to the report permission.
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 | WinkPGInvoicingInvoicePartyType | 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 | WinkPGInvoicingInvoiceAgingGroupBy | 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 exported CSV.
| Field | Type | Description |
|---|
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
403 The caller lacks the report export permission.
| Field | Type | Description |
|---|
This response has no documented body fields.
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.
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
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.
| Field | Type | Description |
|---|
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.