iotoms Docs

Get the route settlement PDF

GET
/api/v1/ops/day-cycles/{dayCycleId}/route-settlement

Returns a link to the route settlement PDF for a day cycle, along with the report data. A cached copy is reused when the day is closed and the active template has not changed; otherwise the PDF is regenerated.

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?|

Key-value result. For PDF endpoints: pdfUrl (a temporary signed download link), templateId, templateVersion, generatedAt plus document keys such as dayCycleId.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/ops/day-cycles/497f6eca-6276-4993-bfeb-53cbbbba6f08/route-settlement'
Example Response
{  "status": "string",  "message": "string",  "data": {    "property1": {},    "property2": {}  }}