- Guides
- API Reference
- Changelog
- Categorization
- Chart of Accounts Templates
- Instances
- Journal Entries
- Ledgers
- Line Entries
- Payables
- Platform
- Quickbooks
- Receivables
- Reports
- GETRetrieve the Income Statement
- GETRetrieve the Balance Sheet
- GETRetrieve a ledger statement
- GETRetrieve the Cash Flow Report
- GETList cash flow totals by period
- GETList cash flow totals by ledger
- GETList top expenses
- GETList net profit by period
- GETList gross profit by period
- GETList financial summaries by period
- GETRetrieve the General Ledger Report
- GET
- Tags
- Transaction Sources
- Transactions
- Transfers
- Migration Guides
- Deprecated Endpoints
Teal API Endpoints
API Migration
Retrieve the General Ledger Report
Retrieves a list of ledger statements for all ledgers and sub-ledgers in the chart of accounts within the period. Instances with a large chart of accounts or many transactions may encounter slower processing times.
The access token received from the authorization server in the OAuth 2.0 flow.
The Teal instance ID
Only include data after the start date (inclusive).
Only include data before the end date (inclusive).
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The Teal instance ID
Query Parameters
Only include data after the start date (inclusive).
Only include data before the end date (inclusive).
Response
The start date of the report (inclusive). Must be in YYYY-MM-DD format.
The end date of the report (inclusive). Must be in YYYY-MM-DD format.
A list of all Ledger Statement objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
debit, credit An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.
The unique ID of the object.
The name of the ledger.
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.
asset, liability, equity, revenue, expense Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
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 Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The sum, in decimal dollar cents, of all line entries in the ledger.
The balance, in decimal dollar cents, of the ledger at the start date.
The balance, in decimal dollar cents, of the ledger at the end date.
A list all Line Entries in the Ledger.
The value of the line entry in decimal dollar cents.
Indicates if the amount is a credit or debit.
An arbitrary string on the object, useful for displaying to the user or for categorization.
The ID of the Line Entry's Ledger. Can be null in some cases for Instances using QuickBooks as their accounting package.
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
The ID of the associated Transaction, if one exists.
The unique ID of the object. Can be null in some cases for Instances using QuickBooks as their accounting package.
The datetime the Line Entry was created in UTC time.
Indicates if the Line Entry can be manually added or
removed from a Ledger, as dictated by the editable property on the Ledger.
Expandable. The associated Journal Entry object.
The ID of the associated Journal Entry. Can be null in some cases for Instances using QuickBooks as their accounting package.
An arbitrary string on the object, useful for displaying to users.
Expandable. The associated Ledger object.
The name of the Line Entry's Ledger.
A list of all the Tags associated with the Line Entry, if any.
The unique ID of the object.
An arbitrary string, useful for identifying the tag to the user.
The ID of the tag group.
Expandable. The associated Transaction object, if one exists.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
If the Ledger has any children, a list of the Ledger objects.