Skip to main content
GET
Retrieve a Ledger's balanced status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Headers

teal-instance-id
string
required

The Teal instance ID

Path Parameters

ledger_id
string
required

The ledger ID

Response

Successful Response

balance_check_result
enum<string>
required

Whether the ledger's line entries are balanced. A ledger is considered balanced if it has been balanced within the past week.

Available options:
balanced,
previously_balanced,
unbalanced
last_balanced_at
string<date-time> | null

The datetime in UTC that the ledger was last balanced.