RIrillet
Books periods

Retrieves a book period by date

Changed on

Returns the accounting period containing the requested date, regardless of whether the period is open or closed. Use the returned id to open or close the books or a specific subledger. Responds with HTTP 404 when no period contains the date.

get/books/periods/{date}

Request

Path parameters

datestring date required

Date within the requested accounting period.

Response

OK

idstring uuid required
startstring date required

Book period start date (inclusive)

endstring date required

Book period end date (inclusive)

status'OPEN' | 'CLOSED' required
closed_onstring date nullable required

Date on which book was closed. Always null for open periods, and may also be null for closed periods without a recorded close date, so use status to tell whether the period is closed.

Example response

{
  "start": "2025-06-01",
  "end": "2025-06-30",
  "status": "CLOSED",
  "closed_on": "2025-07-05"
}

Changes