hledger-0.6.1: A command-line (or curses or web-based) double-entry accounting tool.Source codeContentsIndex
Ledger.LedgerTransaction
Description
A LedgerTransaction represents a regular transaction in the ledger file. It normally contains two or more balanced Postings.
Synopsis
nullledgertxn :: LedgerTransaction
showLedgerTransaction :: LedgerTransaction -> String
showLedgerTransactionUnelided :: LedgerTransaction -> String
showLedgerTransaction' :: Bool -> LedgerTransaction -> String
showAccountName :: Maybe Int -> PostingType -> AccountName -> String
isLedgerTransactionBalanced :: LedgerTransaction -> Bool
balanceLedgerTransaction :: LedgerTransaction -> Either String LedgerTransaction
Documentation
nullledgertxn :: LedgerTransactionSource
showLedgerTransaction :: LedgerTransaction -> StringSource

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
showLedgerTransactionUnelided :: LedgerTransaction -> StringSource
showLedgerTransaction' :: Bool -> LedgerTransaction -> StringSource
showAccountName :: Maybe Int -> PostingType -> AccountName -> StringSource
Show an account name, clipped to the given width if any, and appropriately bracketed/parenthesised for the given posting type.
isLedgerTransactionBalanced :: LedgerTransaction -> BoolSource
balanceLedgerTransaction :: LedgerTransaction -> Either String LedgerTransactionSource
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.
Produced by Haddock version 2.6.0