iotoms Docs

Get the receivables aging report

GET
/api/v1/reports/customer/ar-aging

Returns each customer's open balance split into aging buckets as of asOf (defaults to today). to is accepted as a legacy alias for asOf.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

asOf?string

Aging as-of date (YYYY-MM-DD), defaults to today

Formatdate
to?string

Deprecated alias for asOf — honored only when asOf is absent, so the legacy from/to date-range picker stops being a silent no-op (RPT-D006)

Formatdate

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?array<>|

One row per customer with an open balance, largest total first.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/customer/ar-aging' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "customerNumber": "string",      "customerName": "string",      "current": 0,      "days30": 0,      "days60": 0,      "days90Plus": 0,      "total": 0    }  ]}