Skip to main content
GET
Get Balances

Authorizations

Authorization
string
header
required

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

companyId
string<uuid>
required

Company identifier

Response

Per-category balances plus the cash account

asOfDate
string<date>
required

The date the balances are summed as of (today)

categories
object[]
required

One entry per transaction category (deprecated categories included — they may still carry balances)

cash
object | null
required

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.