iotoms Docs

Close an accounting period

POST
/api/v1/accounting/periods/{id}/close

Closes a period so no further entries dated in it can be posted. Idempotent: closing a closed period changes nothing.

How to use it

  1. Find the period ID with List accounting periods.
  2. The period becomes CLOSED: posting a journal entry dated in it is refused and automatic postings for that date go to the failed postings queue.
  3. Use Reopen an accounting period to allow postings again.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*string

ID of the record (UUID).

Formatuuid

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?

The accounting period after the change.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/accounting/periods/497f6eca-6276-4993-bfeb-53cbbbba6f08/close' \  -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"  }}