Skip to main content
GET
Get the customer-visible general ledger

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

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

scope
enum<string>
default:monthly
Available options:
monthly,
range
period
string

Month or inclusive through-month.

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

General-ledger account balances on the canonical posted-books basis.

The response is of type object.