hledger-lib-1.21: A reusable library providing the core functionality of hledger
Safe HaskellNone
LanguageHaskell2010

Hledger.Data.Posting

Description

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.

Synopsis

Posting

post :: AccountName -> Amount -> Posting Source #

Make a posting to an account.

vpost :: AccountName -> Amount -> Posting Source #

Make a virtual (unbalanced) posting to an account.

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

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

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

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

balassert :: Amount -> Maybe BalanceAssertion Source #

Make a partial, exclusive balance assertion.

balassertTot :: Amount -> Maybe BalanceAssertion Source #

Make a total, exclusive balance assertion.

balassertParInc :: Amount -> Maybe BalanceAssertion Source #

Make a partial, inclusive balance assertion.

balassertTotInc :: Amount -> Maybe BalanceAssertion Source #

Make a total, inclusive balance assertion.

operations

postingStatus :: Posting -> Status Source #

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".

postingAllTags :: Posting -> [Tag] Source #

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

transactionAllTags :: Transaction -> [Tag] Source #

Tags for this transaction including any from its postings.

removePrices :: Posting -> Posting Source #

Remove all prices of a posting

postingApplyAliases :: [AccountAlias] -> Posting -> Either RegexError Posting Source #

Apply some account aliases to the posting's account name, as described by accountNameApplyAliases. This can fail due to a bad replacement pattern in a regular expression alias.

date operations

postingDate :: Posting -> Day Source #

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 Source #

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 Source #

Does this posting fall within the given date span ?

account name operations

accountNamesFromPostings :: [Posting] -> [AccountName] Source #

Sorted unique account names referenced by these postings.

joinAccountNames :: AccountName -> AccountName -> AccountName Source #

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

concatAccountNames :: [AccountName] -> AccountName Source #

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 -> Either RegexError AccountName Source #

Rewrite an account name using all matching aliases from the given list, in sequence. Each alias sees the result of applying the previous aliases. Or, return any error arising from a bad regular expression in the aliases.

accountNameApplyAliasesMemo :: [AccountAlias] -> AccountName -> Either RegexError AccountName Source #

Memoising version of accountNameApplyAliases, maybe overkill.

comment/tag operations

commentJoin :: Text -> Text -> Text Source #

Join two parts of a comment, eg a tag and another tag, or a tag and a non-tag, on a single line. Interpolates a comma and space unless one of the parts is empty.

commentAddTag :: Text -> Tag -> Text Source #

Add a tag to a comment, comma-separated from any prior content. A space is inserted following the colon, before the value.

commentAddTagNextLine :: Text -> Tag -> Text Source #

Add a tag on its own line to a comment, preserving any prior content. A space is inserted following the colon, before the value.

arithmetic

rendering

misc.

postingTransformAmount :: (MixedAmount -> MixedAmount) -> Posting -> Posting Source #

Apply a transform function to this posting's amount.

postingApplyCostValuation :: PriceOracle -> Map CommoditySymbol AmountStyle -> Day -> Day -> Costing -> Maybe ValuationType -> Posting -> Posting Source #

Apply a specified costing and valuation to this posting's amount, using the provided price oracle, commodity styles, and reference dates. Costing is done first if requested, and after that any valuation. See amountApplyValuation and amountCost.

postingApplyValuation :: PriceOracle -> Map CommoditySymbol AmountStyle -> Day -> Day -> ValuationType -> Posting -> Posting Source #

Apply a specified valuation to this posting's amount, using the provided price oracle, commodity styles, and reference dates. See amountApplyValuation.

postingToCost :: Map CommoditySymbol AmountStyle -> Posting -> Posting Source #

Convert this posting's amount to cost, and apply the appropriate amount styles.