Retrieve a ledger statement

GET

reports

ledger-statement

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

ledger_id

string

required

The ledger ID

start_date

string

required

Only include data after the start date (inclusive).

end_date

string

required

Only include data before the end date (inclusive).

limit

integer | null

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

page_token

string

tag_ids

string

Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription

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

ledger_statement

object

required

The Ledger Statement object.

ledger_statement.ledger_id

string

required

The unique ID of the object.

ledger_statement.name

string

required

The name of the ledger.

ledger_statement.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

ledger_statement.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

ledger_statement.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

ledger_statement.amount

number

required

The sum, in decimal dollar cents, of all line entries in the ledger.

ledger_statement.opening_balance

number

required

The balance, in decimal dollar cents, of the ledger at the start date.

ledger_statement.closing_balance

number

required

The balance, in decimal dollar cents, of the ledger at the end date.

ledger_statement.lines

object[]

required

A list all Line Entries in the Ledger.

ledger_statement.lines.amount

number

required

The value of the line entry in decimal dollar cents.

ledger_statement.lines.debit_credit

enum<string>

required

Indicates if the amount is a credit or debit.

Available options:

debit,

credit

ledger_statement.lines.description

string | null

An arbitrary string on the object, useful for displaying to the user or for categorization.

ledger_statement.lines.ledger_id

string

required

The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.

ledger_statement.lines.related_line_entry_id

string | null

If the Line Entry is identified as a transfer between accounts, the ID of the Line Entry in the opposing Ledger.

Related guide: Auto-categorization

ledger_statement.lines.transaction_id

string | null

The ID of the associated Transaction, if one exists.

ledger_statement.lines.id

string | null

required

The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.

ledger_statement.lines.datetime

string

required

The datetime the Line Entry was created in UTC time.

ledger_statement.lines.editable

boolean

required

Indicates if the Line Entry can be manually added or removed from a Ledger, as dictated by the editable property on the Ledger.

ledger_statement.lines.journal_entry

null

Expandable. The associated Journal Entry object.

ledger_statement.lines.journal_entry_id

string | null

required

The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.

ledger_statement.lines.journal_entry_description

string

required

An arbitrary string on the object, useful for displaying to users.

ledger_statement.lines.ledger

null

Expandable. The associated Ledger object.

ledger_statement.lines.ledger_name

string

required

The name of the Line Entry's Ledger.

ledger_statement.lines.tags

object[] | null

A list of all the Tags associated with the Line Entry, if any.

ledger_statement.lines.transaction

null

Expandable. The associated Transaction object, if one exists.

ledger_statement.start_date

string

required

The start date of the report (inclusive). Must be in YYYY-MM-DD format.

ledger_statement.end_date

string

required

The end date of the report (inclusive). Must be in YYYY-MM-DD format.

Retrieve the Balance Sheet Retrieve the Cash Flow Report

API overview

Teal API Endpoints

API Migration

Retrieve a ledger statement

Authorizations

Headers

Query Parameters

Response