iotoms Docs

Get a customer's outstanding balance

GET
/api/v1/receivables/outstanding/{customerNumber}

Returns a customer's open credit sales (credit given minus receipts applied, oldest first), any on-account credit from unapplied receipts, and the net balance they owe today.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

customerNumber*string

Customer number to get the balance for, from List customers.

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?

The customer's open credit sales, on-account credit and net balance.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/receivables/outstanding/string' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": {    "customerNumber": "string",    "outstanding": 0,    "onAccount": 0,    "netOutstanding": 0,    "openSales": [      {        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",        "invoiceNumber": "string",        "businessDate": "2019-08-24",        "grandTotal": 0,        "creditIssued": 0,        "settled": 0,        "openBalance": 0,        "ageDays": 0      }    ]  }}