Ledger Account Statements

A ledger_account_statement is an object that provides the starting and ending balances for a specific time period. Once created, it can be used to retrieve the ledger entries and ledger transaction versions that correspond to that time period and lock version of the ledger account.

Attribute	Description
id string	Unique identifier for the ledger account statement.
description string	An optional free-form description for internal use.
ledger_id string	The id of the ledger that this ledger account statement belongs to.
ledger_account_id string	The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result.
effective_at_lower_bound datetime	The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.
effective_at_upper_bound datetime	The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.
ledger_account_lock_version int32	Lock version of the ledger account at the time of statement generation.
ledger_account_normal_balance string	The normal balance of the ledger account.
currency_exponent int32	The currency exponent of the ledger account payout.
starting_balances object	The pending, posted, and available balances for this ledger account at the `effective_at_lower_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts.
ending_balances object	The pending, posted, and available balances for this ledger account at the `effective_at_upper_bound`. The posted balance is the sum of all posted entries on the account. The pending balance is the sum of all pending and posted entries on the account. The available balance is the posted incoming entries minus the sum of the pending and posted outgoing amounts.
metadata object	Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata.
live_mode boolean	This field will be true if this object was created with a production API key or false if created with a test API key.
created_at datetime	The datetime that the ledger account statement was created.
updated_at datetime	The datetime of the last update to the ledger account statement.