Documentation

Fields

• aname :: AccountName

  this account's full name

• adeclarationinfo :: Maybe AccountDeclarationInfo

  optional extra info from account directives relationships in the tree

• asubs :: [Account]

  this account's sub-accounts

• aparent :: Maybe Account

  parent account

• aboring :: Bool

  used in the accounts report to label elidable parents balance information

• anumpostings :: Int

  the number of postings to this account

• aebalance :: MixedAmount

  this account's balance, excluding subaccounts

• aibalance :: MixedAmount

  this account's balance, including subaccounts

Fields

• acommodity :: !CommoditySymbol
   
• aquantity :: !Quantity
   
• astyle :: !AmountStyle
   
• acost :: !(Maybe AmountCost)

  the (fixed, transaction-specific) cost in another commodity of this amount, if any

Fields

• jparsedefaultyear :: Maybe Year

  the current default year, specified by the most recent Y directive (or current date)

• jparsedefaultcommodity :: Maybe (CommoditySymbol, AmountStyle)

  the current default commodity and its format, specified by the most recent D directive

• jparsedecimalmark :: Maybe DecimalMark

  the character to always parse as decimal point, if set by CsvReader's decimal-mark (or a future journal directive)

• jparseparentaccounts :: [AccountName]

  the current stack of parent account names, specified by apply account directives

• jparsealiases :: [AccountAlias]

  the current account name aliases in effect, specified by alias directives (& options ?) ,jparsetransactioncount :: Integer -- ^ the current count of transactions parsed so far (only journal format txns, currently)

• jparsetimeclockentries :: [TimeclockEntry]

  timeclock sessions which have not been clocked out

• jincludefilestack :: [FilePath]
   
• jdeclaredpayees :: [(Payee, PayeeDeclarationInfo)]

  Payees declared by payee directives, in parse order.

• jdeclaredtags :: [(TagName, TagDeclarationInfo)]

  Tags declared by tag directives, in parse order.

• jdeclaredaccounts :: [(AccountName, AccountDeclarationInfo)]

  Accounts declared by account directives, in parse order.

• jdeclaredaccounttags :: Map AccountName [Tag]

  Accounts which were declared with tags, and those tags.

• jdeclaredaccounttypes :: Map AccountType [AccountName]

  Accounts which were declared with a type: tag, grouped by the type.

• jaccounttypes :: Map AccountName AccountType

  All the account types known, from account declarations or account names or parent accounts.

• jdeclaredcommodities :: Map CommoditySymbol Commodity

  Commodities (and their display styles) declared by commodity directives, in parse order.

• jinferredcommoditystyles :: Map CommoditySymbol AmountStyle

  Commodity display styles inferred from amounts in the journal.

• jglobalcommoditystyles :: Map CommoditySymbol AmountStyle

  Commodity display styles declared by command line options (sometimes augmented, see the import command).

• jpricedirectives :: [PriceDirective]

  P (market price) directives in the journal, in parse order.

• jinferredmarketprices :: [MarketPrice]

  Market prices inferred from transactions in the journal, in parse order.

• jtxnmodifiers :: [TransactionModifier]

  Auto posting rules declared in the journal.

• jperiodictxns :: [PeriodicTransaction]

  Periodic transaction rules declared in the journal.

• jtxns :: [Transaction]

  Transactions recorded in the journal. The important bit.

• jfinalcommentlines :: Text

  any final trailing comments in the (main) journal file

• jfiles :: [(FilePath, Text)]

  the file path and raw text of the main and any included journal files. The main file is first, followed by any included files in the order encountered. TODO: FilePath is a sloppy type here, don't assume it's a real file; values like "" or "-" can be seen

• jlastreadtime :: POSIXTime

  when this journal was last read from its file(s) NOTE: after adding new fields, eg involving account names, consider updating the Anon instance in Hleger.Cli.Anon

Fields

• ljournal :: Journal
   
• laccounts :: [Account]
   

Fields

• ptperiodexpr :: Text

  the period expression as written

• ptinterval :: Interval

  the interval at which this transaction recurs

• ptspan :: DateSpan

  the (possibly unbounded) period during which this transaction recurs. Contains a whole number of intervals.

• ptsourcepos :: (SourcePos, SourcePos)

  the file position where the period expression starts, and where the last posting ends

• ptstatus :: Status

  some of Transaction's fields

• ptcode :: Text
   
• ptdescription :: Text
   
• ptcomment :: Text
   
• pttags :: [Tag]
   
• ptpostings :: [Posting]
   

Fields

• pdate :: Maybe Day

  this posting's date, if different from the transaction's

• pdate2 :: Maybe Day

  this posting's secondary date, if different from the transaction's

• pstatus :: Status
   
• paccount :: AccountName
   
• pamount :: MixedAmount
   
• pcomment :: Text

  this posting's comment lines, as a single non-indented multi-line string

• ptype :: PostingType
   
• ptags :: [Tag]

  tag names and values, extracted from the posting comment and (after finalisation) the posting account's directive if any

• pbalanceassertion :: Maybe BalanceAssertion

  an expected balance in the account after this posting, in a single commodity, excluding subaccounts.

• ptransaction :: Maybe Transaction

  this posting's parent transaction (co-recursive types). Tying this knot gets tedious, Maybe makes it easier/optional.

• poriginal :: Maybe Posting

  When this posting has been transformed in some way (eg its amount or cost was inferred, or the account name was changed by a pivot or budget report), this references the original untransformed posting (which will have Nothing in this field).

Fields

• tindex :: Integer

  this transaction's 1-based position in the transaction stream, or 0 when not available

• tprecedingcomment :: Text

  any comment lines immediately preceding this transaction

• tsourcepos :: (SourcePos, SourcePos)

  the file position where the date starts, and where the last posting ends

• tdate :: Day
   
• tdate2 :: Maybe Day
   
• tstatus :: Status
   
• tcode :: Text
   
• tdescription :: Text
   
• tcomment :: Text

  this transaction's comment lines, as a single non-indented multi-line string

• ttags :: [Tag]

  tag names and values, extracted from the comment

• tpostings :: [Posting]

  this transaction's postings