iotoms Docs

Get a payment summary for a session

GET
/api/v1/payments/sessions/{sessionType}/{sessionId}/summary

Returns payment totals for a session such as a day cycle, POS shift, e-commerce batch or inventory session (sessionType and sessionId), so cash can be reconciled against operations.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

sessionType*string

Kind of session: DAY_CYCLE, POS_SHIFT, ECOM_BATCH or INVENTORY_SESSION.

Value in"DAY_CYCLE""POS_SHIFT""ECOM_BATCH""INVENTORY_SESSION"
sessionId*string

ID of the session, e.g. a day cycle ID from List day cycles.

Formatuuid

Header Parameters

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?

Payment totals for the session with a row per visit, order or delivery.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/payments/sessions/DAY_CYCLE/497f6eca-6276-4993-bfeb-53cbbbba6f08/summary'
Example Response
{  "status": "string",  "message": "string",  "data": {    "sessionId": "f6567dd8-e069-418e-8893-7d22fcf12459",    "sessionType": "DAY_CYCLE",    "businessDate": "2019-08-24",    "salesExecutiveId": "string",    "totalCollected": 0,    "cashCollected": 0,    "digitalCollected": 0,    "creditIssued": 0,    "contextBreakdown": [      {        "contextType": "STORE_VISIT",        "contextId": "84451116-c600-49e2-9c60-5b6b34fae0d6",        "totalCollected": 0,        "cashCollected": 0,        "digitalCollected": 0,        "creditIssued": 0,        "collectedAt": "2019-08-24T14:15:22Z"      }    ],    "lastUpdatedAt": "2019-08-24T14:15:22Z"  }}