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.

Documentation

nullledger :: Ledger

ledgerFromJournal :: 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.

ledgerAccountNames :: Ledger -> [AccountName]

List a ledger's account names.

ledgerAccount :: Ledger -> AccountName -> Maybe Account

Get the named account from a ledger.

ledgerRootAccount :: Ledger -> Account

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.

ledgerTopAccounts :: Ledger -> [Account]

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

ledgerLeafAccounts :: Ledger -> [Account]

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

ledgerPostings :: Ledger -> [Posting]

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

ledgerDateSpan :: Ledger -> DateSpan

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

ledgerCommodities :: Ledger -> [CommoditySymbol]

All commodities used in this ledger.

tests_Ledger :: TestTree

Orphan instances

Show Ledger

Methods

showsPrec :: Int -> Ledger -> ShowS

show :: Ledger -> String

showList :: [Ledger] -> ShowS