Get cash, receivable and payable balances
GET
Returns cash and bank balances per account plus total receivables and payables as of asOf (defaults to today). Figures come from posted journal entries only.
BearerAuthheader
AuthorizationBearer <JWT>asOf?stringDate to calculate balances up to, inclusive (YYYY-MM-DD). Defaults to today.
Format
dateX-TenantID*stringYour merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.
OK
*/*- response
status*stringOutcome of the call: SUCCESS when the request worked, ERROR when it did not.
message*stringShort human-readable message describing the result, for logs or display; do not parse it.
data?Cash and bank balances per account plus customer (receivable) and supplier (payable) totals as of the requested date.
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/accounting/dashboard/balances' \ -H 'X-TenantID: your-tenant-code'Example Response
{ "status": "string", "message": "string", "data": { "asOf": "2019-08-24", "currency": "string", "mixedCurrency": true, "cashAndBank": { "totalMinor": 0, "accountCount": 0, "accounts": [ { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "code": "string", "name": "string", "currency": "string", "active": true, "balanceMinor": 0 } ] }, "customerBalance": { "totalMinor": 0, "accountCount": 0, "accounts": [ { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "code": "string", "name": "string", "currency": "string", "active": true, "balanceMinor": 0 } ] }, "supplierBalance": { "totalMinor": 0, "accountCount": 0, "accounts": [ { "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "code": "string", "name": "string", "currency": "string", "active": true, "balanceMinor": 0 } ] } }}