hledger-0.4: A ledger-compatible text-based accounting tool.Source codeContentsIndex
Ledger.RawLedger
Description
A RawLedger is a parsed ledger file. We call it raw to distinguish from the cached Ledger.
Synopsis
rawLedgerEmpty :: RawLedger
addEntry :: Entry -> RawLedger -> RawLedger
addModifierEntry :: ModifierEntry -> RawLedger -> RawLedger
addPeriodicEntry :: PeriodicEntry -> RawLedger -> RawLedger
addHistoricalPrice :: HistoricalPrice -> RawLedger -> RawLedger
addTimeLogEntry :: TimeLogEntry -> RawLedger -> RawLedger
rawLedgerTransactions :: RawLedger -> [Transaction]
rawLedgerAccountNamesUsed :: RawLedger -> [AccountName]
rawLedgerAccountNames :: RawLedger -> [AccountName]
rawLedgerAccountNameTree :: RawLedger -> Tree AccountName
filterRawLedger :: DateSpan -> [String] -> Bool -> Bool -> RawLedger -> RawLedger
filterRawLedgerEntriesByDescription :: [String] -> RawLedger -> RawLedger
filterRawLedgerEntriesByDate :: DateSpan -> RawLedger -> RawLedger
filterRawLedgerEntriesByClearedStatus :: Bool -> RawLedger -> RawLedger
filterRawLedgerTransactionsByRealness :: Bool -> RawLedger -> RawLedger
filterRawLedgerTransactionsByDepth :: Int -> RawLedger -> RawLedger
filterRawLedgerEntriesByAccount :: [String] -> RawLedger -> RawLedger
canonicaliseAmounts :: Bool -> RawLedger -> RawLedger
rawLedgerAmounts :: RawLedger -> [MixedAmount]
rawLedgerCommodities :: RawLedger -> [Commodity]
rawLedgerPrecisions :: RawLedger -> [Int]
rawLedgerConvertTimeLog :: LocalTime -> RawLedger -> RawLedger
Documentation
rawLedgerEmpty :: RawLedgerSource
addEntry :: Entry -> RawLedger -> RawLedgerSource
addModifierEntry :: ModifierEntry -> RawLedger -> RawLedgerSource
addPeriodicEntry :: PeriodicEntry -> RawLedger -> RawLedgerSource
addHistoricalPrice :: HistoricalPrice -> RawLedger -> RawLedgerSource
addTimeLogEntry :: TimeLogEntry -> RawLedger -> RawLedgerSource
rawLedgerTransactions :: RawLedger -> [Transaction]Source
rawLedgerAccountNamesUsed :: RawLedger -> [AccountName]Source
rawLedgerAccountNames :: RawLedger -> [AccountName]Source
rawLedgerAccountNameTree :: RawLedger -> Tree AccountNameSource
filterRawLedger :: DateSpan -> [String] -> Bool -> Bool -> RawLedger -> RawLedgerSource
Remove ledger entries we are not interested in. Keep only those which fall between the begin and end dates, and match the description pattern, and are cleared or real if those options are active.
filterRawLedgerEntriesByDescription :: [String] -> RawLedger -> RawLedgerSource
Keep only entries whose description matches the description patterns.
filterRawLedgerEntriesByDate :: DateSpan -> RawLedger -> RawLedgerSource
Keep only entries which fall between begin and end dates. We include entries on the begin date and exclude entries on the end date, like ledger. An empty date string means no restriction.
filterRawLedgerEntriesByClearedStatus :: Bool -> RawLedger -> RawLedgerSource
Keep only entries with cleared status, if the flag is true, otherwise do no filtering.
filterRawLedgerTransactionsByRealness :: Bool -> RawLedger -> RawLedgerSource
Strip out any virtual transactions, if the flag is true, otherwise do no filtering.
filterRawLedgerTransactionsByDepth :: Int -> RawLedger -> RawLedgerSource
Strip out any transactions to accounts deeper than the specified depth (and any entries which have no transactions as a result).
filterRawLedgerEntriesByAccount :: [String] -> RawLedger -> RawLedgerSource
Keep only entries which affect accounts matched by the account patterns.
canonicaliseAmounts :: Bool -> RawLedger -> RawLedgerSource
Give all a ledger's amounts their canonical display settings. That is, in each commodity, amounts will use the display settings of the first amount detected, and the greatest precision of the amounts detected. Also, amounts are converted to cost basis if that flag is active.
rawLedgerAmounts :: RawLedger -> [MixedAmount]Source
Get just the amounts from a ledger, in the order parsed.
rawLedgerCommodities :: RawLedger -> [Commodity]Source
Get just the ammount commodities from a ledger, in the order parsed.
rawLedgerPrecisions :: RawLedger -> [Int]Source
Get just the amount precisions from a ledger, in the order parsed.
rawLedgerConvertTimeLog :: LocalTime -> RawLedger -> RawLedgerSource
Close any open timelog sessions using the provided current time.
Produced by Haddock version 2.6.0