v1

latestOpenAPI 3.1.02026-07-22733584.5 KB
Books

Get the Books or VAT sheet

Returns the spreadsheet-style read model over the canonical general ledger: summary cards, column definitions, and rows for the selected tab and range. Amounts inside rows are integer cents. Paginate with limit/offset (limit 0 = unpaginated, max 200 per page).

get/sheet

Query parameters

tab'books' | 'vat' required

Which sheet to return.

rangestring required

Period selector: YYYY-MM, YYYY-Qn, YYYY, all, this_month, or last_6_months.

customer_idstring

Target company. Optional — API keys are pinned to one company, and single-company sessions default to it.

limitinteger

Rows per page. 0 = unpaginated. Maximum 200.

offsetinteger

Row offset for pagination.

sort'' | 'newest' | 'oldest' | 'amount' | 'category' | 'status'

Row ordering. Empty string = default order.

Response

Sheet payload.

customerobject
active_tab'books' | 'vat'
sheet_statusobject
selected_rangestring
available_rangesobject[]
summary_cardsobject[]
columnsobject[]
rowsobject[]
row_windowobject

Pagination window, present when the response is paginated.

sortstring