Hledger.Data.Transaction

A Transaction consists of two or more related Postings which balance to zero, representing a movement of some commodity(ies) between accounts, plus a date and optional metadata like description and cleared status.

Documentation

nulltransaction :: Transaction

showTransaction :: Transaction -> String

Show a journal transaction, formatted for the 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

showTransactionUnelided :: Transaction -> String

showTransaction' :: Bool -> Transaction -> String

showAccountName :: Maybe Int -> PostingType -> AccountName -> String

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

hasRealPostings :: Transaction -> Bool

realPostings :: Transaction -> [Posting]

virtualPostings :: Transaction -> [Posting]

balancedVirtualPostings :: Transaction -> [Posting]

transactionsPostings :: [Transaction] -> [Posting]

transactionPostingBalances :: Transaction -> (MixedAmount, MixedAmount, MixedAmount)

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

isTransactionBalanced :: Maybe (Map String Commodity) -> Transaction -> Bool

Is this transaction balanced ? A balanced transaction's real (non-virtual) postings sum to 0, and any balanced virtual postings also sum to 0.

balanceTransaction :: Maybe (Map String Commodity) -> Transaction -> Either String Transaction

Ensure this transaction is balanced, possibly inferring a missing amount or a conversion price first, or return an error message.

Balancing is affected by the provided commodities' display precisions.

We can infer an amount when there are multiple real postings and exactly one of them is amountless; likewise for balanced virtual postings. Inferred amounts are converted to cost basis when possible.

We can infer a price when all amounts were specified and the sum of real postings' amounts is exactly two non-explicitly-priced amounts in different commodities; likewise for balanced virtual postings.

nonzerobalanceerror :: Transaction -> String

transactionActualDate :: Transaction -> Day

transactionEffectiveDate :: Transaction -> Day

journalTransactionWithDate :: WhichDate -> Transaction -> Transaction

Once we no longer need both, set the main transaction date to either the actual or effective date. A bit hacky.

txnTieKnot :: Transaction -> Transaction

Ensure a transaction's postings refer back to it.

settxn :: Transaction -> Posting -> Posting

Set a posting's parent transaction.