List all Ledgers

API overview

Teal API Endpoints

Categorization
Chart of Accounts Templates
Instances
Journal Entries
Ledgers
Line Entries
Payables
Platform
Quickbooks
Receivables
Reports
Tags
Transaction Sources
Transactions
Transfers

API Migration

Migration Guides
Deprecated Endpoints

GET

ledgers

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "debit_credit": "debit",
      "editable": false,
      "financial_account_type": "bank_account",
      "id": "7JRNsKwy2Lw66caxVU7WGC",
      "is_required": false,
      "name": "Pluto Checking 4242",
      "report_cash_flow": true,
      "sort_code": "2240",
      "sub_type": "current_assets",
      "type": "asset"
    }
  ]
}

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

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 | null

Response

200

application/json

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

object[]

required

List of ledgers

records.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

records.name

string

required

The name of the ledger. Teal does not enforce any other conventions or patterns on naming schemes; however, we recommend you use concise, descriptive names, especially for financial account ledgers.

Example:

"Pluto Checking 4242"

records.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:

debit,

credit

Example:

"debit"

records.editable

boolean

required

Whether line entries can be manually added or removed from the Ledger. Set to false if you control the source of truth for the Ledger and want to restrict user changes, for example, if the Ledger is for a bank account or a payments account you control (i.e. you are a neobank or using a Banking as a Service platform).

Example:

false

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.

Example:

false

records.parent_id

string | null

required

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

records.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

Required if financial_account_type is not specified.

Example:

false

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.

Teal does not enforce any other conventions or patterns on sort codes. However, it is recommended to adopt a common convention such as starting all ledgers of the same type with the same number (assets start with 1, liabilities start with 2, etc.). The default CoA templates provided by Teal follow best practices for sort code numbering.

Example:

"1400"

records.sub_type

enum<string>

required

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

Required if financial_account_type is not specified.

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

Example:

"current_assets"

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.

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

Example:

"asset"

records.financial_account_type

enum<string> | null

If specified, indicates that the ledger represents a real-world financial account.

If provided when creating a new Ledger object, you do not need to provide debit_credit, type, sub_type, or report_cash_flow values as we will provide default values.

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.

Example:

[
  {
    "debit_credit": "debit",
    "editable": false,
    "financial_account_type": "bank_account",
    "id": "7JRNsKwy2Lw66caxVU7WGC",
    "is_required": false,
    "name": "Pluto Checking 4242",
    "report_cash_flow": true,
    "sort_code": "2240",
    "sub_type": "current_assets",
    "type": "asset"
  }
]

Retrieve a Journal Entry File Create a Ledger

curl --request GET \
  --url https://api.sandbox.teal.dev/v0/ledgers \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "next_page_token": "ikal0NEVfMhF8dJf4yQ6KQZmGD",
  "prev_page_token": "vuA7JeKI5c6FLnPt5JfRcZcJxW",
  "records": [
    {
      "debit_credit": "debit",
      "editable": false,
      "financial_account_type": "bank_account",
      "id": "7JRNsKwy2Lw66caxVU7WGC",
      "is_required": false,
      "name": "Pluto Checking 4242",
      "report_cash_flow": true,
      "sort_code": "2240",
      "sub_type": "current_assets",
      "type": "asset"
    }
  ]
}