- 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 Balance Sheet
Retrieves the balance sheet for the business. Returns a list of ledger summaries grouped by ledger type. Requires a Tier 2 subscription.
The access token received from the authorization server in the OAuth 2.0 flow.
The Teal instance ID
The balance sheet as of the end date (inclusive). The start date
for a balance sheet is always the entries_start date of the Instance.
Whether to include empty ledgers with no line entries. Only available for Platform GL instances.
Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
The Teal instance ID
Query Parameters
The balance sheet as of the end date (inclusive). The start date
for a balance sheet is always the entries_start date of the Instance.
Whether to include empty ledgers with no line entries. Only available for Platform GL instances.
Comma-separated list of tag IDs for filtering. Requires a Tier 3 subscription
Response
A list of Records that represents either a ledger or a groups of ledgers.
Records that are groups of
ledgers are grouped by balance sheet type: asset, liability, and
equity, in that order, and then by sub_type. Within each sub_type
group, Ledger objects are ordered by sort_code.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.
The sum, in decimal dollar cents, of all line entries in the ledger.
Indicates if the ledger is a credit or debit ledger.
Required if financial_account_type is not specified.
debit, credit The ID of the Ledger object.
The name of the ledger.
If the Ledger is a child Ledger, the ID of the parent Ledger object.
Determines the display order in reports, ordered digit
by digit, starting from the leftmost position. For example, 20010 will come
before 3050.
Indicates similar characteristics and accounting
treatment for a group of ledgers within a type.
Required if
financial_account_type is not specified.
The sum, in decimal dollar cents, of the ledger
amount and the amount of all child ledgers, if any.
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.
If the Ledger has any children, a list of the Ledger objects.