Set a Ledger's opening balance

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

modified-by

string | null

An optional identifier for audit logging. An optional identifier for audit logging.

Path Parameters

ledger_id

string

required

The ledger ID The ledger ID

Query Parameters

expand

enum<string>[] | null

Comma-separated list of Journal Entry expand paths. Comma-separated list of Journal Entry expand paths.

Available options:

line_entries,

line_entries.transaction,

line_entries.ledger,

line_entries.opposing_ledger_ids

Body

application/json

balance

required

The opening balance of the ledger on the entries_start date of the Instance.

Response

Successful Response

string

required

The unique ID of the object.

description

string

required

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

datetime

string<date-time>

required

The datetime the Journal Entry was created in UTC time.

files

JournalEntryFile · object[] | null

A list of files attached to the Journal Entry.

Show child attributes

files.id

string

required

The unique ID of the object.

files.file_name

string | null

required

The name of the file uploaded to the Journal Entry. If no value is provided or null is specified, defaults to the name of the file.

Example:

"invoice.pdf"

Example:

null

line_entry_ids

string[] | null

The ids of the Line Entries detailing the Journal Entry's movement of value. Only null if the Instance is using QuickBooks as their accounting package.

Example:

[
  "XMDsKVuW4Wmi3LTW31Qw6E",
  "NULcvXTkLczde32qs1rqgB"
]

linked_entity

JournalEntryEntity · object

The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.

Show child attributes

linked_entity.type

enum<string>

required

Available options:

receivable,

receivable_adjustment,

payable

linked_entity.id

string

required

line_entries

ExpandableDetailedLineEntry · object[] | null

List of Line Entries. platformGL instances only. Included in expanded responses.

Show child attributes

line_entries.amount

number

required

The value of the line entry in decimal dollar cents.

line_entries.debit_credit

enum<string>

required

Indicates if the amount is a credit or debit.

Available options:

debit,

credit

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

line_entries.id

string | null

required

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

Example:

"XMDsKVuW4Wmi3LTW31Qw6E"

line_entries.datetime

string<date-time>

required

The datetime the Line Entry was created in UTC time.

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

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

Example:

"C4ocnUQze8kDwQ3EczkZXn"

line_entries.journal_entry_description

string

required

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

line_entries.ledger_name

string

required

The name of the Line Entry's Ledger.

line_entries.description

string | null

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

Example:

"Payroll#230215"

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

line_entries.transaction_id

string | null

The ID of the associated Transaction, if one exists.

line_entries.journal_entry

JournalEntry · object

Expandable. The associated Journal Entry object.

Show child attributes

line_entries.journal_entry.id

string

required

The unique ID of the object.

line_entries.journal_entry.description

string

required

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

line_entries.journal_entry.datetime

string<date-time>

required

The datetime the Journal Entry was created in UTC time.

line_entries.journal_entry.files

JournalEntryFile · object[] | null

A list of files attached to the Journal Entry.

Show child attributes

line_entries.journal_entry.files.id

string

required

The unique ID of the object.

line_entries.journal_entry.files.file_name

string | null

required

The name of the file uploaded to the Journal Entry. If no value is provided or null is specified, defaults to the name of the file.

Example:

"invoice.pdf"

Example:

null

line_entries.journal_entry.line_entry_ids

string[] | null

The ids of the Line Entries detailing the Journal Entry's movement of value. Only null if the Instance is using QuickBooks as their accounting package.

Example:

[
  "XMDsKVuW4Wmi3LTW31Qw6E",
  "NULcvXTkLczde32qs1rqgB"
]

line_entries.journal_entry.linked_entity

JournalEntryEntity · object

The entity that is linked with this journal entry. Journal entries with linked entities may not be modified or deleted directly.

Show child attributes

line_entries.journal_entry.linked_entity.type

enum<string>

required

Available options:

receivable,

receivable_adjustment,

payable

line_entries.journal_entry.linked_entity.id

string

required

Example:

{
  "datetime": "2023-02-15T06:42:18Z",
  "description": "Payroll#230215",
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ]
}

line_entries.ledger

Ledger · object

Expandable. The associated Ledger object.

Show child attributes

line_entries.ledger.id

string

required

The unique ID of the object.

line_entries.ledger.name

string

required

The name of the ledger.

line_entries.ledger.debit_credit

enum<string>

required

Indicates if the ledger is a credit or debit ledger.

Available options:

debit,

credit

line_entries.ledger.editable

boolean

required

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

line_entries.ledger.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.

line_entries.ledger.parent_id

string | null

required

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

Example:

null

line_entries.ledger.report_cash_flow

boolean

required

Whether Teal includes this ledger in the cash flow report.

line_entries.ledger.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.

line_entries.ledger.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

line_entries.ledger.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

line_entries.ledger.created_at

string<date-time>

required

The datetime when the ledger was created.

line_entries.ledger.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"

line_entries.ledger.parent

any | null

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

Example:

{
  "created_at": "2024-01-01T00:00:00",
  "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"
}

line_entries.opposing_ledger_ids

string[] | null

Expandable. IDs of the ledgers on the other side(s) of the line entry with opposite debit/credit.

line_entries.tags

Tag · object[] | null

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

Show child attributes

line_entries.tags.id

string

required

The unique ID of the object.

line_entries.tags.name

string

required

An arbitrary string, useful for identifying the tag to the user.

The ID of the tag group.

line_entries.transaction

Transaction · object

Expandable. The associated Transaction object, if one exists.

Show child attributes

line_entries.transaction.id

string

required

The unique ID of the object. This is used as an idempotency key to prevent duplicates. This is manually set as part of the create transactions request. If the transaction is created via a data integration, Plaid for example, it will be set to the transaction_id to enforce idempotency with the data source.

line_entries.transaction.amount

number

required

The value of the transaction in decimal dollar cents.

line_entries.transaction.datetime

string<date-time>

required

The UTC datetime that the Transaction was created. This will never be before an Instance's entries_start date. When importing transactions, transactions whose datetime is before the Instance’s entries_start date will be skipped. Other transactions will be processed as normal.

line_entries.transaction.description

string

required

An arbitrary string on the object, useful for displaying information to the user. Descriptions over 512 characters will be truncated.

line_entries.transaction.posted_status

enum<string>

required

Indicates if the corresponding journal entry and line entries for the transaction have been have been created. deleted indicates that the transaction is posted but the corresponding journal entry and line entries have been deleted.

Available options:

not_posted,

posted,

deleted

line_entries.transaction.review_status

enum<string>

required

Indicates if the transaction has been reviewed. See the reviewing transactions for steps on how to use this.

Available options:

unreviewed,

reviewed

line_entries.transaction.source_account_id

string

required

The ID of the transaction source account where the transaction is stored.

line_entries.transaction.personal

boolean

required

Whether the transaction is a non-business personal transaction.

line_entries.transaction.metadata

Metadata · object

Arbitrary structured information about the transaction. This could be location of the transaction to display to the user or vendor information to use as part of a Platform or Instance categorization rule. Teal does not use metadata for any accounting purposes.

Show child attributes

line_entries.transaction.metadata.{key}

string

Example:

null

line_entries.transaction.categorization_method

enum<string> | null

How the Transaction was assigned its category.

See the categorization guide for more details.

Available options:

ai,

rules,

similarity,

transfer_between_accounts,

uncategorized,

user

Example:

"similarity"

line_entries.transaction.journal_entry_id

string | null

The ID of the Journal Entry that the Transaction's Line Entry is associated with.

Example:

"C4ocnUQze8kDwQ3EczkZXn"

line_entries.transaction.journal_entry

null

Expandable. The associated Journal Entry object.

line_entries.transaction.ledger_id

string | null

The ID of the financial account ledger associated with the Transaction.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

line_entries.transaction.ledger

null

Expandable. The Ledger object of the financial account associated with the Transaction.

line_entries.transaction.line_entry_id

string | null

The ID of the financial account ledger associated with the Transaction.

Example:

"XMDsKVuW4Wmi3LTW31Qw6E"

line_entries.transaction.line_entry

null

Expandable. The associated Line Entry.

line_entries.transaction.opposing_line_entry_ids

string[] | null

A list of IDs of all the Line Entries objects in the journal entry with the opposite debit_credit status. For example if the Transaction's line entry is a debit this opposing line entries will be credit line entries.

Example:

["NULcvXTkLczde32qs1rqgB"]

line_entries.transaction.opposing_line_entries

null

Expandable. A list of the Line Entry objects with the opposite debit_credit status.

line_entries.transaction.tags

Tag · object[] | null

A list of all the Tags associated with the Transaction, if any. Note that Tags are not transitive and the tags on a Transaction can be different than those on its line entry or entires.

Show child attributes

line_entries.transaction.tags.id

string

required

The unique ID of the object.

line_entries.transaction.tags.name

string

required

An arbitrary string, useful for identifying the tag to the user.

The ID of the tag group.

Example:

null

Example:

{
  "amount": 31282.28,
  "datetime": "2023-02-15T06:42:18Z",
  "description": "Payroll#230215",
  "id": "txn_UjL3BQnEaJtecuC7CUeDk",
  "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
  "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
  "line_entry_id": "XMDsKVuW4Wmi3LTW31Qw6E",
  "personal": false,
  "posted_status": "posted",
  "review_status": "reviewed",
  "source_account_id": "L7RR1Yz85FJoASPvPLs441"
}

Example:

[
  {
    "amount": 31282.28,
    "datetime": "2023-02-15T06:42:18Z",
    "debit_credit": "debit",
    "description": "Payroll#230215",
    "editable": false,
    "id": "XMDsKVuW4Wmi3LTW31Qw6E",
    "journal_entry_description": "Payroll#230215",
    "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
    "ledger_id": "7JRNsKwy2Lw66caxVU7WGC",
    "ledger_name": "Pluto Checking 4242",
    "tags": [],
    "transaction_id": "txn_UjL3BQnEaJtecuC7CUeDk"
  },
  {
    "amount": 31282.28,
    "datetime": "2023-02-15T06:42:18Z",
    "debit_credit": "credit",
    "description": "Payroll#230215",
    "editable": false,
    "id": "NULcvXTkLczde32qs1rqgB",
    "journal_entry_description": "Payroll#230215",
    "journal_entry_id": "C4ocnUQze8kDwQ3EczkZXn",
    "ledger_id": "HLn8oy2eqMUCwjp1Cwdgco",
    "ledger_name": "Payroll Expense",
    "tags": []
  }
]

API overview

Teal API Endpoints

API Migration

Set a Ledger's opening balance

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response