RIrillet
Books periods

Closes a book period

Changed on

Select the period by UUID or accounting month (YYYY-MM, for example 2026-09). Closes every open accounting period through book_close_period_id, oldest first, and locks each period's subledgers, with the same rules as closing books in the app. closed_on is the current date in the organization's time zone. Periods that commit stay closed when a later period is blocked. A period that is already closed returns 200 unchanged. Recent journal-entry conversion inconsistencies return 428 and cannot be overridden through the API; resolve them or wait for conversion to finish, then retry.

post/books/periods/{book_close_period_id}/close

Request

Path parameters

book_close_period_idstring required
Example:2026-09

UUID or accounting month (YYYY-MM) of the period to close through.

Response

The requested period.

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