iotoms Docs

Get daily cash report

GET
/api/v1/reports/financial/daily-cash

Returns one cash reconciliation row per day cycle whose business date is between from and to (YYYY-MM-DD, both default to today): opening cash, cash collected, cash expenses, expected and actual closing cash, and the variance (MATCHED, OVER or SHORT). from after to is rejected.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

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

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

One cash reconciliation row per day cycle whose business date falls in the range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/financial/daily-cash' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",      "businessDate": "2019-08-24",      "salesExecutiveName": "string",      "openingCash": 0,      "cashSalesCollected": 0,      "expensesCashPaid": 0,      "expectedClosingCash": 0,      "actualClosingCash": 0,      "variance": 0,      "varianceStatus": "string"    }  ]}