iotoms Docs

Get inventory balance on a past date

GET
/api/v1/reports/inventory/historical-balance

Reconstructs quantity on hand per item as of the end of the required asOfDate (YYYY-MM-DD), by summing all recorded stock movements up to that day.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

asOfDate*string

ISO date (YYYY-MM-DD)

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?array<>|

Quantity on hand per item as of the end of the requested date.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/inventory/historical-balance?asOfDate=2019-08-24' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "asOfDate": "2019-08-24",      "itemId": "string",      "itemName": "string",      "quantityOnHand": 0    }  ]}