Hledger.Data.Posting

A Posting represents a change (by some MixedAmount) of the balance in some Account. Each Transaction contains two or more postings which should add up to 0. Postings reference their parent transaction, so we can look up the date or description there.

Posting

nullposting :: Posting

posting :: Posting

post :: AccountName -> Amount -> Posting

Make a posting to an account.

vpost :: AccountName -> Amount -> Posting

Make a virtual (unbalanced) posting to an account.

post' :: AccountName -> Amount -> Maybe BalanceAssertion -> Posting

Make a posting to an account, maybe with a balance assertion.

vpost' :: AccountName -> Amount -> Maybe BalanceAssertion -> Posting

Make a virtual (unbalanced) posting to an account, maybe with a balance assertion.

nullsourcepos :: GenericSourcePos

nullassertion :: BalanceAssertion

assertion :: BalanceAssertion

balassert :: Amount -> Maybe BalanceAssertion

Make a partial, exclusive balance assertion.

balassertTot :: Amount -> Maybe BalanceAssertion

Make a total, exclusive balance assertion.

balassertParInc :: Amount -> Maybe BalanceAssertion

Make a partial, inclusive balance assertion.

balassertTotInc :: Amount -> Maybe BalanceAssertion

Make a total, inclusive balance assertion.

operations

originalPosting :: Posting -> Posting

postingStatus :: Posting -> Status

Get a posting's status. This is cleared or pending if those are explicitly set on the posting, otherwise the status of its parent transaction, or unmarked if there is no parent transaction. (Note the ambiguity, unmarked can mean "posting and transaction are both unmarked" or "posting is unmarked and don't know about the transaction".

isReal :: Posting -> Bool

isVirtual :: Posting -> Bool

isBalancedVirtual :: Posting -> Bool

isEmptyPosting :: Posting -> Bool

hasBalanceAssignment :: Posting -> Bool

hasAmount :: Posting -> Bool

postingAllTags :: Posting -> [Tag]

Tags for this posting including any inherited from its parent transaction.

transactionAllTags :: Transaction -> [Tag]

Tags for this transaction including any from its postings.

relatedPostings :: Posting -> [Posting]

removePrices :: Posting -> Posting

Remove all prices of a posting

date operations

postingDate :: Posting -> Day

Get a posting's (primary) date - it's own primary date if specified, otherwise the parent transaction's primary date, or the null date if there is no parent transaction.

postingDate2 :: Posting -> Day

Get a posting's secondary (secondary) date, which is the first of: posting's secondary date, transaction's secondary date, posting's primary date, transaction's primary date, or the null date if there is no parent transaction.

isPostingInDateSpan :: DateSpan -> Posting -> Bool

Does this posting fall within the given date span ?

isPostingInDateSpan' :: WhichDate -> DateSpan -> Posting -> Bool

postingsDateSpan :: [Posting] -> DateSpan

Get the minimal date span which contains all the postings, or the null date span if there are none.

postingsDateSpan' :: WhichDate -> [Posting] -> DateSpan

account name operations

accountNamesFromPostings :: [Posting] -> [AccountName]

Sorted unique account names referenced by these postings.

accountNamePostingType :: AccountName -> PostingType

accountNameWithoutPostingType :: AccountName -> AccountName

accountNameWithPostingType :: PostingType -> AccountName -> AccountName

joinAccountNames :: AccountName -> AccountName -> AccountName

Prefix one account name to another, preserving posting type indicators like concatAccountNames.

concatAccountNames :: [AccountName] -> AccountName

Join account names into one. If any of them has () or [] posting type indicators, these (the first type encountered) will also be applied to the resulting account name.

accountNameApplyAliases :: [AccountAlias] -> AccountName -> AccountName

Rewrite an account name using all matching aliases from the given list, in sequence. Each alias sees the result of applying the previous aliases.

accountNameApplyAliasesMemo :: [AccountAlias] -> AccountName -> AccountName

Memoising version of accountNameApplyAliases, maybe overkill.

transaction description operations

transactionPayee :: Transaction -> Text

transactionNote :: Transaction -> Text

payeeAndNoteFromDescription :: Text -> (Text, Text)

Parse a transaction's description into payee and note (aka narration) fields, assuming a convention of separating these with | (like Beancount). Ie, everything up to the first | is the payee, everything after it is the note. When there's no |, payee == note == description.

arithmetic

sumPostings :: [Posting] -> MixedAmount

rendering

showPosting :: Posting -> String

misc.

showComment :: Text -> String

tests_Posting :: Test ()