Modulehledger-lib-1.52.4GHC2021

Hledger.Data.Ledger

A Ledger is derived from a Journal by applying a filter specification to select Transactions and Postings of interest. It contains the filtered journal and knows the resulting chart of accounts, account balances, and postings in each account.

11 values

Packagehledger-lib-1.52.4
Exports11
LanguageGHC2021
LicenceGPL-3.0-or-later
SourceLedger.hs

valuenullledger :: Ledger

valueledgerFromJournal :: Query -> Journal -> Ledger

Filter a journal's transactions with the given query, then build a Ledger, containing the journal plus the tree of all its accounts with their subaccount-inclusive and subaccount-exclusive balances. If the query includes a depth limit, the ledger's journal will be depth limited, but the ledger's account tree will not.

valueledgerAccountNames :: Ledger -> [AccountName]

List a ledger's account names.

valueledgerAccount :: Ledger -> AccountName -> Maybe (Account BalanceData)

Get the named account from a ledger.

valueledgerRootAccount :: Ledger -> Account BalanceData

Get this ledger's root account, which is a dummy "root" account above all others. This should always be first in the account list, if somehow not this returns a null account.

valueledgerTopAccounts :: Ledger -> [Account BalanceData]

List a ledger's top-level accounts (the ones below the root), in tree order.

valueledgerLeafAccounts :: Ledger -> [Account BalanceData]

List a ledger's bottom-level (subaccount-less) accounts, in tree order.

valueledgerPostings :: Ledger -> [Posting]

List a ledger's postings, in the order parsed.

valueledgerDateSpan :: Ledger -> DateSpan

The (fully specified) date span containing all the ledger's (filtered) transactions, or DateSpan Nothing Nothing if there are none.

valueledgerCommodities :: Ledger -> [CommoditySymbol]

All commodities used in this ledger.

valuetests_Ledger :: TestTree

Orphan instances

1 instance

Show Ledger