iotoms Docs

Get sales by payment method

GET
/api/v1/reports/sales/by-paymode

Returns revenue split by payment method (cash, card and so on). registerId narrows results to one register. from and to are dates (YYYY-MM-DD) and both default to today.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

from?string

Start date, YYYY-MM-DD.

Formatdate
to?string

End date, YYYY-MM-DD.

Formatdate
registerId?integer

Optional — scope results to a single register/terminal (used by the mobile app to show only its own device's sales)

Formatint64

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

message*string

Short human-readable message describing the outcome, for example "Vendor created". Do not parse it.

data?array<>|

One row per payment method used in the range.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/sales/by-paymode' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "paymodeCode": "string",      "paymodeLabel": "string",      "totalAmount": 0,      "transactionCount": 0,      "percentageOfTotal": 0.1    }  ]}