hledger-lib-1.32.3: A library providing the core functionality of hledger

Safe Haskell | Safe-Inferred
Language | Haskell2010

Hledger.Data

Description

The Hledger.Data library allows parsing and querying of C++ ledger-style journal files. It generally provides a compatible subset of C++ ledger's functionality. This package re-exports all the Hledger.Data.* modules (except UTF8, which requires an explicit import.)

Synopsis

- module Hledger.Data.Account
- module Hledger.Data.AccountName
- module Hledger.Data.Amount
- module Hledger.Data.Balancing
- module Hledger.Data.Dates
- module Hledger.Data.Errors
- module Hledger.Data.Journal
- module Hledger.Data.JournalChecks
- module Hledger.Data.Json
- module Hledger.Data.Ledger
- module Hledger.Data.Period
- module Hledger.Data.PeriodicTransaction
- module Hledger.Data.Posting
- module Hledger.Data.RawOptions
- module Hledger.Data.StringFormat
- module Hledger.Data.Timeclock
- module Hledger.Data.Transaction
- module Hledger.Data.TransactionModifier
- type Year = Integer
- type Tag = (TagName, TagValue)
- data Status
  - = Unmarked
  - | Pending
  - | Cleared
- type YearDay = Int
- type Month = Int
- type MonthDay = Int
- type Quarter = Int
- data Account = Account {
  - aname :: AccountName
  - adeclarationinfo :: Maybe AccountDeclarationInfo
  - asubs :: [Account]
  - aparent :: Maybe Account
  - aboring :: Bool
  - anumpostings :: Int
  - aebalance :: MixedAmount
  - aibalance :: MixedAmount
  }
- type AccountName = Text
- data Amount = Amount {
  - acommodity :: !CommoditySymbol
  - aquantity :: !Quantity
  - astyle :: !AmountStyle
  - aprice :: !(Maybe AmountPrice)
  }
- data Journal = Journal {
  - jparsedefaultyear :: Maybe Year
  - jparsedefaultcommodity :: Maybe (CommoditySymbol, AmountStyle)
  - jparsedecimalmark :: Maybe DecimalMark
  - jparseparentaccounts :: [AccountName]
  - jparsealiases :: [AccountAlias]
  - jparsetimeclockentries :: [TimeclockEntry]
  - jincludefilestack :: [FilePath]
  - jdeclaredpayees :: [(Payee, PayeeDeclarationInfo)]
  - jdeclaredtags :: [(TagName, TagDeclarationInfo)]
  - jdeclaredaccounts :: [(AccountName, AccountDeclarationInfo)]
  - jdeclaredaccounttags :: Map AccountName [Tag]
  - jdeclaredaccounttypes :: Map AccountType [AccountName]
  - jaccounttypes :: Map AccountName AccountType
  - jglobalcommoditystyles :: Map CommoditySymbol AmountStyle
  - jcommodities :: Map CommoditySymbol Commodity
  - jinferredcommodities :: Map CommoditySymbol AmountStyle
  - jpricedirectives :: [PriceDirective]
  - jinferredmarketprices :: [MarketPrice]
  - jtxnmodifiers :: [TransactionModifier]
  - jperiodictxns :: [PeriodicTransaction]
  - jtxns :: [Transaction]
  - jfinalcommentlines :: Text
  - jfiles :: [(FilePath, Text)]
  - jlastreadtime :: POSIXTime
  }
- data Ledger = Ledger {
  - ljournal :: Journal
  - laccounts :: [Account]
  }
- data Period
  - = DayPeriod Day
  - | WeekPeriod Day
  - | MonthPeriod Year Month
  - | QuarterPeriod Year Quarter
  - | YearPeriod Year
  - | PeriodBetween Day Day
  - | PeriodFrom Day
  - | PeriodTo Day
  - | PeriodAll
- data PeriodicTransaction = PeriodicTransaction {
  - ptperiodexpr :: Text
  - ptinterval :: Interval
  - ptspan :: DateSpan
  - ptsourcepos :: (SourcePos, SourcePos)
  - ptstatus :: Status
  - ptcode :: Text
  - ptdescription :: Text
  - ptcomment :: Text
  - pttags :: [Tag]
  - ptpostings :: [Posting]
  }
- data Posting = Posting {
  - pdate :: Maybe Day
  - pdate2 :: Maybe Day
  - pstatus :: Status
  - paccount :: AccountName
  - pamount :: MixedAmount
  - pcomment :: Text
  - ptype :: PostingType
  - ptags :: [Tag]
  - pbalanceassertion :: Maybe BalanceAssertion
  - ptransaction :: Maybe Transaction
  - poriginal :: Maybe Posting
  }
- data Transaction = Transaction {
  - tindex :: Integer
  - tprecedingcomment :: Text
  - tsourcepos :: (SourcePos, SourcePos)
  - tdate :: Day
  - tdate2 :: Maybe Day
  - tstatus :: Status
  - tcode :: Text
  - tdescription :: Text
  - tcomment :: Text
  - ttags :: [Tag]
  - tpostings :: [Posting]
  }
- data TransactionModifier = TransactionModifier {
  - tmquerytxt :: Text
  - tmpostingrules :: [TMPostingRule]
  }
- type YearWeek = Int
- type MonthWeek = Int
- type WeekDay = Int
- data SmartDate
  - = SmartCompleteDate Day
  - | SmartAssumeStart Year (Maybe Month)
  - | SmartFromReference (Maybe Month) MonthDay
  - | SmartMonth Month
  - | SmartRelative Integer SmartInterval
- data SmartInterval
  - = Day
  - | Week
  - | Month
  - | Quarter
  - | Year
- data WhichDate
  - = PrimaryDate
  - | SecondaryDate
- data EFDay
  - = Exact Day
  - | Flex Day
- data DateSpan = DateSpan (Maybe EFDay) (Maybe EFDay)
- data Interval
  - = NoInterval
  - | Days Int
  - | Weeks Int
  - | Months Int
  - | Quarters Int
  - | Years Int
  - | DayOfMonth Int
  - | WeekdayOfMonth Int Int
  - | DaysOfWeek [Int]
  - | DayOfYear Int Int
- type Payee = Text
- data AccountType
  - = Asset
  - | Liability
  - | Equity
  - | Revenue
  - | Expense
  - | Cash
  - | Conversion
- data AccountAlias
  - = BasicAlias AccountName AccountName
  - | RegexAlias Regexp Replacement
- data Side
  - = L
  - | R
- type DecimalMark = Char
- type Quantity = Decimal
- data AmountPrice
  - = UnitPrice !Amount
  - | TotalPrice !Amount
- data AmountStyle = AmountStyle {
  - ascommodityside :: !Side
  - ascommodityspaced :: !Bool
  - asdigitgroups :: !(Maybe DigitGroupStyle)
  - asdecimalmark :: !(Maybe Char)
  - asprecision :: !AmountPrecision
  - asrounding :: !Rounding
  }
- data DigitGroupStyle = DigitGroups !Char ![Word8]
- data AmountPrecision
  - = Precision !Word8
  - | NaturalPrecision
- data Rounding
  - = NoRounding
  - | SoftRounding
  - | HardRounding
  - | AllRounding
- type CommoditySymbol = Text
- data Commodity = Commodity {
  - csymbol :: CommoditySymbol
  - cformat :: Maybe AmountStyle
  }
- class HasAmounts a where
  - styleAmounts :: Map CommoditySymbol AmountStyle -> a -> a
- data MixedAmount
- data PostingType
  - = RegularPosting
  - | VirtualPosting
  - | BalancedVirtualPosting
- type TagName = Text
- type TagValue = Text
- type DateTag = (TagName, Day)
- data BalanceAssertion = BalanceAssertion {
  - baamount :: Amount
  - batotal :: Bool
  - bainclusive :: Bool
  - baposition :: SourcePos
  }
- data TMPostingRule = TMPostingRule {
  - tmprPosting :: Posting
  - tmprIsMultiplier :: Bool
  }
- data TimeclockCode
  - = SetBalance
  - | SetRequiredHours
  - | In
  - | Out
  - | FinalOut
- data TimeclockEntry = TimeclockEntry {
  - tlsourcepos :: SourcePos
  - tlcode :: TimeclockCode
  - tldatetime :: LocalTime
  - tlaccount :: AccountName
  - tldescription :: Text
  - tlcomment :: Text
  - tltags :: [Tag]
  }
- data PriceDirective = PriceDirective {
  - pddate :: Day
  - pdcommodity :: CommoditySymbol
  - pdamount :: Amount
  }
- data MarketPrice = MarketPrice {
  - mpdate :: Day
  - mpfrom :: CommoditySymbol
  - mpto :: CommoditySymbol
  - mprate :: Quantity
  }
- data PayeeDeclarationInfo = PayeeDeclarationInfo {
  - pdicomment :: Text
  - pditags :: [Tag]
  }
- newtype TagDeclarationInfo = TagDeclarationInfo {
  - tdicomment :: Text
  }
- data AccountDeclarationInfo = AccountDeclarationInfo {
  - adicomment :: Text
  - aditags :: [Tag]
  - adideclarationorder :: Int
  - adisourcepos :: SourcePos
  }
- type ParsedJournal = Journal
- type StorageFormat = String
- data NormalSign
  - = NormallyPositive
  - | NormallyNegative
- pattern MixedAmountKeyNoPrice :: !CommoditySymbol -> MixedAmountKey
- pattern MixedAmountKeyTotalPrice :: !CommoditySymbol -> !CommoditySymbol -> MixedAmountKey
- pattern MixedAmountKeyUnitPrice :: !CommoditySymbol -> !CommoditySymbol -> !Quantity -> MixedAmountKey
- fromEFDay :: EFDay -> Day
- modifyEFDay :: (Day -> Day) -> EFDay -> EFDay
- isBalanceSheetAccountType :: AccountType -> Bool
- isIncomeStatementAccountType :: AccountType -> Bool
- isAccountSubtypeOf :: AccountType -> AccountType -> Bool
- isDecimalMark :: Char -> Bool
- maCompare :: MixedAmount -> MixedAmount -> Ordering
- nulltransactionmodifier :: TransactionModifier
- nullperiodictransaction :: PeriodicTransaction
- nullpayeedeclarationinfo :: PayeeDeclarationInfo
- nulltagdeclarationinfo :: TagDeclarationInfo
- nullaccountdeclarationinfo :: AccountDeclarationInfo
- module Hledger.Data.Valuation
- tests_Data :: TestTree

# Documentation

module Hledger.Data.Account

module Hledger.Data.AccountName

module Hledger.Data.Amount

module Hledger.Data.Balancing

module Hledger.Data.Dates

module Hledger.Data.Errors

module Hledger.Data.Journal

module Hledger.Data.JournalChecks

module Hledger.Data.Json

module Hledger.Data.Ledger

module Hledger.Data.Period

module Hledger.Data.PeriodicTransaction

module Hledger.Data.Posting

module Hledger.Data.RawOptions

module Hledger.Data.StringFormat

module Hledger.Data.Timeclock

module Hledger.Data.Transaction

module Hledger.Data.TransactionModifier

type Year = Integer Source #

Year of Common Era (when positive).

type Tag Source #

Arguments

= (TagName, TagValue) | A tag name and (possibly empty) value.

data Status Source #

The status of a transaction or posting, recorded with a status mark (nothing, !, or *). What these mean is ultimately user defined.

Constructors

Unmarked |
Pending |
Cleared |

#### Instances

Instances details

FromJSON Status Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Status Source # parseJSONList :: Value -> Parser [Status] Source #
ToJSON Status Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Status -> Value Source # toEncoding :: Status -> Encoding Source # toJSONList :: [Status] -> Value Source # toEncodingList :: [Status] -> Encoding Source #
Bounded Status Source # |
Instance details Defined in Hledger.Data.Types Methods minBound :: Status Source # maxBound :: Status Source #
Enum Status Source # |

Instance details

Defined in Hledger.Data.Types

Methods

succ :: Status -> Status Source #

pred :: Status -> Status Source #

toEnum :: Int -> Status Source #

fromEnum :: Status -> Int Source #

enumFrom :: Status -> [Status] Source #

enumFromThen :: Status -> Status -> [Status] Source #

enumFromTo :: Status -> Status -> [Status] Source #

enumFromThenTo :: Status -> Status -> Status -> [Status] Source #

Generic Status Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Status :: Type -> Type Source # Methods from :: Status -> Rep Status x Source # to :: Rep Status x -> Status Source #
Show Status Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Status -> ShowS Source # show :: Status -> String Source # showList :: [Status] -> ShowS Source #
Eq Status Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Status -> Status -> Bool Source # (/=) :: Status -> Status -> Bool Source #
Ord Status Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Status -> Status -> Ordering Source # (<) :: Status -> Status -> Bool Source # (<=) :: Status -> Status -> Bool Source # (>) :: Status -> Status -> Bool Source # (>=) :: Status -> Status -> Bool Source # max :: Status -> Status -> Status Source # min :: Status -> Status -> Status Source #
type Rep Status Source # |
Instance details Defined in Hledger.Data.Types type Rep Status = D1 ('MetaData "Status" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Unmarked" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Pending" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Cleared" 'PrefixI 'False) (U1 :: Type -> Type)))

type YearDay = Int Source #

type Month = Int Source #

type MonthDay = Int Source #

type Quarter = Int Source #

data Account Source #

An account, with its balances, parent/subaccount relationships, etc. Only the name is required; the other fields are added when needed.

Constructors

Account |

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

#### Instances

Instances details

FromJSON Account Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Account Source # parseJSONList :: Value -> Parser [Account] Source #
ToJSON Account Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Account -> Value Source # toEncoding :: Account -> Encoding Source # toJSONList :: [Account] -> Value Source # toEncodingList :: [Account] -> Encoding Source #
Generic Account Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Account :: Type -> Type Source # Methods from :: Account -> Rep Account x Source # to :: Rep Account x -> Account Source #
Show Account Source # |
Instance details Defined in Hledger.Data.Account Methods showsPrec :: Int -> Account -> ShowS Source # show :: Account -> String Source # showList :: [Account] -> ShowS Source #
Eq Account Source # |
Instance details Defined in Hledger.Data.Account Methods (==) :: Account -> Account -> Bool Source # (/=) :: Account -> Account -> Bool Source #
HasAmounts Account Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Account -> Account Source #
type Rep Account Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Account = D1 ('MetaData "Account" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: S1 ('MetaSel ('Just "adeclarationinfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AccountDeclarationInfo))) :*: (S1 ('MetaSel ('Just "asubs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Account]) :*: S1 ('MetaSel ('Just "aparent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Account)))) :*: ((S1 ('MetaSel ('Just "aboring") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "anumpostings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "aebalance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MixedAmount) :*: S1 ('MetaSel ('Just "aibalance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MixedAmount)))))

type AccountName = Text Source #

data Amount Source #

Constructors

Amount |

Fields

- acommodity :: !CommoditySymbol
- aquantity :: !Quantity
- astyle :: !AmountStyle
- aprice :: !(Maybe AmountPrice)

  the (fixed, transaction-specific) price for this amount, if any

#### Instances

Instances details

FromJSON Amount Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Amount Source # parseJSONList :: Value -> Parser [Amount] Source #
ToJSON Amount Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Amount -> Value Source # toEncoding :: Amount -> Encoding Source # toJSONList :: [Amount] -> Value Source # toEncodingList :: [Amount] -> Encoding Source #
Generic Amount Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Amount :: Type -> Type Source # Methods from :: Amount -> Rep Amount x Source # to :: Rep Amount x -> Amount Source #
Num Amount Source # |
Instance details Defined in Hledger.Data.Amount Methods (+) :: Amount -> Amount -> Amount Source # (-) :: Amount -> Amount -> Amount Source # (*) :: Amount -> Amount -> Amount Source # negate :: Amount -> Amount Source # abs :: Amount -> Amount Source # signum :: Amount -> Amount Source # fromInteger :: Integer -> Amount Source #
Show Amount Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Amount -> ShowS Source # show :: Amount -> String Source # showList :: [Amount] -> ShowS Source #
Eq Amount Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Amount -> Amount -> Bool Source # (/=) :: Amount -> Amount -> Bool Source #
Ord Amount Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Amount -> Amount -> Ordering Source # (<) :: Amount -> Amount -> Bool Source # (<=) :: Amount -> Amount -> Bool Source # (>) :: Amount -> Amount -> Bool Source # (>=) :: Amount -> Amount -> Bool Source # max :: Amount -> Amount -> Amount Source # min :: Amount -> Amount -> Amount Source #
HasAmounts Amount Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Amount -> Amount Source #
type Rep Amount Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Amount = D1 ('MetaData "Amount" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Amount" 'PrefixI 'True) ((S1 ('MetaSel ('Just "acommodity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CommoditySymbol) :*: S1 ('MetaSel ('Just "aquantity") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Quantity)) :*: (S1 ('MetaSel ('Just "astyle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AmountStyle) :*: S1 ('MetaSel ('Just "aprice") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe AmountPrice)))))

data Journal Source #

A Journal, containing transactions and various other things. The basic data model for hledger.

This is used during parsing (as the type alias ParsedJournal), and then finalised/validated for use as a Journal. Some extra parsing-related fields are included for convenience, at least for now. In a ParsedJournal these are updated as parsing proceeds, in a Journal they represent the final state at end of parsing (used eg by the add command).

Constructors

Journal |

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 (after journal finalisation)

- jdeclaredtags :: [(TagName, TagDeclarationInfo)]

  Tags declared by tag directives, in parse order (after journal finalisation)

- jdeclaredaccounts :: [(AccountName, AccountDeclarationInfo)]

  Accounts declared by account directives, in parse order (after journal finalisation)

- jdeclaredaccounttags :: Map AccountName [Tag]

  Accounts which have tags declared in their directives, and those tags. (Does not include parents' tags.)

- jdeclaredaccounttypes :: Map AccountType [AccountName]

  Accounts whose type has been explicitly declared in their account directives, grouped by type.

- jaccounttypes :: Map AccountName AccountType

  All accounts for which a type has been declared or can be inferred from its parent or its name.

- jglobalcommoditystyles :: Map CommoditySymbol AmountStyle

  per-commodity display styles declared globally, eg by command line option or import command

- jcommodities :: Map CommoditySymbol Commodity

  commodities and formats declared by commodity directives

- jinferredcommodities :: Map CommoditySymbol AmountStyle

  commodities and formats inferred from journal amounts

- jpricedirectives :: [PriceDirective]

  Declarations of market prices by P directives, in parse order (after journal finalisation)

- jinferredmarketprices :: [MarketPrice]

  Market prices implied by transactions, in parse order (after journal finalisation)

- jtxnmodifiers :: [TransactionModifier]
- jperiodictxns :: [PeriodicTransaction]
- jtxns :: [Transaction]
- 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 "", "-", "(string)" 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

#### Instances

Instances details

ToJSON Journal Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Journal -> Value Source # toEncoding :: Journal -> Encoding Source # toJSONList :: [Journal] -> Value Source # toEncodingList :: [Journal] -> Encoding Source #
Semigroup Journal Source # |
Instance details Defined in Hledger.Data.Journal Methods (<>) :: Journal -> Journal -> Journal Source # sconcat :: NonEmpty Journal -> Journal Source # stimes :: Integral b => b -> Journal -> Journal Source #
Generic Journal Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Journal :: Type -> Type Source # Methods from :: Journal -> Rep Journal x Source # to :: Rep Journal x -> Journal Source #
Show Journal Source # |
Instance details Defined in Hledger.Data.Journal Methods showsPrec :: Int -> Journal -> ShowS Source # show :: Journal -> String Source # showList :: [Journal] -> ShowS Source #
Default Journal Source # |
Instance details Defined in Hledger.Data.Journal Methods def :: Journal #
Eq Journal Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Journal -> Journal -> Bool Source # (/=) :: Journal -> Journal -> Bool Source #
type Rep Journal Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Journal = D1 ('MetaData "Journal" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Journal" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "jparsedefaultyear") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Year)) :*: (S1 ('MetaSel ('Just "jparsedefaultcommodity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (CommoditySymbol, AmountStyle))) :*: S1 ('MetaSel ('Just "jparsedecimalmark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DecimalMark)))) :*: (S1 ('MetaSel ('Just "jparseparentaccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AccountName]) :*: (S1 ('MetaSel ('Just "jparsealiases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AccountAlias]) :*: S1 ('MetaSel ('Just "jparsetimeclockentries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TimeclockEntry])))) :*: ((S1 ('MetaSel ('Just "jincludefilestack") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath]) :*: (S1 ('MetaSel ('Just "jdeclaredpayees") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(Payee, PayeeDeclarationInfo)]) :*: S1 ('MetaSel ('Just "jdeclaredtags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(TagName, TagDeclarationInfo)]))) :*: (S1 ('MetaSel ('Just "jdeclaredaccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(AccountName, AccountDeclarationInfo)]) :*: (S1 ('MetaSel ('Just "jdeclaredaccounttags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map AccountName [Tag])) :*: S1 ('MetaSel ('Just "jdeclaredaccounttypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map AccountType [AccountName])))))) :*: (((S1 ('MetaSel ('Just "jaccounttypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map AccountName AccountType)) :*: (S1 ('MetaSel ('Just "jglobalcommoditystyles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map CommoditySymbol AmountStyle)) :*: S1 ('MetaSel ('Just "jcommodities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map CommoditySymbol Commodity)))) :*: (S1 ('MetaSel ('Just "jinferredcommodities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map CommoditySymbol AmountStyle)) :*: (S1 ('MetaSel ('Just "jpricedirectives") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PriceDirective]) :*: S1 ('MetaSel ('Just "jinferredmarketprices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [MarketPrice])))) :*: ((S1 ('MetaSel ('Just "jtxnmodifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TransactionModifier]) :*: (S1 ('MetaSel ('Just "jperiodictxns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PeriodicTransaction]) :*: S1 ('MetaSel ('Just "jtxns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Transaction]))) :*: (S1 ('MetaSel ('Just "jfinalcommentlines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "jfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(FilePath, Text)]) :*: S1 ('MetaSel ('Just "jlastreadtime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)))))))

data Ledger Source #

A Ledger has the journal it derives from, and the accounts derived from that. Accounts are accessible both list-wise and tree-wise, since each one knows its parent and subs; the first account is the root of the tree and always exists.

Constructors

Ledger |

Fields

- ljournal :: Journal
- laccounts :: [Account]

#### Instances

Instances details

ToJSON Ledger Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Ledger -> Value Source # toEncoding :: Ledger -> Encoding Source # toJSONList :: [Ledger] -> Value Source # toEncodingList :: [Ledger] -> Encoding Source #
Generic Ledger Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Ledger :: Type -> Type Source # Methods from :: Ledger -> Rep Ledger x Source # to :: Rep Ledger x -> Ledger Source #
Show Ledger Source # |
Instance details Defined in Hledger.Data.Ledger Methods showsPrec :: Int -> Ledger -> ShowS Source # show :: Ledger -> String Source # showList :: [Ledger] -> ShowS Source #
type Rep Ledger Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Ledger = D1 ('MetaData "Ledger" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Ledger" 'PrefixI 'True) (S1 ('MetaSel ('Just "ljournal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Journal) :*: S1 ('MetaSel ('Just "laccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Account])))

data Period Source #

Constructors

DayPeriod Day |
WeekPeriod Day |
MonthPeriod Year Month |
QuarterPeriod Year Quarter |
YearPeriod Year |
PeriodBetween Day Day |
PeriodFrom Day |
PeriodTo Day |
PeriodAll |

#### Instances

Instances details

ToJSON Period Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Period -> Value Source # toEncoding :: Period -> Encoding Source # toJSONList :: [Period] -> Value Source # toEncodingList :: [Period] -> Encoding Source #
Generic Period Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Period :: Type -> Type Source # Methods from :: Period -> Rep Period x Source # to :: Rep Period x -> Period Source #
Show Period Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Period -> ShowS Source # show :: Period -> String Source # showList :: [Period] -> ShowS Source #
Default Period Source # |
Instance details Defined in Hledger.Data.Types Methods def :: Period #
Eq Period Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Period -> Period -> Bool Source # (/=) :: Period -> Period -> Bool Source #
Ord Period Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Period -> Period -> Ordering Source # (<) :: Period -> Period -> Bool Source # (<=) :: Period -> Period -> Bool Source # (>) :: Period -> Period -> Bool Source # (>=) :: Period -> Period -> Bool Source # max :: Period -> Period -> Period Source # min :: Period -> Period -> Period Source #
HasAmounts PostingsReportItem Source # |
Instance details Defined in Hledger.Reports.PostingsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PostingsReportItem -> PostingsReportItem Source #
type Rep Period Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Period = D1 ('MetaData "Period" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (((C1 ('MetaCons "DayPeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day)) :+: C1 ('MetaCons "WeekPeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day))) :+: (C1 ('MetaCons "MonthPeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Year) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Month)) :+: C1 ('MetaCons "QuarterPeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Year) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Quarter)))) :+: ((C1 ('MetaCons "YearPeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Year)) :+: C1 ('MetaCons "PeriodBetween" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day))) :+: (C1 ('MetaCons "PeriodFrom" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day)) :+: (C1 ('MetaCons "PeriodTo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day)) :+: C1 ('MetaCons "PeriodAll" 'PrefixI 'False) (U1 :: Type -> Type)))))

data PeriodicTransaction Source #

A periodic transaction rule, describing a transaction that recurs.

Constructors

PeriodicTransaction |

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]

#### Instances

Instances details

ToJSON PeriodicTransaction Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: PeriodicTransaction -> Value Source # toEncoding :: PeriodicTransaction -> Encoding Source # toJSONList :: [PeriodicTransaction] -> Value Source # toEncodingList :: [PeriodicTransaction] -> Encoding Source #
Generic PeriodicTransaction Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep PeriodicTransaction :: Type -> Type Source # Methods from :: PeriodicTransaction -> Rep PeriodicTransaction x Source # to :: Rep PeriodicTransaction x -> PeriodicTransaction Source #
Show PeriodicTransaction Source # |
Instance details Defined in Hledger.Data.PeriodicTransaction Methods showsPrec :: Int -> PeriodicTransaction -> ShowS Source # show :: PeriodicTransaction -> String Source # showList :: [PeriodicTransaction] -> ShowS Source #
Eq PeriodicTransaction Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: PeriodicTransaction -> PeriodicTransaction -> Bool Source # (/=) :: PeriodicTransaction -> PeriodicTransaction -> Bool Source #
type Rep PeriodicTransaction Source # |

Instance details

Defined in Hledger.Data.Types

type Rep PeriodicTransaction = D1 ('MetaData "PeriodicTransaction" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "PeriodicTransaction" 'PrefixI 'True) (((S1 ('MetaSel ('Just "ptperiodexpr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "ptinterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Interval)) :*: (S1 ('MetaSel ('Just "ptspan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DateSpan) :*: (S1 ('MetaSel ('Just "ptsourcepos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SourcePos, SourcePos)) :*: S1 ('MetaSel ('Just "ptstatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status)))) :*: ((S1 ('MetaSel ('Just "ptcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "ptdescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "ptcomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pttags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag]) :*: S1 ('MetaSel ('Just "ptpostings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Posting]))))))

data Posting Source #

Constructors

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

#### Instances

Instances details

FromJSON Posting Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Posting Source # parseJSONList :: Value -> Parser [Posting] Source #
ToJSON Posting Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Posting -> Value Source # toEncoding :: Posting -> Encoding Source # toJSONList :: [Posting] -> Value Source # toEncodingList :: [Posting] -> Encoding Source #
Generic Posting Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Posting :: Type -> Type Source # Methods from :: Posting -> Rep Posting x Source # to :: Rep Posting x -> Posting Source #
Show Posting Source # | Posting's show instance elides the parent transaction so as not to recurse forever.
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Posting -> ShowS Source # show :: Posting -> String Source # showList :: [Posting] -> ShowS Source #
Eq Posting Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Posting -> Posting -> Bool Source # (/=) :: Posting -> Posting -> Bool Source #
HasAmounts Posting Source # |
Instance details Defined in Hledger.Data.Posting Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Posting -> Posting Source #
HasAmounts PostingsReportItem Source # |
Instance details Defined in Hledger.Reports.PostingsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PostingsReportItem -> PostingsReportItem Source #
type Rep Posting Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Posting = D1 ('MetaData "Posting" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Posting" 'PrefixI 'True) (((S1 ('MetaSel ('Just "pdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Day)) :*: S1 ('MetaSel ('Just "pdate2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Day))) :*: (S1 ('MetaSel ('Just "pstatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: (S1 ('MetaSel ('Just "paccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: S1 ('MetaSel ('Just "pamount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MixedAmount)))) :*: ((S1 ('MetaSel ('Just "pcomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "ptype") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PostingType) :*: S1 ('MetaSel ('Just "ptags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag]))) :*: (S1 ('MetaSel ('Just "pbalanceassertion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe BalanceAssertion)) :*: (S1 ('MetaSel ('Just "ptransaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Transaction)) :*: S1 ('MetaSel ('Just "poriginal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Posting)))))))

data Transaction Source #

Constructors

Transaction |

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

#### Instances

Instances details

FromJSON Transaction Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Transaction Source # parseJSONList :: Value -> Parser [Transaction] Source #
ToJSON Transaction Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Transaction -> Value Source # toEncoding :: Transaction -> Encoding Source # toJSONList :: [Transaction] -> Value Source # toEncodingList :: [Transaction] -> Encoding Source #
Generic Transaction Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Transaction :: Type -> Type Source # Methods from :: Transaction -> Rep Transaction x Source # to :: Rep Transaction x -> Transaction Source #
Show Transaction Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Transaction -> ShowS Source # show :: Transaction -> String Source # showList :: [Transaction] -> ShowS Source #
Eq Transaction Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Transaction -> Transaction -> Bool Source # (/=) :: Transaction -> Transaction -> Bool Source #
HasAmounts Transaction Source # |
Instance details Defined in Hledger.Data.Transaction Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Transaction -> Transaction Source #
HasAmounts AccountTransactionsReportItem Source # |
Instance details Defined in Hledger.Reports.AccountTransactionsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> AccountTransactionsReportItem -> AccountTransactionsReportItem Source #
type Rep Transaction Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Transaction = D1 ('MetaData "Transaction" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Transaction" 'PrefixI 'True) (((S1 ('MetaSel ('Just "tindex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "tprecedingcomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tsourcepos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SourcePos, SourcePos)) :*: (S1 ('MetaSel ('Just "tdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day) :*: S1 ('MetaSel ('Just "tdate2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Day))))) :*: ((S1 ('MetaSel ('Just "tstatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Status) :*: (S1 ('MetaSel ('Just "tcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tdescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "tcomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "ttags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag]) :*: S1 ('MetaSel ('Just "tpostings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Posting]))))))

data TransactionModifier Source #

A transaction modifier rule. This has a query which matches postings in the journal, and a list of transformations to apply to those postings or their transactions. Currently there is one kind of transformation: the TMPostingRule, which adds a posting ("auto posting") to the transaction, optionally setting its amount to the matched posting's amount multiplied by a constant.

Constructors

TransactionModifier |

Fields

- tmquerytxt :: Text
- tmpostingrules :: [TMPostingRule]

#### Instances

Instances details

ToJSON TransactionModifier Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: TransactionModifier -> Value Source # toEncoding :: TransactionModifier -> Encoding Source # toJSONList :: [TransactionModifier] -> Value Source # toEncodingList :: [TransactionModifier] -> Encoding Source #
Generic TransactionModifier Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep TransactionModifier :: Type -> Type Source # Methods from :: TransactionModifier -> Rep TransactionModifier x Source # to :: Rep TransactionModifier x -> TransactionModifier Source #
Show TransactionModifier Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> TransactionModifier -> ShowS Source # show :: TransactionModifier -> String Source # showList :: [TransactionModifier] -> ShowS Source #
Eq TransactionModifier Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: TransactionModifier -> TransactionModifier -> Bool Source # (/=) :: TransactionModifier -> TransactionModifier -> Bool Source #
type Rep TransactionModifier Source # |

Instance details

Defined in Hledger.Data.Types

type Rep TransactionModifier = D1 ('MetaData "TransactionModifier" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "TransactionModifier" 'PrefixI 'True) (S1 ('MetaSel ('Just "tmquerytxt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tmpostingrules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TMPostingRule])))

type YearWeek = Int Source #

type MonthWeek = Int Source #

type WeekDay = Int Source #

data SmartDate Source #

A possibly incomplete year-month-day date provided by the user, to be interpreted as either a date or a date span depending on context. Missing parts "on the left" will be filled from the provided reference date, e.g. if the year and month are missing, the reference date's year and month are used. Missing parts "on the right" are assumed, when interpreting as a date, to be 1, (e.g. if the year and month are present but the day is missing, it means first day of that month); or when interpreting as a date span, to be a wildcard (so it would mean all days of that month). See the `smartdate` parser for more examples.

Or, one of the standard periods and an offset relative to the reference date: (last|this|next) (day|week|month|quarter|year), where "this" means the period containing the reference date.

Constructors

SmartCompleteDate Day |
SmartAssumeStart Year (Maybe Month) |
SmartFromReference (Maybe Month) MonthDay |
SmartMonth Month |
SmartRelative Integer SmartInterval |

#### Instances

Instances details

Show SmartDate Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> SmartDate -> ShowS Source # show :: SmartDate -> String Source # showList :: [SmartDate] -> ShowS Source #

data SmartInterval Source #

Constructors

Day |
Week |
Month |
Quarter |
Year |

#### Instances

Instances details

Show SmartInterval Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> SmartInterval -> ShowS Source # show :: SmartInterval -> String Source # showList :: [SmartInterval] -> ShowS Source #

data WhichDate Source #

Constructors

PrimaryDate |
SecondaryDate |

#### Instances

Instances details

Show WhichDate Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> WhichDate -> ShowS Source # show :: WhichDate -> String Source # showList :: [WhichDate] -> ShowS Source #
Eq WhichDate Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: WhichDate -> WhichDate -> Bool Source # (/=) :: WhichDate -> WhichDate -> Bool Source #

data EFDay Source #

A date which is either exact or flexible. Flexible dates are allowed to be adjusted in certain situations.

Constructors

Exact Day |
Flex Day |

#### Instances

Instances details

ToJSON EFDay Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: EFDay -> Value Source # toEncoding :: EFDay -> Encoding Source # toJSONList :: [EFDay] -> Value Source # toEncodingList :: [EFDay] -> Encoding Source #
Generic EFDay Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep EFDay :: Type -> Type Source # Methods from :: EFDay -> Rep EFDay x Source # to :: Rep EFDay x -> EFDay Source #
Show EFDay Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> EFDay -> ShowS Source # show :: EFDay -> String Source # showList :: [EFDay] -> ShowS Source #
Eq EFDay Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: EFDay -> EFDay -> Bool Source # (/=) :: EFDay -> EFDay -> Bool Source #
Ord EFDay Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: EFDay -> EFDay -> Ordering Source # (<) :: EFDay -> EFDay -> Bool Source # (<=) :: EFDay -> EFDay -> Bool Source # (>) :: EFDay -> EFDay -> Bool Source # (>=) :: EFDay -> EFDay -> Bool Source # max :: EFDay -> EFDay -> EFDay Source # min :: EFDay -> EFDay -> EFDay Source #
type Rep EFDay Source # |

Instance details

Defined in Hledger.Data.Types

type Rep EFDay = D1 ('MetaData "EFDay" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Exact" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day)) :+: C1 ('MetaCons "Flex" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day)))

data DateSpan Source #

A possibly open-ended span of time, from an optional inclusive start date to an optional exclusive end date. Each date can be either exact or flexible. An "exact date span" is a Datepan with exact start and end dates.

Constructors

DateSpan (Maybe EFDay) (Maybe EFDay) |

#### Instances

Instances details

ToJSON DateSpan Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: DateSpan -> Value Source # toEncoding :: DateSpan -> Encoding Source # toJSONList :: [DateSpan] -> Value Source # toEncodingList :: [DateSpan] -> Encoding Source #
Generic DateSpan Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep DateSpan :: Type -> Type Source # Methods from :: DateSpan -> Rep DateSpan x Source # to :: Rep DateSpan x -> DateSpan Source #
Show DateSpan Source # |
Instance details Defined in Hledger.Data.Dates Methods showsPrec :: Int -> DateSpan -> ShowS Source # show :: DateSpan -> String Source # showList :: [DateSpan] -> ShowS Source #
Default DateSpan Source # |
Instance details Defined in Hledger.Data.Types Methods def :: DateSpan #
Eq DateSpan Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: DateSpan -> DateSpan -> Bool Source # (/=) :: DateSpan -> DateSpan -> Bool Source #
Ord DateSpan Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: DateSpan -> DateSpan -> Ordering Source # (<) :: DateSpan -> DateSpan -> Bool Source # (<=) :: DateSpan -> DateSpan -> Bool Source # (>) :: DateSpan -> DateSpan -> Bool Source # (>=) :: DateSpan -> DateSpan -> Bool Source # max :: DateSpan -> DateSpan -> DateSpan Source # min :: DateSpan -> DateSpan -> DateSpan Source #
type Rep DateSpan Source # |

Instance details

Defined in Hledger.Data.Types

type Rep DateSpan = D1 ('MetaData "DateSpan" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "DateSpan" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EFDay)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EFDay))))

data Interval Source #

Constructors

NoInterval |
Days Int |
Weeks Int |
Months Int |
Quarters Int |
Years Int |
DayOfMonth Int |
WeekdayOfMonth Int Int |
DaysOfWeek [Int] |
DayOfYear Int Int |

#### Instances

Instances details

ToJSON Interval Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Interval -> Value Source # toEncoding :: Interval -> Encoding Source # toJSONList :: [Interval] -> Value Source # toEncodingList :: [Interval] -> Encoding Source #
Generic Interval Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Interval :: Type -> Type Source # Methods from :: Interval -> Rep Interval x Source # to :: Rep Interval x -> Interval Source #
Show Interval Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Interval -> ShowS Source # show :: Interval -> String Source # showList :: [Interval] -> ShowS Source #
Default Interval Source # |
Instance details Defined in Hledger.Data.Types Methods def :: Interval #
Eq Interval Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Interval -> Interval -> Bool Source # (/=) :: Interval -> Interval -> Bool Source #
Ord Interval Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Interval -> Interval -> Ordering Source # (<) :: Interval -> Interval -> Bool Source # (<=) :: Interval -> Interval -> Bool Source # (>) :: Interval -> Interval -> Bool Source # (>=) :: Interval -> Interval -> Bool Source # max :: Interval -> Interval -> Interval Source # min :: Interval -> Interval -> Interval Source #
type Rep Interval Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Interval = D1 ('MetaData "Interval" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (((C1 ('MetaCons "NoInterval" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Days" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "Weeks" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "Months" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "Quarters" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))) :+: ((C1 ('MetaCons "Years" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "DayOfMonth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :+: (C1 ('MetaCons "WeekdayOfMonth" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "DaysOfWeek" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int])) :+: C1 ('MetaCons "DayOfYear" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))))

type Payee = Text Source #

data AccountType Source #

Constructors

Asset |
Liability |
Equity |
Revenue |
Expense |
Cash | a subtype of Asset - liquid assets to show in cashflow report
Conversion | a subtype of Equity - account in which to generate conversion postings for transaction prices

#### Instances

Instances details

ToJSON AccountType Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AccountType -> Value Source # toEncoding :: AccountType -> Encoding Source # toJSONList :: [AccountType] -> Value Source # toEncodingList :: [AccountType] -> Encoding Source #
ToJSONKey AccountType Source # |
Instance details Defined in Hledger.Data.Json Methods toJSONKey :: ToJSONKeyFunction AccountType Source # toJSONKeyList :: ToJSONKeyFunction [AccountType] Source #
Generic AccountType Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AccountType :: Type -> Type Source # Methods from :: AccountType -> Rep AccountType x Source # to :: Rep AccountType x -> AccountType Source #
Show AccountType Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AccountType -> ShowS Source # show :: AccountType -> String Source # showList :: [AccountType] -> ShowS Source #
Eq AccountType Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AccountType -> AccountType -> Bool Source # (/=) :: AccountType -> AccountType -> Bool Source #
Ord AccountType Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: AccountType -> AccountType -> Ordering Source #

(<) :: AccountType -> AccountType -> Bool Source #

(<=) :: AccountType -> AccountType -> Bool Source #

(>) :: AccountType -> AccountType -> Bool Source #

(>=) :: AccountType -> AccountType -> Bool Source #

max :: AccountType -> AccountType -> AccountType Source #

min :: AccountType -> AccountType -> AccountType Source #

type Rep AccountType Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AccountType = D1 ('MetaData "AccountType" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) ((C1 ('MetaCons "Asset" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Liability" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Equity" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Revenue" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Expense" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Cash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Conversion" 'PrefixI 'False) (U1 :: Type -> Type))))

data AccountAlias Source #

Constructors

BasicAlias AccountName AccountName |
RegexAlias Regexp Replacement |

#### Instances

Instances details

ToJSON AccountAlias Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AccountAlias -> Value Source # toEncoding :: AccountAlias -> Encoding Source # toJSONList :: [AccountAlias] -> Value Source # toEncodingList :: [AccountAlias] -> Encoding Source #
Generic AccountAlias Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AccountAlias :: Type -> Type Source # Methods from :: AccountAlias -> Rep AccountAlias x Source # to :: Rep AccountAlias x -> AccountAlias Source #
Read AccountAlias Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS AccountAlias Source # readList :: ReadS [AccountAlias] Source # readPrec :: ReadPrec AccountAlias Source # readListPrec :: ReadPrec [AccountAlias] Source #
Show AccountAlias Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AccountAlias -> ShowS Source # show :: AccountAlias -> String Source # showList :: [AccountAlias] -> ShowS Source #
Eq AccountAlias Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AccountAlias -> AccountAlias -> Bool Source # (/=) :: AccountAlias -> AccountAlias -> Bool Source #
Ord AccountAlias Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: AccountAlias -> AccountAlias -> Ordering Source #

(<) :: AccountAlias -> AccountAlias -> Bool Source #

(<=) :: AccountAlias -> AccountAlias -> Bool Source #

(>) :: AccountAlias -> AccountAlias -> Bool Source #

(>=) :: AccountAlias -> AccountAlias -> Bool Source #

max :: AccountAlias -> AccountAlias -> AccountAlias Source #

min :: AccountAlias -> AccountAlias -> AccountAlias Source #

type Rep AccountAlias Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AccountAlias = D1 ('MetaData "AccountAlias" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "BasicAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName)) :+: C1 ('MetaCons "RegexAlias" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Regexp) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Replacement)))

data Side Source #

Constructors

L |
R |

#### Instances

Instances details

FromJSON Side Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Side Source # parseJSONList :: Value -> Parser [Side] Source #
ToJSON Side Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Side -> Value Source # toEncoding :: Side -> Encoding Source # toJSONList :: [Side] -> Value Source # toEncodingList :: [Side] -> Encoding Source #
Generic Side Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Side :: Type -> Type Source # Methods from :: Side -> Rep Side x Source # to :: Rep Side x -> Side Source #
Read Side Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS Side Source # readList :: ReadS [Side] Source # readPrec :: ReadPrec Side Source # readListPrec :: ReadPrec [Side] Source #
Show Side Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Side -> ShowS Source # show :: Side -> String Source # showList :: [Side] -> ShowS Source #
Eq Side Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Side -> Side -> Bool Source # (/=) :: Side -> Side -> Bool Source #
Ord Side Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Side -> Side -> Ordering Source # (<) :: Side -> Side -> Bool Source # (<=) :: Side -> Side -> Bool Source # (>) :: Side -> Side -> Bool Source # (>=) :: Side -> Side -> Bool Source # max :: Side -> Side -> Side Source # min :: Side -> Side -> Side Source #
type Rep Side Source # |
Instance details Defined in Hledger.Data.Types type Rep Side = D1 ('MetaData "Side" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "L" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "R" 'PrefixI 'False) (U1 :: Type -> Type))

type DecimalMark = Char Source #

One of the decimal marks we support: either period or comma.

type Quantity = Decimal Source #

The basic numeric type used in amounts.

data AmountPrice Source #

An amount's per-unit or total cost/selling price in another commodity, as recorded in the journal entry eg with `or` @. Cost, formerly AKA "transaction price". The amount is always positive.

Constructors

UnitPrice !Amount |
TotalPrice !Amount |

#### Instances

Instances details

FromJSON AmountPrice Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser AmountPrice Source # parseJSONList :: Value -> Parser [AmountPrice] Source #
ToJSON AmountPrice Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AmountPrice -> Value Source # toEncoding :: AmountPrice -> Encoding Source # toJSONList :: [AmountPrice] -> Value Source # toEncodingList :: [AmountPrice] -> Encoding Source #
Generic AmountPrice Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AmountPrice :: Type -> Type Source # Methods from :: AmountPrice -> Rep AmountPrice x Source # to :: Rep AmountPrice x -> AmountPrice Source #
Show AmountPrice Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AmountPrice -> ShowS Source # show :: AmountPrice -> String Source # showList :: [AmountPrice] -> ShowS Source #
Eq AmountPrice Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AmountPrice -> AmountPrice -> Bool Source # (/=) :: AmountPrice -> AmountPrice -> Bool Source #
Ord AmountPrice Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: AmountPrice -> AmountPrice -> Ordering Source #

(<) :: AmountPrice -> AmountPrice -> Bool Source #

(<=) :: AmountPrice -> AmountPrice -> Bool Source #

(>) :: AmountPrice -> AmountPrice -> Bool Source #

(>=) :: AmountPrice -> AmountPrice -> Bool Source #

max :: AmountPrice -> AmountPrice -> AmountPrice Source #

min :: AmountPrice -> AmountPrice -> AmountPrice Source #

type Rep AmountPrice Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AmountPrice = D1 ('MetaData "AmountPrice" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "UnitPrice" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Amount)) :+: C1 ('MetaCons "TotalPrice" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Amount)))

data AmountStyle Source #

Every Amount has one of these, influencing how the amount is displayed. Also, each Commodity can have one, which can be applied to its amounts for consistent display. See also Amount.AmountDisplayOpts.

Constructors

AmountStyle |

Fields

- ascommodityside :: !Side

  show the symbol on the left or the right ?

- ascommodityspaced :: !Bool

  show a space between symbol and quantity ?

- asdigitgroups :: !(Maybe DigitGroupStyle)

  show the integer part with these digit group marks, or not

- asdecimalmark :: !(Maybe Char)

  show this character (should be . or ,) as decimal mark, or use the default (.)

- asprecision :: !AmountPrecision

  "display precision" - show this number of digits after the decimal point

- asrounding :: !Rounding

  "rounding strategy" - kept here for convenience, for now: when displaying an amount, it is ignored, but when applying this style to another amount, it determines how hard we should try to adjust the amount's display precision.

#### Instances

Instances details

FromJSON AmountStyle Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser AmountStyle Source # parseJSONList :: Value -> Parser [AmountStyle] Source #
ToJSON AmountStyle Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AmountStyle -> Value Source # toEncoding :: AmountStyle -> Encoding Source # toJSONList :: [AmountStyle] -> Value Source # toEncodingList :: [AmountStyle] -> Encoding Source #
Generic AmountStyle Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AmountStyle :: Type -> Type Source # Methods from :: AmountStyle -> Rep AmountStyle x Source # to :: Rep AmountStyle x -> AmountStyle Source #
Read AmountStyle Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS AmountStyle Source # readList :: ReadS [AmountStyle] Source # readPrec :: ReadPrec AmountStyle Source # readListPrec :: ReadPrec [AmountStyle] Source #
Show AmountStyle Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AmountStyle -> ShowS Source # show :: AmountStyle -> String Source # showList :: [AmountStyle] -> ShowS Source #
Eq AmountStyle Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AmountStyle -> AmountStyle -> Bool Source # (/=) :: AmountStyle -> AmountStyle -> Bool Source #
Ord AmountStyle Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: AmountStyle -> AmountStyle -> Ordering Source #

(<) :: AmountStyle -> AmountStyle -> Bool Source #

(<=) :: AmountStyle -> AmountStyle -> Bool Source #

(>) :: AmountStyle -> AmountStyle -> Bool Source #

(>=) :: AmountStyle -> AmountStyle -> Bool Source #

max :: AmountStyle -> AmountStyle -> AmountStyle Source #

min :: AmountStyle -> AmountStyle -> AmountStyle Source #

type Rep AmountStyle Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AmountStyle = D1 ('MetaData "AmountStyle" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "AmountStyle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ascommodityside") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Side) :*: (S1 ('MetaSel ('Just "ascommodityspaced") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "asdigitgroups") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe DigitGroupStyle)))) :*: (S1 ('MetaSel ('Just "asdecimalmark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Char)) :*: (S1 ('MetaSel ('Just "asprecision") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AmountPrecision) :*: S1 ('MetaSel ('Just "asrounding") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Rounding)))))

data DigitGroupStyle Source #

A style for displaying digit groups in the integer part of a floating point number. It consists of the character used to separate groups (comma or period, whichever is not used as decimal point), and the size of each group, starting with the one nearest the decimal point. The last group size is assumed to repeat. Eg, comma between thousands is DigitGroups ',' [3].

Constructors

DigitGroups !Char ![Word8] |

#### Instances

Instances details

FromJSON DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser DigitGroupStyle Source # parseJSONList :: Value -> Parser [DigitGroupStyle] Source #
ToJSON DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: DigitGroupStyle -> Value Source # toEncoding :: DigitGroupStyle -> Encoding Source # toJSONList :: [DigitGroupStyle] -> Value Source # toEncodingList :: [DigitGroupStyle] -> Encoding Source #
Generic DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep DigitGroupStyle :: Type -> Type Source # Methods from :: DigitGroupStyle -> Rep DigitGroupStyle x Source # to :: Rep DigitGroupStyle x -> DigitGroupStyle Source #
Read DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS DigitGroupStyle Source # readList :: ReadS [DigitGroupStyle] Source # readPrec :: ReadPrec DigitGroupStyle Source # readListPrec :: ReadPrec [DigitGroupStyle] Source #
Show DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> DigitGroupStyle -> ShowS Source # show :: DigitGroupStyle -> String Source # showList :: [DigitGroupStyle] -> ShowS Source #
Eq DigitGroupStyle Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source # (/=) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source #
Ord DigitGroupStyle Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: DigitGroupStyle -> DigitGroupStyle -> Ordering Source #

(<) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source #

(<=) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source #

(>) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source #

(>=) :: DigitGroupStyle -> DigitGroupStyle -> Bool Source #

max :: DigitGroupStyle -> DigitGroupStyle -> DigitGroupStyle Source #

min :: DigitGroupStyle -> DigitGroupStyle -> DigitGroupStyle Source #

type Rep DigitGroupStyle Source # |

Instance details

Defined in Hledger.Data.Types

type Rep DigitGroupStyle = D1 ('MetaData "DigitGroupStyle" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "DigitGroups" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Char) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Word8])))

data AmountPrecision Source #

The "display precision" for a hledger amount, by which we mean the number of decimal digits to display to the right of the decimal mark.

Constructors

Precision !Word8 | show this many decimal digits (0..255)
NaturalPrecision | show all significant decimal digits stored internally

#### Instances

Instances details

FromJSON AmountPrecision Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser AmountPrecision Source # parseJSONList :: Value -> Parser [AmountPrecision] Source #
ToJSON AmountPrecision Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AmountPrecision -> Value Source # toEncoding :: AmountPrecision -> Encoding Source # toJSONList :: [AmountPrecision] -> Value Source # toEncodingList :: [AmountPrecision] -> Encoding Source #
Generic AmountPrecision Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AmountPrecision :: Type -> Type Source # Methods from :: AmountPrecision -> Rep AmountPrecision x Source # to :: Rep AmountPrecision x -> AmountPrecision Source #
Read AmountPrecision Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS AmountPrecision Source # readList :: ReadS [AmountPrecision] Source # readPrec :: ReadPrec AmountPrecision Source # readListPrec :: ReadPrec [AmountPrecision] Source #
Show AmountPrecision Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AmountPrecision -> ShowS Source # show :: AmountPrecision -> String Source # showList :: [AmountPrecision] -> ShowS Source #
Eq AmountPrecision Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AmountPrecision -> AmountPrecision -> Bool Source # (/=) :: AmountPrecision -> AmountPrecision -> Bool Source #
Ord AmountPrecision Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: AmountPrecision -> AmountPrecision -> Ordering Source #

(<) :: AmountPrecision -> AmountPrecision -> Bool Source #

(<=) :: AmountPrecision -> AmountPrecision -> Bool Source #

(>) :: AmountPrecision -> AmountPrecision -> Bool Source #

(>=) :: AmountPrecision -> AmountPrecision -> Bool Source #

max :: AmountPrecision -> AmountPrecision -> AmountPrecision Source #

min :: AmountPrecision -> AmountPrecision -> AmountPrecision Source #

type Rep AmountPrecision Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AmountPrecision = D1 ('MetaData "AmountPrecision" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Precision" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word8)) :+: C1 ('MetaCons "NaturalPrecision" 'PrefixI 'False) (U1 :: Type -> Type))

data Rounding Source #

"Rounding strategy" - how to apply an AmountStyle's display precision to a posting amount (and its cost, if any). Mainly used to customise print's output, with --round=none|soft|hard|all.

Constructors

NoRounding | keep display precisions unchanged in amt and cost
SoftRounding | do soft rounding of amt and cost amounts (show more or fewer decimal zeros to approximate the target precision, but don't hide significant digits)
HardRounding | do hard rounding of amt (use the exact target precision, possibly hiding significant digits), and soft rounding of cost
AllRounding | do hard rounding of amt and cost

#### Instances

Instances details

FromJSON Rounding Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser Rounding Source # parseJSONList :: Value -> Parser [Rounding] Source #
ToJSON Rounding Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Rounding -> Value Source # toEncoding :: Rounding -> Encoding Source # toJSONList :: [Rounding] -> Value Source # toEncodingList :: [Rounding] -> Encoding Source #
Generic Rounding Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Rounding :: Type -> Type Source # Methods from :: Rounding -> Rep Rounding x Source # to :: Rep Rounding x -> Rounding Source #
Read Rounding Source # |
Instance details Defined in Hledger.Data.Types Methods readsPrec :: Int -> ReadS Rounding Source # readList :: ReadS [Rounding] Source # readPrec :: ReadPrec Rounding Source # readListPrec :: ReadPrec [Rounding] Source #
Show Rounding Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Rounding -> ShowS Source # show :: Rounding -> String Source # showList :: [Rounding] -> ShowS Source #
Eq Rounding Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Rounding -> Rounding -> Bool Source # (/=) :: Rounding -> Rounding -> Bool Source #
Ord Rounding Source # |
Instance details Defined in Hledger.Data.Types Methods compare :: Rounding -> Rounding -> Ordering Source # (<) :: Rounding -> Rounding -> Bool Source # (<=) :: Rounding -> Rounding -> Bool Source # (>) :: Rounding -> Rounding -> Bool Source # (>=) :: Rounding -> Rounding -> Bool Source # max :: Rounding -> Rounding -> Rounding Source # min :: Rounding -> Rounding -> Rounding Source #
type Rep Rounding Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Rounding = D1 ('MetaData "Rounding" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) ((C1 ('MetaCons "NoRounding" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SoftRounding" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "HardRounding" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "AllRounding" 'PrefixI 'False) (U1 :: Type -> Type)))

type CommoditySymbol = Text Source #

data Commodity Source #

Constructors

Commodity |

Fields

- csymbol :: CommoditySymbol
- cformat :: Maybe AmountStyle

#### Instances

Instances details

ToJSON Commodity Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: Commodity -> Value Source # toEncoding :: Commodity -> Encoding Source # toJSONList :: [Commodity] -> Value Source # toEncodingList :: [Commodity] -> Encoding Source #
Generic Commodity Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep Commodity :: Type -> Type Source # Methods from :: Commodity -> Rep Commodity x Source # to :: Rep Commodity x -> Commodity Source #
Show Commodity Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> Commodity -> ShowS Source # show :: Commodity -> String Source # showList :: [Commodity] -> ShowS Source #
Eq Commodity Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: Commodity -> Commodity -> Bool Source # (/=) :: Commodity -> Commodity -> Bool Source #
type Rep Commodity Source # |

Instance details

Defined in Hledger.Data.Types

type Rep Commodity = D1 ('MetaData "Commodity" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "Commodity" 'PrefixI 'True) (S1 ('MetaSel ('Just "csymbol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommoditySymbol) :*: S1 ('MetaSel ('Just "cformat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AmountStyle))))

class HasAmounts a where Source #

Types with this class have one or more amounts, which can have display styles applied to them.

Methods

styleAmounts :: Map CommoditySymbol AmountStyle -> a -> a Source #

#### Instances

Instances details

HasAmounts Account Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Account -> Account Source #
HasAmounts Amount Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Amount -> Amount Source #
HasAmounts BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Posting Methods styleAmounts :: Map CommoditySymbol AmountStyle -> BalanceAssertion -> BalanceAssertion Source #
HasAmounts MixedAmount Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount Source #
HasAmounts Posting Source # |
Instance details Defined in Hledger.Data.Posting Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Posting -> Posting Source #
HasAmounts Transaction Source # |
Instance details Defined in Hledger.Data.Transaction Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Transaction -> Transaction Source #
HasAmounts AccountTransactionsReportItem Source # |
Instance details Defined in Hledger.Reports.AccountTransactionsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> AccountTransactionsReportItem -> AccountTransactionsReportItem Source #
HasAmounts BalanceReportItem Source # |
Instance details Defined in Hledger.Reports.BalanceReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> BalanceReportItem -> BalanceReportItem Source #
HasAmounts PostingsReportItem Source # |
Instance details Defined in Hledger.Reports.PostingsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PostingsReportItem -> PostingsReportItem Source #
HasAmounts a => HasAmounts (Maybe a) Source # |
Instance details Defined in Hledger.Data.Types Methods styleAmounts :: Map CommoditySymbol AmountStyle -> Maybe a -> Maybe a Source #
HasAmounts a => HasAmounts [a] Source # |
Instance details Defined in Hledger.Data.Types Methods styleAmounts :: Map CommoditySymbol AmountStyle -> [a] -> [a] Source #
HasAmounts b => HasAmounts (CompoundPeriodicReport a b) Source # |
Instance details Defined in Hledger.Reports.ReportTypes Methods styleAmounts :: Map CommoditySymbol AmountStyle -> CompoundPeriodicReport a b -> CompoundPeriodicReport a b Source #
HasAmounts b => HasAmounts (PeriodicReport a b) Source # |
Instance details Defined in Hledger.Reports.ReportTypes Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PeriodicReport a b -> PeriodicReport a b Source #
HasAmounts b => HasAmounts (PeriodicReportRow a b) Source # |
Instance details Defined in Hledger.Reports.ReportTypes Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PeriodicReportRow a b -> PeriodicReportRow a b Source #
(HasAmounts a, HasAmounts b) => HasAmounts (a, b) Source # |
Instance details Defined in Hledger.Data.Types Methods styleAmounts :: Map CommoditySymbol AmountStyle -> (a, b) -> (a, b) Source #
HasAmounts b => HasAmounts (Text, PeriodicReport a b, Bool) Source # |
Instance details Defined in Hledger.Reports.ReportTypes Methods styleAmounts :: Map CommoditySymbol AmountStyle -> (Text, PeriodicReport a b, Bool) -> (Text, PeriodicReport a b, Bool) Source #

data MixedAmount Source #

#### Instances

Instances details

FromJSON MixedAmount Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser MixedAmount Source # parseJSONList :: Value -> Parser [MixedAmount] Source #
ToJSON MixedAmount Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: MixedAmount -> Value Source # toEncoding :: MixedAmount -> Encoding Source # toJSONList :: [MixedAmount] -> Value Source # toEncodingList :: [MixedAmount] -> Encoding Source #
Monoid MixedAmount Source # |
Instance details Defined in Hledger.Data.Amount Methods mempty :: MixedAmount Source # mappend :: MixedAmount -> MixedAmount -> MixedAmount Source # mconcat :: [MixedAmount] -> MixedAmount Source #
Semigroup MixedAmount Source # |
Instance details Defined in Hledger.Data.Amount Methods (<>) :: MixedAmount -> MixedAmount -> MixedAmount Source # sconcat :: NonEmpty MixedAmount -> MixedAmount Source # stimes :: Integral b => b -> MixedAmount -> MixedAmount Source #
Generic MixedAmount Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep MixedAmount :: Type -> Type Source # Methods from :: MixedAmount -> Rep MixedAmount x Source # to :: Rep MixedAmount x -> MixedAmount Source #
Num MixedAmount Source # |

Instance details

Defined in Hledger.Data.Amount

Methods

(+) :: MixedAmount -> MixedAmount -> MixedAmount Source #

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

(*) :: MixedAmount -> MixedAmount -> MixedAmount Source #

negate :: MixedAmount -> MixedAmount Source #

abs :: MixedAmount -> MixedAmount Source #

signum :: MixedAmount -> MixedAmount Source #

fromInteger :: Integer -> MixedAmount Source #

Show MixedAmount Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> MixedAmount -> ShowS Source # show :: MixedAmount -> String Source # showList :: [MixedAmount] -> ShowS Source #
Eq MixedAmount Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: MixedAmount -> MixedAmount -> Bool Source # (/=) :: MixedAmount -> MixedAmount -> Bool Source #
Ord MixedAmount Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: MixedAmount -> MixedAmount -> Ordering Source #

(<) :: MixedAmount -> MixedAmount -> Bool Source #

(<=) :: MixedAmount -> MixedAmount -> Bool Source #

(>) :: MixedAmount -> MixedAmount -> Bool Source #

(>=) :: MixedAmount -> MixedAmount -> Bool Source #

max :: MixedAmount -> MixedAmount -> MixedAmount Source #

min :: MixedAmount -> MixedAmount -> MixedAmount Source #

HasAmounts MixedAmount Source # |
Instance details Defined in Hledger.Data.Amount Methods styleAmounts :: Map CommoditySymbol AmountStyle -> MixedAmount -> MixedAmount Source #
HasAmounts AccountTransactionsReportItem Source # |
Instance details Defined in Hledger.Reports.AccountTransactionsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> AccountTransactionsReportItem -> AccountTransactionsReportItem Source #
HasAmounts BalanceReportItem Source # |
Instance details Defined in Hledger.Reports.BalanceReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> BalanceReportItem -> BalanceReportItem Source #
HasAmounts PostingsReportItem Source # |
Instance details Defined in Hledger.Reports.PostingsReport Methods styleAmounts :: Map CommoditySymbol AmountStyle -> PostingsReportItem -> PostingsReportItem Source #
type Rep MixedAmount Source # |
Instance details Defined in Hledger.Data.Types type Rep MixedAmount = D1 ('MetaData "MixedAmount" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'True) (C1 ('MetaCons "Mixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map MixedAmountKey Amount))))

data PostingType Source #

Constructors

RegularPosting |
VirtualPosting |
BalancedVirtualPosting |

#### Instances

Instances details

FromJSON PostingType Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser PostingType Source # parseJSONList :: Value -> Parser [PostingType] Source #
ToJSON PostingType Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: PostingType -> Value Source # toEncoding :: PostingType -> Encoding Source # toJSONList :: [PostingType] -> Value Source # toEncodingList :: [PostingType] -> Encoding Source #
Generic PostingType Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep PostingType :: Type -> Type Source # Methods from :: PostingType -> Rep PostingType x Source # to :: Rep PostingType x -> PostingType Source #
Show PostingType Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> PostingType -> ShowS Source # show :: PostingType -> String Source # showList :: [PostingType] -> ShowS Source #
Eq PostingType Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: PostingType -> PostingType -> Bool Source # (/=) :: PostingType -> PostingType -> Bool Source #
type Rep PostingType Source # |
Instance details Defined in Hledger.Data.Types type Rep PostingType = D1 ('MetaData "PostingType" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "RegularPosting" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "VirtualPosting" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BalancedVirtualPosting" 'PrefixI 'False) (U1 :: Type -> Type)))

type TagName = Text Source #

type TagValue = Text Source #

type DateTag = (TagName, Day) Source #

data BalanceAssertion Source #

A balance assertion is a declaration about an account's expected balance at a certain point (posting date and parse order). They provide additional error checking and readability to a journal file.

A balance assignments is an instruction to hledger to adjust an account's balance to a certain amount at a certain point.

The `BalanceAssertion` type is used for representing both of these.

hledger supports multiple kinds of balance assertions/assignments, which differ in whether they refer to a single commodity or all commodities, and the (subaccount-)inclusive or exclusive account balance.

Constructors

BalanceAssertion |

Fields

- baamount :: Amount

  the expected balance in a particular commodity

- batotal :: Bool

  disallow additional non-asserted commodities ?

- bainclusive :: Bool

  include subaccounts when calculating the actual balance ?

- baposition :: SourcePos

  the assertion's file position, for error reporting

#### Instances

Instances details

FromJSON BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser BalanceAssertion Source # parseJSONList :: Value -> Parser [BalanceAssertion] Source #
ToJSON BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: BalanceAssertion -> Value Source # toEncoding :: BalanceAssertion -> Encoding Source # toJSONList :: [BalanceAssertion] -> Value Source # toEncodingList :: [BalanceAssertion] -> Encoding Source #
Generic BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep BalanceAssertion :: Type -> Type Source # Methods from :: BalanceAssertion -> Rep BalanceAssertion x Source # to :: Rep BalanceAssertion x -> BalanceAssertion Source #
Show BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> BalanceAssertion -> ShowS Source # show :: BalanceAssertion -> String Source # showList :: [BalanceAssertion] -> ShowS Source #
Eq BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: BalanceAssertion -> BalanceAssertion -> Bool Source # (/=) :: BalanceAssertion -> BalanceAssertion -> Bool Source #
HasAmounts BalanceAssertion Source # |
Instance details Defined in Hledger.Data.Posting Methods styleAmounts :: Map CommoditySymbol AmountStyle -> BalanceAssertion -> BalanceAssertion Source #
type Rep BalanceAssertion Source # |

Instance details

Defined in Hledger.Data.Types

type Rep BalanceAssertion = D1 ('MetaData "BalanceAssertion" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "BalanceAssertion" 'PrefixI 'True) ((S1 ('MetaSel ('Just "baamount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount) :*: S1 ('MetaSel ('Just "batotal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "bainclusive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "baposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourcePos))))

data TMPostingRule Source #

A transaction modifier transformation, which adds an extra posting to the matched posting's transaction. Can be like a regular posting, or can have the tmprIsMultiplier flag set, indicating that it's a multiplier for the matched posting's amount.

Constructors

TMPostingRule |

Fields

- tmprPosting :: Posting
- tmprIsMultiplier :: Bool

#### Instances

Instances details

ToJSON TMPostingRule Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: TMPostingRule -> Value Source # toEncoding :: TMPostingRule -> Encoding Source # toJSONList :: [TMPostingRule] -> Value Source # toEncodingList :: [TMPostingRule] -> Encoding Source #
Generic TMPostingRule Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep TMPostingRule :: Type -> Type Source # Methods from :: TMPostingRule -> Rep TMPostingRule x Source # to :: Rep TMPostingRule x -> TMPostingRule Source #
Show TMPostingRule Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> TMPostingRule -> ShowS Source # show :: TMPostingRule -> String Source # showList :: [TMPostingRule] -> ShowS Source #
Eq TMPostingRule Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: TMPostingRule -> TMPostingRule -> Bool Source # (/=) :: TMPostingRule -> TMPostingRule -> Bool Source #
type Rep TMPostingRule Source # |

Instance details

Defined in Hledger.Data.Types

type Rep TMPostingRule = D1 ('MetaData "TMPostingRule" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "TMPostingRule" 'PrefixI 'True) (S1 ('MetaSel ('Just "tmprPosting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Posting) :*: S1 ('MetaSel ('Just "tmprIsMultiplier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))

data TimeclockCode Source #

Constructors

SetBalance |
SetRequiredHours |
In |
Out |
FinalOut |

#### Instances

Instances details

ToJSON TimeclockCode Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: TimeclockCode -> Value Source # toEncoding :: TimeclockCode -> Encoding Source # toJSONList :: [TimeclockCode] -> Value Source # toEncodingList :: [TimeclockCode] -> Encoding Source #
Generic TimeclockCode Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep TimeclockCode :: Type -> Type Source # Methods from :: TimeclockCode -> Rep TimeclockCode x Source # to :: Rep TimeclockCode x -> TimeclockCode Source #
Read TimeclockCode Source # |
Instance details Defined in Hledger.Data.Timeclock Methods readsPrec :: Int -> ReadS TimeclockCode Source # readList :: ReadS [TimeclockCode] Source # readPrec :: ReadPrec TimeclockCode Source # readListPrec :: ReadPrec [TimeclockCode] Source #
Show TimeclockCode Source # |
Instance details Defined in Hledger.Data.Timeclock Methods showsPrec :: Int -> TimeclockCode -> ShowS Source # show :: TimeclockCode -> String Source # showList :: [TimeclockCode] -> ShowS Source #
Eq TimeclockCode Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: TimeclockCode -> TimeclockCode -> Bool Source # (/=) :: TimeclockCode -> TimeclockCode -> Bool Source #
Ord TimeclockCode Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: TimeclockCode -> TimeclockCode -> Ordering Source #

(<) :: TimeclockCode -> TimeclockCode -> Bool Source #

(<=) :: TimeclockCode -> TimeclockCode -> Bool Source #

(>) :: TimeclockCode -> TimeclockCode -> Bool Source #

(>=) :: TimeclockCode -> TimeclockCode -> Bool Source #

max :: TimeclockCode -> TimeclockCode -> TimeclockCode Source #

min :: TimeclockCode -> TimeclockCode -> TimeclockCode Source #

type Rep TimeclockCode Source # |

Instance details

Defined in Hledger.Data.Types

type Rep TimeclockCode = D1 ('MetaData "TimeclockCode" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) ((C1 ('MetaCons "SetBalance" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "SetRequiredHours" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "In" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Out" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FinalOut" 'PrefixI 'False) (U1 :: Type -> Type))))

data TimeclockEntry Source #

Constructors

TimeclockEntry |

Fields

- tlsourcepos :: SourcePos
- tlcode :: TimeclockCode
- tldatetime :: LocalTime
- tlaccount :: AccountName
- tldescription :: Text
- tlcomment :: Text
- tltags :: [Tag]

#### Instances

Instances details

ToJSON TimeclockEntry Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: TimeclockEntry -> Value Source # toEncoding :: TimeclockEntry -> Encoding Source # toJSONList :: [TimeclockEntry] -> Value Source # toEncodingList :: [TimeclockEntry] -> Encoding Source #
Generic TimeclockEntry Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep TimeclockEntry :: Type -> Type Source # Methods from :: TimeclockEntry -> Rep TimeclockEntry x Source # to :: Rep TimeclockEntry x -> TimeclockEntry Source #
Show TimeclockEntry Source # |
Instance details Defined in Hledger.Data.Timeclock Methods showsPrec :: Int -> TimeclockEntry -> ShowS Source # show :: TimeclockEntry -> String Source # showList :: [TimeclockEntry] -> ShowS Source #
Eq TimeclockEntry Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: TimeclockEntry -> TimeclockEntry -> Bool Source # (/=) :: TimeclockEntry -> TimeclockEntry -> Bool Source #
Ord TimeclockEntry Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: TimeclockEntry -> TimeclockEntry -> Ordering Source #

(<) :: TimeclockEntry -> TimeclockEntry -> Bool Source #

(<=) :: TimeclockEntry -> TimeclockEntry -> Bool Source #

(>) :: TimeclockEntry -> TimeclockEntry -> Bool Source #

(>=) :: TimeclockEntry -> TimeclockEntry -> Bool Source #

max :: TimeclockEntry -> TimeclockEntry -> TimeclockEntry Source #

min :: TimeclockEntry -> TimeclockEntry -> TimeclockEntry Source #

type Rep TimeclockEntry Source # |

Instance details

Defined in Hledger.Data.Types

type Rep TimeclockEntry = D1 ('MetaData "TimeclockEntry" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "TimeclockEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tlsourcepos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourcePos) :*: (S1 ('MetaSel ('Just "tlcode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimeclockCode) :*: S1 ('MetaSel ('Just "tldatetime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalTime))) :*: ((S1 ('MetaSel ('Just "tlaccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountName) :*: S1 ('MetaSel ('Just "tldescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "tlcomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "tltags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag])))))

data PriceDirective Source #

A market price declaration made by the journal format's P directive. It declares two things: a historical exchange rate between two commodities, and an amount display style for the second commodity.

Constructors

PriceDirective |

Fields

- pddate :: Day
- pdcommodity :: CommoditySymbol
- pdamount :: Amount

#### Instances

Instances details

ToJSON PriceDirective Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: PriceDirective -> Value Source # toEncoding :: PriceDirective -> Encoding Source # toJSONList :: [PriceDirective] -> Value Source # toEncodingList :: [PriceDirective] -> Encoding Source #
Generic PriceDirective Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep PriceDirective :: Type -> Type Source # Methods from :: PriceDirective -> Rep PriceDirective x Source # to :: Rep PriceDirective x -> PriceDirective Source #
Show PriceDirective Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> PriceDirective -> ShowS Source # show :: PriceDirective -> String Source # showList :: [PriceDirective] -> ShowS Source #
Eq PriceDirective Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: PriceDirective -> PriceDirective -> Bool Source # (/=) :: PriceDirective -> PriceDirective -> Bool Source #
Ord PriceDirective Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: PriceDirective -> PriceDirective -> Ordering Source #

(<) :: PriceDirective -> PriceDirective -> Bool Source #

(<=) :: PriceDirective -> PriceDirective -> Bool Source #

(>) :: PriceDirective -> PriceDirective -> Bool Source #

(>=) :: PriceDirective -> PriceDirective -> Bool Source #

max :: PriceDirective -> PriceDirective -> PriceDirective Source #

min :: PriceDirective -> PriceDirective -> PriceDirective Source #

type Rep PriceDirective Source # |

Instance details

Defined in Hledger.Data.Types

type Rep PriceDirective = D1 ('MetaData "PriceDirective" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "PriceDirective" 'PrefixI 'True) (S1 ('MetaSel ('Just "pddate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day) :*: (S1 ('MetaSel ('Just "pdcommodity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommoditySymbol) :*: S1 ('MetaSel ('Just "pdamount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Amount))))

data MarketPrice Source #

A historical market price (exchange rate) from one commodity to another. A more concise form of a PriceDirective, without the amount display info.

Constructors

MarketPrice |

Fields

- mpdate :: Day

  Date on which this price becomes effective.

- mpfrom :: CommoditySymbol

  The commodity being converted from.

- mpto :: CommoditySymbol

  The commodity being converted to.

- mprate :: Quantity

  One unit of the "from" commodity is worth this quantity of the "to" commodity.

#### Instances

Instances details

FromJSON MarketPrice Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser MarketPrice Source # parseJSONList :: Value -> Parser [MarketPrice] Source #
ToJSON MarketPrice Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: MarketPrice -> Value Source # toEncoding :: MarketPrice -> Encoding Source # toJSONList :: [MarketPrice] -> Value Source # toEncodingList :: [MarketPrice] -> Encoding Source #
Generic MarketPrice Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep MarketPrice :: Type -> Type Source # Methods from :: MarketPrice -> Rep MarketPrice x Source # to :: Rep MarketPrice x -> MarketPrice Source #
Show MarketPrice Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> MarketPrice -> ShowS Source # show :: MarketPrice -> String Source # showList :: [MarketPrice] -> ShowS Source #
Eq MarketPrice Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: MarketPrice -> MarketPrice -> Bool Source # (/=) :: MarketPrice -> MarketPrice -> Bool Source #
Ord MarketPrice Source # |

Instance details

Defined in Hledger.Data.Types

Methods

compare :: MarketPrice -> MarketPrice -> Ordering Source #

(<) :: MarketPrice -> MarketPrice -> Bool Source #

(<=) :: MarketPrice -> MarketPrice -> Bool Source #

(>) :: MarketPrice -> MarketPrice -> Bool Source #

(>=) :: MarketPrice -> MarketPrice -> Bool Source #

max :: MarketPrice -> MarketPrice -> MarketPrice Source #

min :: MarketPrice -> MarketPrice -> MarketPrice Source #

type Rep MarketPrice Source # |

Instance details

Defined in Hledger.Data.Types

type Rep MarketPrice = D1 ('MetaData "MarketPrice" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "MarketPrice" 'PrefixI 'True) ((S1 ('MetaSel ('Just "mpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Day) :*: S1 ('MetaSel ('Just "mpfrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommoditySymbol)) :*: (S1 ('MetaSel ('Just "mpto") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommoditySymbol) :*: S1 ('MetaSel ('Just "mprate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Quantity))))

data PayeeDeclarationInfo Source #

Extra information found in a payee directive.

Constructors

PayeeDeclarationInfo |

Fields

- pdicomment :: Text

  any comment lines following the payee directive

- pditags :: [Tag]

  tags extracted from the comment, if any

#### Instances

Instances details

ToJSON PayeeDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: PayeeDeclarationInfo -> Value Source # toEncoding :: PayeeDeclarationInfo -> Encoding Source # toJSONList :: [PayeeDeclarationInfo] -> Value Source # toEncodingList :: [PayeeDeclarationInfo] -> Encoding Source #
Generic PayeeDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep PayeeDeclarationInfo :: Type -> Type Source # Methods from :: PayeeDeclarationInfo -> Rep PayeeDeclarationInfo x Source # to :: Rep PayeeDeclarationInfo x -> PayeeDeclarationInfo Source #
Show PayeeDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> PayeeDeclarationInfo -> ShowS Source # show :: PayeeDeclarationInfo -> String Source # showList :: [PayeeDeclarationInfo] -> ShowS Source #
Eq PayeeDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: PayeeDeclarationInfo -> PayeeDeclarationInfo -> Bool Source # (/=) :: PayeeDeclarationInfo -> PayeeDeclarationInfo -> Bool Source #
type Rep PayeeDeclarationInfo Source # |

Instance details

Defined in Hledger.Data.Types

type Rep PayeeDeclarationInfo = D1 ('MetaData "PayeeDeclarationInfo" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "PayeeDeclarationInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "pdicomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "pditags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag])))

newtype TagDeclarationInfo Source #

Extra information found in a tag directive.

Constructors

TagDeclarationInfo |

Fields

- tdicomment :: Text

  any comment lines following the tag directive. No tags allowed here.

#### Instances

Instances details

ToJSON TagDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: TagDeclarationInfo -> Value Source # toEncoding :: TagDeclarationInfo -> Encoding Source # toJSONList :: [TagDeclarationInfo] -> Value Source # toEncodingList :: [TagDeclarationInfo] -> Encoding Source #
Generic TagDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep TagDeclarationInfo :: Type -> Type Source # Methods from :: TagDeclarationInfo -> Rep TagDeclarationInfo x Source # to :: Rep TagDeclarationInfo x -> TagDeclarationInfo Source #
Show TagDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> TagDeclarationInfo -> ShowS Source # show :: TagDeclarationInfo -> String Source # showList :: [TagDeclarationInfo] -> ShowS Source #
Eq TagDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: TagDeclarationInfo -> TagDeclarationInfo -> Bool Source # (/=) :: TagDeclarationInfo -> TagDeclarationInfo -> Bool Source #
type Rep TagDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types type Rep TagDeclarationInfo = D1 ('MetaData "TagDeclarationInfo" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'True) (C1 ('MetaCons "TagDeclarationInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "tdicomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data AccountDeclarationInfo Source #

Extra information about an account that can be derived from its account directive (and the other account directives).

Constructors

AccountDeclarationInfo |

Fields

- adicomment :: Text

  any comment lines following an account directive for this account

- aditags :: [Tag]

  tags extracted from the account comment, if any

- adideclarationorder :: Int

  the order in which this account was declared, relative to other account declarations, during parsing (1..)

- adisourcepos :: SourcePos

  source file and position

#### Instances

Instances details

FromJSON AccountDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Json Methods parseJSON :: Value -> Parser AccountDeclarationInfo Source # parseJSONList :: Value -> Parser [AccountDeclarationInfo] Source #
ToJSON AccountDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Json Methods toJSON :: AccountDeclarationInfo -> Value Source # toEncoding :: AccountDeclarationInfo -> Encoding Source # toJSONList :: [AccountDeclarationInfo] -> Value Source # toEncodingList :: [AccountDeclarationInfo] -> Encoding Source #
Generic AccountDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Associated Types type Rep AccountDeclarationInfo :: Type -> Type Source # Methods from :: AccountDeclarationInfo -> Rep AccountDeclarationInfo x Source # to :: Rep AccountDeclarationInfo x -> AccountDeclarationInfo Source #
Show AccountDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> AccountDeclarationInfo -> ShowS Source # show :: AccountDeclarationInfo -> String Source # showList :: [AccountDeclarationInfo] -> ShowS Source #
Eq AccountDeclarationInfo Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: AccountDeclarationInfo -> AccountDeclarationInfo -> Bool Source # (/=) :: AccountDeclarationInfo -> AccountDeclarationInfo -> Bool Source #
type Rep AccountDeclarationInfo Source # |

Instance details

Defined in Hledger.Data.Types

type Rep AccountDeclarationInfo = D1 ('MetaData "AccountDeclarationInfo" "Hledger.Data.Types" "hledger-lib-1.32.3-GM4Cyf9R3RZC5qXAEhraAs" 'False) (C1 ('MetaCons "AccountDeclarationInfo" 'PrefixI 'True) ((S1 ('MetaSel ('Just "adicomment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "aditags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Tag])) :*: (S1 ('MetaSel ('Just "adideclarationorder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "adisourcepos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SourcePos))))

type ParsedJournal = Journal Source #

A journal in the process of being parsed, not yet finalised. The data is partial, and list fields are in reverse order.

type StorageFormat = String Source #

The id of a data format understood by hledger, eg `journal` or `csv`. The --output-format option selects one of these for output.

data NormalSign Source #

Whether an account's balance is normally a positive number (in accounting terms, a debit balance) or a negative number (credit balance). Assets and expenses are normally positive (debit), while liabilities, equity and income are normally negative (credit). https://en.wikipedia.org/wiki/Normal_balance

Constructors

NormallyPositive |
NormallyNegative |

#### Instances

Instances details

Show NormalSign Source # |
Instance details Defined in Hledger.Data.Types Methods showsPrec :: Int -> NormalSign -> ShowS Source # show :: NormalSign -> String Source # showList :: [NormalSign] -> ShowS Source #
Eq NormalSign Source # |
Instance details Defined in Hledger.Data.Types Methods (==) :: NormalSign -> NormalSign -> Bool Source # (/=) :: NormalSign -> NormalSign -> Bool Source #

pattern MixedAmountKeyNoPrice :: !CommoditySymbol -> MixedAmountKey Source #

pattern MixedAmountKeyTotalPrice :: !CommoditySymbol -> !CommoditySymbol -> MixedAmountKey Source #

pattern MixedAmountKeyUnitPrice :: !CommoditySymbol -> !CommoditySymbol -> !Quantity -> MixedAmountKey Source #

fromEFDay :: EFDay -> Day Source #

modifyEFDay :: (Day -> Day) -> EFDay -> EFDay Source #

isBalanceSheetAccountType :: AccountType -> Bool Source #

isIncomeStatementAccountType :: AccountType -> Bool Source #

isAccountSubtypeOf :: AccountType -> AccountType -> Bool Source #

Check whether the first argument is a subtype of the second: either equal or one of the defined subtypes.

isDecimalMark :: Char -> Bool Source #

maCompare :: MixedAmount -> MixedAmount -> Ordering Source #

Compare two MixedAmounts, substituting 0 for the quantity of any missing commodities in either.

nulltransactionmodifier :: TransactionModifier Source #

nullperiodictransaction :: PeriodicTransaction Source #

nullpayeedeclarationinfo :: PayeeDeclarationInfo Source #

nulltagdeclarationinfo :: TagDeclarationInfo Source #

nullaccountdeclarationinfo :: AccountDeclarationInfo Source #

module Hledger.Data.Valuation

tests_Data :: TestTree Source #