# GET /api/invoicing/reports/aging

Reports: Retrieves the accounts-receivable aging report.

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.

**Operation ID:** `invoiceAgingReportGet`

## Authorization

Requires: Invoicing.Reports, merchant scope.

Required permissions:
- `Invoicing.Reports`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| AsOfDate | query | no | 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 | query | no | string(uuid) | Restrict to a single biller. |
| BillerType | query | no | InvoicePartyType | Restrict to a single biller type. |
| RecipientId | query | no | string(uuid) | Restrict to a single recipient. |
| Currency | query | no | string | Restrict to a single ISO 4217 currency code. |
| GroupBy | query | no | InvoiceAgingGroupBy | Dimension to group outstanding balances by. Defaults to recipient. |
| IncludeLineDetail | query | no | 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 | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

The aging report.

**Content type:** `application/json`

Schema: `InvoiceAgingReportDto`

Properties:
- `asOfDate` (string(date-time)): The date balances were aged against.
- `groupBy` (object): The dimension the report grouped by.
- `groups` (array<InvoiceAgingGroupDto>): One row per (group, currency), ordered by group name then currency.
- `currencyTotals` (array<InvoiceAgingCurrencyTotalsDto>): Grand totals, one entry per currency present in `groups`.

### 400

The receivable set exceeds the report row ceiling
(`Invoicing:Report:RowLimitExceeded`). Narrow by biller, recipient, or currency and retry.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: 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. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: 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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: 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.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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.

### cURL

```bash
curl -X GET "{{BASE_URL}}/api/invoicing/reports/aging" \
  -H "api-key: {{API_KEY}}"
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/reports/aging' `
    -Headers $headers
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceAgingReportGet();
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/reports/aging', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var result = await api.InvoiceAgingReportGetAsync();
```

### C# (raw HTTP)

```csharp
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/invoicing/reports/aging");
request.Headers.Add("api-key", "{{API_KEY}}");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    result = api.invoice_aging_report_get()
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/invoicing/reports/aging",
    headers=headers,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.