iotoms Docs

List report templates

GET
/api/v1/reports/templates

Returns every template version for one document type, reportType (for example PURCHASE_ORDER, SALES_INVOICE, DELIVERY_NOTE, CREDIT_NOTE).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

reportType*string

Document type, required: PURCHASE_ORDER, SALES_INVOICE, DAY_END_SUMMARY, ROUTE_SETTLEMENT, DELIVERY_NOTE, CREDIT_NOTE or SALES_QUOTATION.

Value in"PURCHASE_ORDER""SALES_INVOICE""DAY_END_SUMMARY""ROUTE_SETTLEMENT""DELIVERY_NOTE""CREDIT_NOTE""SALES_QUOTATION"

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

Every template version for the requested document type.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/reports/templates?reportType=PURCHASE_ORDER'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": 0,      "reportType": "PURCHASE_ORDER",      "name": "string",      "layoutJson": "string",      "version": 0,      "isActive": true,      "isSystem": true,      "createdBy": "string",      "createdTime": "2019-08-24T14:15:22Z",      "modifiedTime": "2019-08-24T14:15:22Z",      "system": true,      "active": true    }  ]}