Ledgers
Get Ledgers
Return all ledgers for an instance.
GET
/
v0
/
ledgers
Authorization
Header
Query
curl --request GET \
--url https://api.sandbox.teal.dev/v0/ledgers \
--header 'Authorization: <authorization>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"debit_credit": "debit",
"editable": true,
"financial_account_type": "bank_account",
"id": "7JRNsKwy2Lw66caxVU7WGC",
"is_required": true,
"name": "Accounts Receivable",
"parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
"report_cash_flow": true,
"sort_code": "2003",
"sub_type": "current_assets",
"type": "asset"
}
]
}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Headers
teal-instance-id
string
requiredThe Teal instance ID
Query Parameters
limit
integer | null
The number of records to return. Max limit is 100.
page_token
string
Response
200 - application/json
next_page_token
string | null
requiredThe token to use to request the next page
prev_page_token
string | null
requiredThe token to use to request the previous page
records
object[]
requiredList of ledgers
curl --request GET \
--url https://api.sandbox.teal.dev/v0/ledgers \
--header 'Authorization: <authorization>' \
--header 'teal-instance-id: <teal-instance-id>'
{
"next_page_token": "<string>",
"prev_page_token": "<string>",
"records": [
{
"debit_credit": "debit",
"editable": true,
"financial_account_type": "bank_account",
"id": "7JRNsKwy2Lw66caxVU7WGC",
"is_required": true,
"name": "Accounts Receivable",
"parent_id": "HLn8oy2eqMUCwjp1Cwdgco",
"report_cash_flow": true,
"sort_code": "2003",
"sub_type": "current_assets",
"type": "asset"
}
]
}