iotoms Docs

Get receivables aging by customer

GET
/api/v1/receivables/aging

Returns each customer's open balance in aging buckets (current, 31–60, 61–90, over 90 days) as of asOf (defaults to today).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

asOf?string

Date to measure ages from (YYYY-MM-DD). Defaults to today; sales after this date are left out.

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 call: SUCCESS when the request was processed; otherwise an error status.

message*string

Short human-readable message describing the outcome, e.g. which record was saved or why the call failed.

data?

Open receivables per customer in aging buckets, with totals.

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