Skip to main content
GET
Get the monthly, custom-range, or all-time general-ledger view

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

customer_id
string
scope
enum<string>
default:monthly

Defaults to monthly. range requires period and from_period; all_time accepts neither.

Available options:
monthly,
range,
all_time
period
string

Month for monthly scope or inclusive through-month for range scope.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
from_period
string

Inclusive first month for range scope.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$

Response

The GL view. scope echoes the served range. In all_time, [movement_period_from, period] is the inclusive accounting-period range behind debit and credit: movement_period_from is the active opening-snapshot boundary, or period_bounds.first when there is no snapshot. Range responses echo their effective start. Monthly responses omit movement_period_from.

The response is of type object.