List all Ledgers

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 The Teal instance ID

Query Parameters

type

enum<string> | null

Optional ledger type used for filtering. 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. 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. 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. 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. 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. Comma-separated list of Ledger expand paths.

Available options:

parent,

parent.parent,

details

limit

integer | null

default:50

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

Required range: 1 <= x < 1001

page_token

string | null

Response

Successful Response

next_page_token

string | null

required

The token to use to request the next page

Example:

"ikal0NEVfMhF8dJf4yQ6KQZmGD"

prev_page_token

string | null

required

The token to use to request the previous page

Example:

"vuA7JeKI5c6FLnPt5JfRcZcJxW"

records

Ledger · object[]

required

List of ledgers

Show child attributes

records.id

string

required

The unique ID of the object.

records.name

string

required

The name of the ledger.

records.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Available options:

debit,

credit

records.editable

boolean

required

Whether line entries can be manually added or removed from the ledger.

records.is_required

boolean

required

Indicates that the ledger is one of the four system ledgers required for Teal to work. In the default chart of accounts, these are named one of: Transfers Between Accounts, Opening Balance Retained Earnings, Uncategorized Cash Inflow, Uncategorized Cash Outflow. You can update the names of these to fit your needs.

records.parent_id

string | null

required

If the ledger is a child Ledger, the ID of the parent ledger object.

Example:

null

records.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

records.sort_code

string

required

Determines the display order in reports, ordered digit by digit, starting from the leftmost position. For example, 20010 will come before 3050.

records.sub_type

enum<string>

required

Indicates similar characteristics and accounting treatment for a group of ledgers within a type.

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

records.type

enum<string>

required

Indicates the purpose and location of the funds and value recorded in the ledger and which report it is included in: asset, liability and equity ledgers are displayed on the balance sheet; revenue and expenses are displayed on the income statement.

Available options:

asset,

liability,

equity,

revenue,

expense

records.created_at

string<date-time>

required

The datetime when the ledger was created.

records.financial_account_type

enum<string> | null

Indicates that the ledger represents a real-world financial account.

Available options:

bank_account,

credit_card,

payments,

payroll,

loan,

prepaid_card,

accounts_receivable,

accounts_payable

Example:

"bank_account"

records.parent

any | null

Expandable. If the ledger is a child ledger, the parent ledger object.

API overview

Teal API Endpoints

API Migration

List all Ledgers

Authorizations

Headers

Query Parameters

Response