hledger-lib-1.15: Core data types, parsers and functionality for the hledger accounting tools

Hledger.Data.Transaction

Description

A Transaction represents a movement of some commodity(ies) between two or more accounts. It consists of multiple account Postings which balance to zero, a date, and optional extras like description, cleared status, and tags.

Synopsis

# Transaction

Make a simple transaction with the given date and postings.

Ensure a transaction's postings refer back to it, so that eg relatedPostings works right.

Ensure a transaction's postings do not refer back to it, so that eg recursiveSize and GHCI's :sprint work right.

# operations

Show an account name, clipped to the given width if any, and appropriately bracketed/parenthesised for the given posting type.

Does this transaction appear balanced when rendered, optionally with the given commodity display styles ? More precisely: after converting amounts to cost using explicit transaction prices if any; and summing the real postings, and summing the balanced virtual postings; and applying the given display styles if any (maybe affecting decimal places); do both totals appear to be zero when rendered ?

Arguments

 :: Maybe (Map CommoditySymbol AmountStyle) commodity display styles -> Transaction -> Either String Transaction

Balance this transaction, ensuring that its postings (and its balanced virtual postings) sum to 0, by inferring a missing amount or conversion price(s) if needed. Or if balancing is not possible, because the amounts don't sum to 0 or because there's more than one missing amount, return an error message.

Transactions with balance assignments can have more than one missing amount; to balance those you should use the more powerful journalBalanceTransactions.

The "sum to 0" test is done using commodity display precisions, if provided, so that the result agrees with the numbers users can see.

Arguments

 :: Maybe (Map CommoditySymbol AmountStyle) commodity display styles -> Transaction -> Either String (Transaction, [(AccountName, MixedAmount)])

Helper used by balanceTransaction and balanceTransactionWithBalanceAssignmentAndCheckAssertionsB; use one of those instead. It also returns a list of accounts and amounts that were inferred.

# arithmetic

Get the sums of a transaction's real, virtual, and balanced virtual postings.

# rendering

Render a journal transaction as text in the style of Ledger's print command.

Ledger 2.x's standard format looks like this:

yyyymmdd[ *][ CODE] description.........          [  ; comment...............]
account name 1.....................  ...$amount1[ ; comment...............] account name 2..................... ..$-amount1[  ; comment...............]

pcodewidth    = no limit -- 10          -- mimicking ledger layout.
pdescwidth    = no limit -- 20          -- I don't remember what these mean,
pacctwidth    = 35 minimum, no maximum  -- they were important at the time.
pamtwidth     = 11
pcommentwidth = no limit -- 22


The output will be parseable journal syntax. To facilitate this, postings with explicit multi-commodity amounts are displayed as multiple similar postings, one per commodity. (Normally does not happen with this function).

If there are multiple postings, all with explicit amounts, and the transaction appears obviously balanced (postings sum to 0, without needing to infer conversion prices), the last posting's amount will not be shown.

Like showTransaction, but does not change amounts' explicitness. Explicit amounts are shown and implicit amounts are not. The output will be parseable journal syntax. To facilitate this, postings with explicit multi-commodity amounts are displayed as multiple similar postings, one per commodity. Most often, this is the one you want to use.

Like showTransactionUnelided, but explicit multi-commodity amounts are shown on one line, comma-separated. In this case the output will not be parseable journal syntax.

Render a posting, simply. Used in balance assertion errors. showPostingLine p = lineIndent $if pstatus p == Cleared then "* " else "" ++ -- XXX show ! showAccountName Nothing (ptype p) (paccount p) ++ " " ++ showMixedAmountOneLine (pamount p) ++ assertion where -- XXX extract, handle == assertion = maybe "" ((" = " ++) . showAmountWithZeroCommodity . baamount)$ pbalanceassertion p

Render a posting, at the appropriate width for aligning with its siblings if any. Used by the rewrite command.

# GenericSourcePos

Render source position in human-readable form. Keep in sync with Hledger.UI.ErrorScreen.hledgerparseerrorpositionp (temporary). XXX