PUT
/
v0
/
ledgers
/
{ledger_id}
Update a Ledger
curl --request PUT \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'teal-instance-id: <teal-instance-id>' \
  --data '{
  "debit_credit": "debit",
  "name": "Pluto Checking 4242",
  "parent_id": null,
  "sort_code": "1400",
  "sub_type": "current_assets",
  "type": "asset",
  "clear_fields": [
    "parent_id"
  ]
}'
{
  "id": "7JRNsKwy2Lw66caxVU7WGC",
  "name": "Pluto Checking 4242",
  "debit_credit": "debit",
  "editable": false,
  "financial_account_type": "bank_account",
  "is_required": false,
  "parent": {},
  "parent_id": null,
  "report_cash_flow": false,
  "sort_code": "1400",
  "sub_type": "current_assets",
  "type": "asset",
  "created_at": "2024-01-01T00:00:00Z"
}

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

Path Parameters

​
ledger_id
string
required

The ledger ID

Query Parameters

​
expand
enum<string>[] | null

Comma-separated list of Ledger expand paths.

Body

application/json
​
debit_credit
enum<string> | null

Indicates if the ledger is a credit or debit ledger.

Required if financial_account_type is not specified.

Available options:
debit,
credit
Examples:

"debit"

​
name
string | null

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.

Examples:

"Pluto Checking 4242"

​
parent_id
string | null

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

Examples:

null

​
sort_code
string | null

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.

Maximum length: 20
Examples:

"1400"

​
sub_type
enum<string> | null

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
Examples:

"current_assets"

​
type
enum<string> | null

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
Examples:

"asset"

​
clear_fields
enum<string>[] | null

A list of fields to be cleared.

Examples:
["parent_id"]

Response

Successful Response

​
id
string
required

The unique ID of the object.

Examples:

"7JRNsKwy2Lw66caxVU7WGC"

​
name
string
required

The name of the ledger.

Examples:

"Pluto Checking 4242"

​
debit_credit
enum<string>
required

Indicates if the ledger is a credit or debit ledger.

Available options:
debit,
credit
​
editable
boolean
required

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

Examples:

false

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

Examples:

false

​
parent_id
string | null
required

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

Examples:

null

​
report_cash_flow
boolean
required

Whether Teal includes this ledger in the cash flow report.

Examples:

false

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

Examples:

"1400"

​
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
​
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
​
created_at
string<date-time>
required

The datetime when the ledger was created.

Examples:

"2024-01-01T00:00:00Z"

​
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
Examples:

"bank_account"

​
parent
object | null

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