Get Balances
Returns the company’s financial balances as of today (asOfDate is
echoed): per-category rollups (reserves / owed / paid / expected total)
with per-account detail, account metadata embedded, and the one
category-less cash account top-level. Every posting account of the
chart appears, zero-filled, so the response is self-describing.
Amounts are raw signed integer cents in the ledger convention — the API
never display-orients; each account carries its role and provenance
direction (and each category its expectedDirection), and the carrying
side derives from role × direction, so clients orient displays
themselves.
Required permission: company.payment:read
Authorizations
API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.
Path Parameters
Company identifier
Response
Per-category balances plus the cash account
The date the balances are summed as of (today)
One entry per transaction category (deprecated categories included — they may still carry balances)
The one category-less cash account's balance with its metadata embedded, or null when there is nothing to show (no cash account on the global read; a zero cash balance on the entity read). amountCents is the raw signed balance in the ledger convention; cash sits in Assets (carries debit) and is the one account whose direction is null.
