Set a Ledger's opening balance

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

POST

ledgers

{ledger_id}

opening-balance

curl --request POST \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/opening-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "balance": 123
}'

{
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "description": "Payroll#230215",
  "datetime": "2023-02-15T06:42:18Z",
  "files": [
    {
      "id": "CNmWM3X6AcvRdEwZKxq4bL",
      "file_name": "invoice.pdf"
    }
  ],
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ],
  "linked_entity": {
    "type": "receivable",
    "id": "<string>"
  },
  "line_entries": [
    {
      "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": []
    }
  ]
}

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

modified-by

string | null

An optional identifier for audit logging.

Path Parameters

ledger_id

string

required

The ledger ID

Query Parameters

expand

enum<string>[] | null

Comma-separated list of Journal Entry expand paths.

Available options:

line_entries,

line_entries.transaction,

line_entries.ledger

Body

application/json

balance

required

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

Response

201

application/json

Successful Response

string

required

The unique ID of the object.

Example:

"C4ocnUQze8kDwQ3EczkZXn"

description

string

required

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

Example:

"Payroll#230215"

datetime

string

required

The datetime the Journal Entry was created in UTC time.

Example:

"2023-02-15T06:42:18Z"

files

object[] | null

A list of files attached to the Journal Entry. Only available to Instances using Platform GL as their accounting package.

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

object | null

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

line_entries

object[] | null

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

line_entries.amount

number

required

The value of the line entry in decimal dollar cents.

Example:

"31282.28"

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.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

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

required

The datetime the Line Entry was created in UTC time.

Example:

"2023-02-15T06:42:18Z"

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.

Example:

true

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.

Example:

"Payroll#230215"

line_entries.ledger_name

string

required

The name of the Line Entry's Ledger.

Example:

"Payroll Expense"

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

object | null

Expandable. The associated Journal Entry object.

line_entries.journal_entry.id

string

required

The unique ID of the object.

Example:

"C4ocnUQze8kDwQ3EczkZXn"

line_entries.journal_entry.description

string

required

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

Example:

"Payroll#230215"

line_entries.journal_entry.datetime

string

required

The datetime the Journal Entry was created in UTC time.

Example:

"2023-02-15T06:42:18Z"

line_entries.journal_entry.files

object[] | null

A list of files attached to the Journal Entry. Only available to Instances using Platform GL as their accounting package.

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

object | null

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

Example:

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

line_entries.ledger

object | null

Expandable. The associated Ledger object.

line_entries.ledger.id

string

required

The unique ID of the object.

Example:

"7JRNsKwy2Lw66caxVU7WGC"

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

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

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

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.

Example:

false

line_entries.ledger.parent_id

string | null

required

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

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

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.

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

Required if financial_account_type is not specified.

Example:

"1400"

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

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.

    Required if `financial_account_type` is not specified.

Available options:

asset,

liability,

equity,

revenue,

expense

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

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

line_entries.tags

object[] | null

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

line_entries.transaction

object | null

Expandable. The associated Transaction object, if one exists.

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.

Example:

"t_9237232"

line_entries.transaction.amount

number

required

The value of the transaction in decimal dollar cents.

Example:

132629.38

line_entries.transaction.datetime

string

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.

Example:

"2024-03-15T15:28:53Z"

line_entries.transaction.description

string

required

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

Example:

"Payroll March 15 2024"

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.

Example:

false

line_entries.transaction.metadata

object | null

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.

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.

Example:

null

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.

Example:

null

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.

Example:

null

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.

Example:

null

line_entries.transaction.tags

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.

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": []
  }
]

Delete a Ledger Get all ledgers opening balances

curl --request POST \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id}/opening-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "balance": 123
}'

{
  "id": "C4ocnUQze8kDwQ3EczkZXn",
  "description": "Payroll#230215",
  "datetime": "2023-02-15T06:42:18Z",
  "files": [
    {
      "id": "CNmWM3X6AcvRdEwZKxq4bL",
      "file_name": "invoice.pdf"
    }
  ],
  "line_entry_ids": [
    "XMDsKVuW4Wmi3LTW31Qw6E",
    "NULcvXTkLczde32qs1rqgB"
  ],
  "linked_entity": {
    "type": "receivable",
    "id": "<string>"
  },
  "line_entries": [
    {
      "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": []
    }
  ]
}