Skip to main content
GET
Get the Books or VAT sheet

Authorizations

Authorization
string
header
required

Portal API key minted in portal Settings → API access. Scope read or write; pinned to one company. Send as Authorization: Bearer lac_sk_....

Query Parameters

tab
enum<string>
required

Which sheet to return.

Available options:
books,
vat
range
string
required

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

customer_id
string

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

limit
integer

Rows per page. 0 = unpaginated. Maximum 200.

Required range: 0 <= x <= 200
offset
integer

Row offset for pagination.

Required range: x >= 0
sort
enum<string>

Row ordering. Empty string = default order.

Available options:
,
newest,
oldest,
amount,
category,
status

Response

Sheet payload.

Spreadsheet-style read model over the general ledger. Row and card interiors are rendered structures and returned as-is; amounts inside are integer cents.

customer
object
active_tab
enum<string>
Available options:
books,
vat
sheet_status
object
selected_range
string
available_ranges
object[]
summary_cards
object[]
columns
object[]
rows
object[]
row_window
object

Pagination window, present when the response is paginated.

sort
string