Skip to main content
GET
Get the customer Transactions timeline

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

range
string

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.

version
enum<string>
required

Contract version. Must be 2.

Available options:
2
view
enum<string>
required

One view per request. timeline interleaves newer movements above imported books for mirror service; financial_activity is mirror only.

Available options:
timeline,
books,
financial_activity
filter
enum<string>
default:all

Issue-class slice of the books rows, applied before paging.

Available options:
all,
needs_context,
missing_receipt,
reviewing,
awaiting_payment,
done
limit
integer
default:50

Rows per page. Defaults to 50. Maximum 200.

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

Row offset for pagination.

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

Books-view row ordering. The timeline and financial views are served newest-first only.

Available options:
newest,
oldest,
amount,
category
dimension_axis_id
string

Canonical dimension axis ID. Must be paired with dimension_value_id.

dimension_value_id
string

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

Response

One activity view page with server-owned counts and paging.

One version=2 activity view page. rows carry kind: book_entry (decorated book rows) or kind: financial_movement (signed raw movements outside the imported-books boundary).

version
enum<integer>
required
Available options:
2
view
enum<string>
required
Available options:
timeline,
books,
financial_activity
revision
string
required

Opaque page-coherence token; clients reset to page zero when it changes.

columns
object[]
required
rows
object[]
required
row_window
object
required
coverage
object

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

counts
object

Per-view authority counts. Absent on filtered pages.

sort
string
unavailable_reason
string

Present when the imported-books boundary is not available yet.