iotoms Docs

Generate the day-end summary PDF

POST
/api/v1/ops/day-cycles/{dayCycleId}/report

Renders the day-end collection summary PDF for a day cycle using the tenant's active report template, or a specific templateId. An open day cycle produces a provisional snapshot; a closed day cycle's PDF is stored as a final copy.

How to use it

  1. Get the dayCycleId from List day cycles; optionally pick a DAY_END_SUMMARY template ID from List report templates.
  2. Send the request; without templateId the active DAY_END_SUMMARY template is used, and the call fails if none is active.
  3. Download the PDF from pdfUrl; status in the response is PROVISIONAL for an open day and FINAL for a closed one.
  4. The file counts toward the merchant's storage quota; regenerating replaces the stored copy for that day cycle.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

dayCycleId*string

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

Formatuuid

Query Parameters

templateId?integer

Optional ID of a report template to render with instead of the active one; see List report templates. Pick a DAY_END_SUMMARY template: the server does not check the template's document type.

Formatint64

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 POST 'https://beta.iotoms.com/api/v1/ops/day-cycles/497f6eca-6276-4993-bfeb-53cbbbba6f08/report'
Example Response
{  "status": "string",  "message": "string",  "data": {    "property1": {},    "property2": {}  }}