Hledger.Data.Transaction

Description

A Transaction represents a single balanced entry in the ledger file. It normally contains two or more balanced Postings.

Synopsis

Documentation

nulltransaction :: Transaction Source

showTransaction :: Transaction -> String Source

Show a ledger entry, 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 Source

showTransactionForPrint :: Bool -> Transaction -> String Source

showTransaction' :: Bool -> Bool -> Transaction -> String Source

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

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

realPostings :: Transaction -> [Posting]Source

virtualPostings :: Transaction -> [Posting]Source

balancedVirtualPostings :: Transaction -> [Posting]Source

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

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

isTransactionBalanced :: Transaction -> Bool Source

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 :: Transaction -> Either String Transaction Source

Ensure that this entry is balanced, possibly auto-filling a missing amount first. We can auto-fill if there is just one non-virtual transaction without an amount. The auto-filled balance will be converted to cost basis if possible. If the entry can not be balanced, return an error message instead.

nonzerobalanceerror :: Transaction -> String Source

ledgerTransactionWithDate :: WhichDate -> Transaction -> Transaction Source

Convert the primary date to either the actual or effective date.

txnTieKnot :: Transaction -> Transaction Source

Ensure a transaction's postings refer back to it.

settxn :: Transaction -> Posting -> Posting Source

Set a posting's parent transaction.