iotoms Docs

Get day cycle details

GET
/api/v1/ops/day-cycles/{dayCycleId}/detail

Returns a detailed view of one day cycle, including vehicle, route visits, coverage and transaction totals.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

dayCycleId*string

ID of the day cycle, from List day cycles or Get the active day cycle.

Formatuuid

Header Parameters

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?

Full detail of the day cycle: vehicle, cash, odometer, store visits and transaction totals.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/day-cycles/497f6eca-6276-4993-bfeb-53cbbbba6f08/detail'
Example Response
{  "status": "string",  "message": "string",  "data": {    "dayCycleId": "bbed7a30-80be-4ccf-810d-a33c370a67d1",    "businessDate": "2019-08-24",    "status": "OPEN",    "salesExecutiveId": "string",    "startedAt": "2019-08-24T14:15:22Z",    "closedAt": "2019-08-24T14:15:22Z",    "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",    "vehicleLabel": "string",    "vehicleType": "VAN",    "startOdometerKm": 0,    "endOdometerKm": 0,    "openingCash": 0,    "closingCash": 0,    "totalStores": 0,    "visitedStores": 0,    "coveragePercent": 0.1,    "storeVisits": [      {        "storeId": "string",        "storeName": "string",        "sequence": 0,        "visitStatus": "PENDING",        "skipReason": "STORE_CLOSED",        "visitedAt": "2019-08-24T14:15:22Z",        "gpsLat": 0,        "gpsLon": 0,        "notes": "string"      }    ],    "totalSales": 0,    "transactionCount": 0,    "cashCollected": 0,    "creditTotal": 0  }}