v1
latestOpenAPI 3.1.02026-07-241910582.8 KBList Ledger Accounts
Query parameters
If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.
If you have specific names to retrieve in bulk, you can pass them as query parameters delimited with name[]=, for example ?name[]=my-account&name[]=your-account. Partial match here is enabled.
For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.
Can be credit or debit to return only Ledger Accounts that were created with the specified default normality.
Use balances[effective_at_lower_bound] to set the lower bound timestamp for which the retrieved balance is set. The returned balance will be inclusive of the provided timestamp.
Use balances[effective_at_upper_bound] to set the upper bound timestamp for which the retrieved balance is set. The returned balance will be exclusive of the provided timestamp. Any balances[as_of_date] or balances[effective_at] will be translated into balances[effective_at_upper_bound].
Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by the balance amount.
Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by balance amount.
Use gt (>), gte (>=), lt (<), lte (<=), eq (=), or not_eq (!=) to filter by balance amount.
Use "gt" (>), "gte" (>=), "'lt" (<), "lte" (<=), or "eq" (=) to filter by the created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z.
Use "gt" (>), "gte" (>=), "'lt" (<), "lte" (<=), or "eq" (=) to filter by the updated at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.
Query for accounts in a ledger account category.
Response
200
Example response
[
{
"id": "690eed62-5b6c-45ee-a474-f54905133866",
"object": "ledger_account",
"name": "Operating Bank Account",
"ledger_id": "fe96565f-4b9c-4871-8fb0-e6f02683458e",
"normal_balance": "debit",
"balances": {
"effective_at_lower_bound": "2020-08-04T16:54:32Z",
"effective_at_upper_bound": "2021-08-04T16:54:32Z",
"pending_balance": {
"currency": "USD",
"currency_exponent": 2
},
"posted_balance": {
"currency": "USD",
"currency_exponent": 2
},
"available_balance": {
"currency": "USD",
"currency_exponent": 2
}
},
"created_at": "2022-11-01T20:57:31Z",
"updated_at": "2022-11-01T20:57:31Z"
}
]