Delete a Ledger

curl --request DELETE \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>",
  "error_code": "invalid_date"
}

Ledgers

Delete a Ledger

Deletes a Ledger and optionally its associated journal entries. By default, ledgers with line entries cannot be deleted. Set delete_journal_entries=true to delete the ledger along with: - All journal entries that have line entries on this ledger - All line entries in those journal entries - All reconciliations for this ledger - The source account (if not linked to Plaid/QuickBooks) - Historical ledger balances Note: This operation is irreversible. Special ledgers (e.g., uncategorized inflow/outflow) cannot be deleted.

DELETE

ledgers

{ledger_id}

Delete a Ledger

curl --request DELETE \
  --url https://api.sandbox.teal.dev/v0/ledgers/{ledger_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'teal-instance-id: <teal-instance-id>'

{
  "message": "<string>",
  "data": "<unknown>",
  "display_message": "<string>",
  "error_code": "invalid_date"
}

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

delete_journal_entries

boolean

default:false

Whether to delete journal entries associated with this ledger. When true, deletes all journal entries containing line entries on this ledger, along with reconciliations and the source account. This operation is irreversible.

Response

Successful Response

Update a Ledger Delete multiple ledgers in bulk

⌘I

API overview

Teal API Endpoints

API Migration

Delete a Ledger

Authorizations

Headers

Path Parameters

Query Parameters

Response