GET
/
v0
/
ledgers

Authorizations

Authorization
string
headerrequired

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

Headers

teal-instance-id
string
required

The Teal instance ID

Query Parameters

type
enum<string> | null

Optional ledger type used for filtering.

Available options:
asset,
liability,
equity,
revenue,
expense
sub_type
enum<string> | null

Optional ledger sub type used for filtering.

Available options:
current_assets,
non-current_assets,
transfers_between_accounts,
uncategorized_assets,
current_liabilities,
non-current_liabilities,
equity,
operating_revenues,
other_income,
cost_of_goods_sold,
operating_expenses,
other_expenses
financial_account_type
enum<string> | null

Optional financial account type used for filtering.

Available options:
bank_account,
credit_card,
payments,
payroll,
loan,
prepaid_card,
accounts_receivable,
accounts_payable
debit_credit
enum<string> | null

Optional ledger debit/credit used for filtering.

Available options:
debit,
credit
sort
enum<string>[] | null

A comma separated list of sort orders for the results.

Available options:
name,
-name,
type,
-type,
sub_type,
-sub_type,
debit_credit,
-debit_credit
expand
enum<string>[] | null

Comma-separated list of Ledger expand paths.

Available options:
parent,
parent.parent
limit
integer | null
default: 50

The number of records to return. Max limit is 100.

Required range: 1 < x < 101
page_token
string

Response

200 - application/json
next_page_token
string | null
required

The token to use to request the next page

prev_page_token
string | null
required

The token to use to request the previous page

records
object[]
required

List of ledgers

Retrieve a Journal Entry FileCreate a Ledger