BoringBooks API reference

close_period

POST /api/v1/commands/close_period

Base URL: https://boringbooks.io.

Request body

FieldTypeRequiredDescription
ledger_idstring (uuid)yes
period_idstring (uuid)yes
retained_earnings_account_idstring (uuid)yes

Example:

{
  "ledger_id": "11111111-1111-4111-8111-111111111111",
  "period_id": "55555555-5555-4555-8555-555555555555",
  "retained_earnings_account_id": "88888888-8888-4888-8888-888888888888"
}

Response (200)

FieldTypeRequiredDescription
statusstringyes
journal_idstring (uuid), nullableno

Errors

Every error response is a single error object with a closed type and a refining code. The codes, and the conventions every operation shares, are in llms-full.txt.