hledger-lib-1.2: Core data types, parsers and functionality for the hledger accounting tools

Safe Haskell | None
Language | Haskell2010

Hledger.Data.Posting

Contents

- Posting
- operations
- date operations
- account name operations
- transaction description operations
- arithmetic
- rendering
- misc.
- Orphan instances

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

- nullposting :: Posting
- posting :: Posting
- post :: AccountName -> Amount -> Posting
- originalPosting :: Posting -> Posting
- postingStatus :: Posting -> ClearedStatus
- isReal :: Posting -> Bool
- isVirtual :: Posting -> Bool
- isBalancedVirtual :: Posting -> Bool
- isEmptyPosting :: Posting -> Bool
- isAssignment :: Posting -> Bool
- hasAmount :: Posting -> Bool
- postingAllTags :: Posting -> [Tag]
- transactionAllTags :: Transaction -> [Tag]
- postingAllImplicitTags :: Posting -> [Tag]
- relatedPostings :: Posting -> [Posting]
- removePrices :: Posting -> Posting
- postingDate :: Posting -> Day
- postingDate2 :: Posting -> Day
- isPostingInDateSpan :: DateSpan -> Posting -> Bool
- isPostingInDateSpan' :: WhichDate -> DateSpan -> Posting -> Bool
- postingsDateSpan :: [Posting] -> DateSpan
- postingsDateSpan' :: WhichDate -> [Posting] -> DateSpan
- accountNamesFromPostings :: [Posting] -> [AccountName]
- accountNamePostingType :: AccountName -> PostingType
- accountNameWithoutPostingType :: AccountName -> AccountName
- accountNameWithPostingType :: PostingType -> AccountName -> AccountName
- joinAccountNames :: AccountName -> AccountName -> AccountName
- concatAccountNames :: [AccountName] -> AccountName
- accountNameApplyAliases :: [AccountAlias] -> AccountName -> AccountName
- accountNameApplyAliasesMemo :: [AccountAlias] -> AccountName -> AccountName
- transactionPayee :: Transaction -> Text
- transactionNote :: Transaction -> Text
- payeeAndNoteFromDescription :: Text -> (Text, Text)
- sumPostings :: [Posting] -> MixedAmount
- showPosting :: Posting -> String
- showComment :: Text -> String
- tests_Hledger_Data_Posting :: Test

# Posting

nullposting :: Posting Source #

posting :: Posting Source #

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

# operations

originalPosting :: Posting -> Posting Source #

postingStatus :: Posting -> ClearedStatus Source #

Get a posting's cleared status: cleared or pending if those are explicitly set, otherwise the cleared status of its parent transaction, or uncleared if there is no parent transaction. (Note Uncleared's ambiguity, it can mean "uncleared" or "don't know".

isReal :: Posting -> Bool Source #

isVirtual :: Posting -> Bool Source #

isBalancedVirtual :: Posting -> Bool Source #

isEmptyPosting :: Posting -> Bool Source #

isAssignment :: Posting -> Bool Source #

hasAmount :: Posting -> Bool Source #

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.

postingAllImplicitTags :: Posting -> [Tag] Source #

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

relatedPostings :: Posting -> [Posting] Source #

removePrices :: Posting -> Posting Source #

Remove all prices of a posting

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

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

postingsDateSpan :: [Posting] -> DateSpan Source #

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

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

# account name operations

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

accountNamePostingType :: AccountName -> PostingType Source #

accountNameWithoutPostingType :: AccountName -> AccountName Source #

accountNameWithPostingType :: PostingType -> AccountName -> AccountName Source #

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

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

Memoising version of accountNameApplyAliases, maybe overkill.

# transaction description operations

transactionPayee :: Transaction -> Text Source #

transactionNote :: Transaction -> Text Source #

payeeAndNoteFromDescription :: Text -> (Text, Text) Source #

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

# rendering

showPosting :: Posting -> String Source #

# misc.

showComment :: Text -> String Source #

tests_Hledger_Data_Posting :: Test Source #

# Orphan instances

Show Posting Source # |
Methods showsPrec :: Int -> Posting -> ShowS # show :: Posting -> String # showList :: [Posting] -> ShowS #