|
|
|
| Description |
| A Journal is a parsed ledger file, containing Transactions.
It can be filtered and massaged in various ways, then "crunched"
to form a Ledger.
|
|
| Synopsis |
|
|
|
| Documentation |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Keep only transactions we are interested in, as described by
the filter specification. May also massage the data a little.
|
|
|
| Keep only postings we are interested in, as described by
the filter specification. May also massage the data a little.
This can leave unbalanced transactions.
|
|
|
| Keep only ledger transactions whose description matches the description patterns.
|
|
|
| Keep only ledger transactions which fall between begin and end dates.
We include transactions on the begin date and exclude transactions on the end
date, like ledger. An empty date string means no restriction.
|
|
|
| Keep only ledger transactions which have the requested
cleared/uncleared status, if there is one.
|
|
|
| Keep only postings which have the requested cleared/uncleared status,
if there is one.
|
|
|
| Strip out any virtual postings, if the flag is true, otherwise do
no filtering.
|
|
|
| Strip out any postings with zero amount, unless the flag is true.
|
|
|
| Keep only transactions which affect accounts deeper than the specified depth.
|
|
|
| Strip out any postings to accounts deeper than the specified depth
(and any ledger transactions which have no postings as a result).
|
|
|
| Keep only transactions which affect accounts matched by the account patterns.
|
|
|
| Keep only postings which affect accounts matched by the account patterns.
This can leave transactions unbalanced.
|
|
|
| Convert this journal's transactions' primary date to either the
actual or effective date.
|
|
|
| Convert all the journal's amounts to their canonical display settings.
Ie, in each commodity, amounts will use the display settings of the first
amount detected, and the greatest precision of the amounts detected.
Also, missing unit prices are added if known from the price history.
Also, amounts are converted to cost basis if that flag is active.
XXX refactor
|
|
|
| Get just the amounts from a ledger, in the order parsed.
|
|
|
| Get just the ammount commodities from a ledger, in the order parsed.
|
|
|
| Get just the amount precisions from a ledger, in the order parsed.
|
|
|
| Close any open timelog sessions using the provided current time.
|
|
|
| The (fully specified) date span containing all the raw ledger's transactions,
or DateSpan Nothing Nothing if there are none.
|
|
|
| Check if a set of ledger account/description patterns matches the
given account name or entry description. Patterns are case-insensitive
regular expression strings; those beginning with - are anti-patterns.
|
|
|
| Calculate the account tree and account balances from a journal's
postings, and return the results for efficient lookup.
|
|
|
| Given a list of postings, return an account name tree and three query
functions that fetch postings, balance, and subaccount-including
balance by account name. This factors out common logic from
cacheLedger and summarisePostingsInDateSpan.
|
|
|
| Add subaccount-excluding and subaccount-including balances to a tree
of account names somewhat efficiently, given a function that looks up
transactions by account name.
|
|
|
| Convert a list of postings to a map from account name to that
account's postings.
|
|
| Produced by Haddock version 2.6.0 |
