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.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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.

cURL PowerShell TypeScript C# Python

cURL

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

PowerShell

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

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

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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()

pip install requests

Python (raw HTTP)

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()

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.