iotoms Docs

List accounting periods

GET
/api/v1/accounting/periods

Returns the merchant's accounting periods with their fiscal year, start and end dates and OPEN or CLOSED status. Entries can only be posted into a date covered by an OPEN period.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Header Parameters

X-TenantID*string

Your merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.

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

The accounting periods, each with its dates and open or closed status.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/accounting/periods' \  -H 'X-TenantID: your-tenant-code'
Example Response
{  "status": "string",  "message": "string",  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "fiscalYear": 0,      "name": "string",      "startDate": "2019-08-24",      "endDate": "2019-08-24",      "status": "OPEN"    }  ]}