ledgers
POST /api/v1/queries/ledgers
Base URL: https://boringbooks.io.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
cursor | string, nullable | no | |
limit | integer | no | Min: 1. Max: 200. |
Example:
{}
Response (200)
| Field | Type | Required | Description |
|---|---|---|---|
has_more | boolean | yes | |
ledgers | array of object | yes | |
ledgers[].currency | Currency | yes | |
ledgers[].entity | object | yes | |
ledgers[].entity.id | string (uuid) | yes | |
ledgers[].entity.name | string | yes | |
ledgers[].id | string (uuid) | yes | |
ledgers[].name | string | yes | |
next_cursor | string, nullable | yes | |
total_count | integer | yes | |
total_count_exact | boolean | yes |
Shared types
Fields typed with one of these names refer to it.
Currency(string): An ISO 4217 alphabetic currency code — a ledger's own functional currency. The supported set is additive, so do not treat it as closed.
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.