BoringBooks API reference

period_status

POST /api/v1/queries/period_status

Base URL: https://boringbooks.io.

Request body

FieldTypeRequiredDescription
ledger_idstring (uuid)yes

Example:

{
  "ledger_id": "11111111-1111-4111-8111-111111111111"
}

Response (200)

FieldTypeRequiredDescription
periodsarray of objectyes
periods[].end_datestring (date)yes
periods[].idstring (uuid)yes
periods[].start_datestring (date)yes
periods[].statusstringyes

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.