Sign in

v1

latestOpenAPI 3.1.02026-07-22733584.5 KB
Books

Get the customer Transactions timeline

Returns the portal presentation over imported book rows and, for mirror service, authority-covered financial-account observations outside the current footed import. This is an orientation view, not a general-ledger API: observations do not enter GL, VAT, Home metrics, Analytics, close, or filing figures. Use /sheet?tab=books or MCP get_books for canonical accounting rows.

get/activity

Query parameters

rangestring

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.

filter'all' | 'new' | 'imported'

Customer presentation slice.

limitinteger

Rows per page. Defaults to 50. Maximum 200.

offsetinteger

Row offset for pagination.

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

Row ordering. Category sorts the visible Account; status sorts Accounting state.

dimension_axis_idstring

Canonical dimension axis ID. Must be paired with dimension_value_id.

dimension_value_idstring

Canonical value ID, or __unallocated__. Must be paired with dimension_axis_id.

Response

Portal-only activity presentation with server-owned counts and paging.

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
coverageobject

Provider-neutral authority, book-boundary, source, account, and freshness facts.