GET
/
v0
/
ledgers
/
{ledger_id}
/
last-balanced
Retrieve a Ledger's balanced status
curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/last-balanced \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'
{
  "balance_check_result": "balanced",
  "last_balanced_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

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.