Skip to main content
POST
Set a Ledger's opening balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

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:
accrual_source,
autocat_result,
line_entries,
line_entries.transaction,
line_entries.ledger,
line_entries.opposing_ledger_ids,
line_entries.payment_applications,
line_entries.line_payment_applications,
transfer

Body

application/json
balance
required

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

Required range: -1000000000000000000 <= x <= 1000000000000000000

Response

Successful Response

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

Maximum string length: 512
Example:

"Payroll#230215"

datetime
string<date-time>
required

The datetime the Journal Entry was created in UTC time.

Example:

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

creation_date
string<date-time>
required

The timestamp when this journal entry record was created in the database.

Example:

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

is_opening_balance
boolean
required

Whether the Journal Entry represents an opening balance.

Example:

false

creation_source
enum<string>
required

The source of the journal entry creation: 'manual' if created manually by the user, 'transaction' if auto-generated from transaction categorization (e.g., Plaid sync), or 'legacy' if auto-generated from the old AR/AP system.

Available options:
manual,
transaction,
accrual,
payment_application,
legacy,
scheduled_accrual
categorization_status
enum<string>
required

Whether the journal entry is still awaiting an auto-categorization result: 'pending' (awaiting), 'delayed' (timed out, a late result may still resolve it), or 'completed' (resolved, or not auto-categorized).

Available options:
pending,
delayed,
completed
line_entry_ids
string[] | null

The ids of the Line Entries detailing the Journal Entry's movement of value.

Example:
linked_entity
null

Deprecated - always null

line_entries
ExpandableDetailedLineEntry · object[] | null

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

Example:
accrual_source
AccrualSourceDetails · object | null

The accrual source associated with this journal entry, if any. Included in expanded responses.

transfer
Transfer · object | null

The transfer linking this journal entry to the journal entry on the other side of the transfer, if any. Included in expanded responses.

autocat_result
AutocatResult · object | null

The auto-categorization result for the transaction underlying this journal entry, if any: how the category ledger was assigned (method, confidence, and rule). Null for manual journal entries, entries not categorized by the autocat pipeline, and entries a user has since manually recategorized (a manual categorization overrides the autocat result). Included in expanded responses.