Get ledger

GET /api/v1/ledgers/{ledger_id}

Retrieve a specific ledger/account with full details.

Operation ID: get_ledger_api_v1_ledgers__ledger_id__get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

ledger_id string required

Responses

200 Successful Response

Schema: LedgerResponse

id string required

Ledger UUID.

teal_ledger_id string

Linked Teal accounting system ID.

name string required

Account name.

currency string

Currency for this account (USD, CAD, AUD, EUR, or GBP).

type string required

Account type: asset, liability, equity, revenue, expense.

balance integer

Current balance in cents (may be negative).

parent_id string

Parent ledger UUID for sub-accounts.

description string

Account description.

status string

Status: 'active' or 'inactive'.

debit_credit string

Normal balance: 'debit' or 'credit'.

sort_code string

Sort code for chart ordering.

sub_type string

Sub-classification for reporting.

report_cash_flow boolean

Whether included in cash flow statement.

cash_flow_section CashFlowSectionEnum

Cash flow statement section: 'operating', 'investing', 'financing', or 'excluded'.

cfs_class CashFlowClassEnum

Indirect-method cash flow classification used to populate the Statement of Cash Flows.

editable boolean

Whether journal entries can be manually posted to this account.

financial_account_type string

Template type if created in Templated Mode.

is_required boolean

True for system-required accounts that cannot be deleted.

system_key string

Immutable key for system/base ledgers (e.g. 'accounts_receivable'). Null for user-created ledgers.

teal_account_link_id string

UUID of the TealAccountLink if this ledger is connected to a bank/Plaid source account. Null for unlinked ledgers.

business_id string

Business UUID.

created_at string · date-time

Creation timestamp.

updated_at string · date-time

Last update timestamp.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object