iotoms Docs

Get outstanding collections

GET
/api/v1/reports/financial/outstanding

Intended to list unpaid invoices and outstanding collections as of asOfDate (defaults to today). It currently always returns a zero total and an empty list.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

asOfDate?string

ISO date (YYYY-MM-DD), defaults to today

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 worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

Outstanding collections as of the requested date. Currently always a zero total and an empty list.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/financial/outstanding' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "asOfDate": "2019-08-24",    "totalOutstanding": 0,    "entries": [      {        "invoiceNumber": "string",        "customerId": "string",        "customerName": "string",        "invoiceDate": "2019-08-24",        "dueDate": "2019-08-24",        "amountDue": 0,        "daysPastDue": 0,        "agingBucket": "string"      }    ]  }}