Skip to main content
GET
/
accounts
/
{account_code}
/
balance
General-ledger account balance
curl --request GET \
  --url https://ledger.clarivo.co/v1/accounts/{account_code}/balance \
  --header 'Authorization: Bearer <token>'
{
  "account_code": "<string>",
  "currency": "<string>",
  "layer": "SETTLED",
  "as_of_date": "2023-12-25",
  "dr_balance_minor": "<string>",
  "cr_balance_minor": "<string>",
  "normal_balance_minor": "<string>",
  "account_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarivo.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 JWT bearer tokens. Tokens are validated at API Gateway via a Lambda Authorizer that verifies signature against the issuer's JWKS, checks iss, aud, exp, nbf, and the tenant_id custom claim. Granular scopes are required per operation.

Path Parameters

​
account_code
string
required

Four-digit GL account code (e.g. 1100 for Principal Receivable)

Pattern: ^[0-9]{4}$

Query Parameters

​
currency
string
required

ISO 4217 three-letter currency code.

Required string length: 3
Pattern: ^[A-Z]{3}$
Examples:

"USD"

"MXN"

"EUR"

​
layer
enum<string>
default:SETTLED
Available options:
SETTLED,
PENDING,
ENCUMBRANCE
​
as_of_date
string<date>

Point-in-time balance; defaults to now.

Response

Account balance

​
account_code
string
required

Four-digit GL account code.

Pattern: ^[0-9]{4}$
Examples:

"1000"

"1100"

"1200"

​
currency
string
required

ISO 4217 three-letter currency code.

Required string length: 3
Pattern: ^[A-Z]{3}$
Examples:

"USD"

"MXN"

"EUR"

​
layer
enum<string>
default:SETTLED
required
Available options:
SETTLED,
PENDING,
ENCUMBRANCE
​
as_of_date
string<date>
required
​
dr_balance_minor
string
required

Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
cr_balance_minor
string
required

Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
normal_balance_minor
string
required

Non-negative integer amount in the currency's minor unit, serialized as a string to preserve precision (JS numbers cannot safely represent values above 2^53). BIGINT on the wire, BIGINT in the database.

Required string length: 1 - 19
Pattern: ^(0|[1-9][0-9]{0,18})$
Examples:

"88849"

"10000000"

​
account_name
string