A period of the ledger
Entries for a period, with the balances that bracket it — AC1. `start` is inclusive and `end` exclusive, so consecutive months tile: no entry lands in two statements or in neither. The opening and closing balances describe the whole period however many pages it is read in — a page-local pair would be a different number wearing the same name.
Entries for a period, with the balances that bracket it — AC1.
start is inclusive and end exclusive, so consecutive months tile: no
entry lands in two statements or in neither. The opening and closing
balances describe the whole period however many pages it is read in — a
page-local pair would be a different number wearing the same name.
Authorization
OAuth2PasswordBearer In: header
Query Parameters
3 <= length <= 3The previous page's next_cursor.
1 <= value <= 500100Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/api/b/v1/statements?currency=str"{ "currency": "string", "period_start": "2019-08-24T14:15:22Z", "period_end": "2019-08-24T14:15:22Z", "opening_minor": 0, "closing_minor": 0, "total_credits_minor": 0, "total_debits_minor": 0, "reconciles": true, "entries": [ { "sequence": 0, "entry_type": "string", "amount_minor": 0, "balance_after_minor": 0, "currency": "string", "reference_type": "string", "category": "string", "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482", "created_at": "2019-08-24T14:15:22Z" } ], "next_cursor": 0}Get a bill payment GET
Previous Page
Render a period to a file POST
Queue a statement export — AC2. Always 202, never the file: a year of a busy corridor is hundreds of thousands of lines and rendering it inside the request is a gateway timeout for the caller and a held cursor for us. The `export.ready` webhook arrives when it is done, or poll this job. Asking twice for the same period returns the same job, so a dashboard that polls by re-POSTing costs one render rather than one per poll.