Skip to main content
GET
Get the rolled-up balance for an account category

Authorizations

Authorization
string
header
required

OAuth 2.0 client_credentials grant. Send client_id:client_secret as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for one hour (configurable). Decode them at jwt.io.

Path Parameters

id
string
required

Response

Rolled-up category balance

object
enum<string>
required

Discriminator naming the shape of this resource (e.g. account, transaction).

Available options:
balance
Example:

"account"

account
string
required
Example:

"accounts_receivable:acme"

currency
string
required
Example:

"USDC"

posted
string
required

Signed minor units from confirmed postings, as a decimal string. Parse with a big-integer or decimal type, never a JS number.

Pattern: ^-?\d+$
Example:

"9700000"

pending
string
required

Signed minor units from pending: true postings, as a decimal string. Parse with a big-integer or decimal type, never a JS number.

Pattern: ^-?\d+$
Example:

"0"

available
string
required

posted + pending, as a decimal string. Parse with a big-integer or decimal type, never a JS number.

Pattern: ^-?\d+$
Example:

"9700000"