Hledger.Data

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

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

Year of Common Era.

data Ledger

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

ToJSON Ledger

Defined in Hledger.Data.Json

Methods

toJSON :: Ledger -> Value

toEncoding :: Ledger -> Encoding

toJSONList :: [Ledger] -> Value

toEncodingList :: [Ledger] -> Encoding

Generic Ledger

Defined in Hledger.Data.Types

Associated Types

type Rep Ledger :: Type -> Type

Methods

from :: Ledger -> Rep Ledger x

to :: Rep Ledger x -> Ledger

Show Ledger

Defined in Hledger.Data.Ledger

Methods

showsPrec :: Int -> Ledger -> ShowS

show :: Ledger -> String

showList :: [Ledger] -> ShowS

type Rep Ledger

Defined in Hledger.Data.Types

type Rep Ledger = D1 ('MetaData "Ledger" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 NormalSign

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

Show NormalSign

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> NormalSign -> ShowS

show :: NormalSign -> String

showList :: [NormalSign] -> ShowS

Eq NormalSign

Defined in Hledger.Data.Types

Methods

(==) :: NormalSign -> NormalSign -> Bool

(/=) :: NormalSign -> NormalSign -> Bool

data Account

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

FromJSON Account

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

ToJSON Account

Defined in Hledger.Data.Json

Methods

toJSON :: Account -> Value

toEncoding :: Account -> Encoding

toJSONList :: [Account] -> Value

toEncodingList :: [Account] -> Encoding

Generic Account

Defined in Hledger.Data.Types

Associated Types

type Rep Account :: Type -> Type

Methods

from :: Account -> Rep Account x

to :: Rep Account x -> Account

Show Account

Defined in Hledger.Data.Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

Eq Account

Defined in Hledger.Data.Account

Methods

(==) :: Account -> Account -> Bool

(/=) :: Account -> Account -> Bool

type Rep Account

Defined in Hledger.Data.Types

type Rep Account = D1 ('MetaData "Account" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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)))))

data AccountDeclarationInfo

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

FromJSON AccountDeclarationInfo

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser AccountDeclarationInfo

parseJSONList :: Value -> Parser [AccountDeclarationInfo]

ToJSON AccountDeclarationInfo

Defined in Hledger.Data.Json

Methods

toJSON :: AccountDeclarationInfo -> Value

toEncoding :: AccountDeclarationInfo -> Encoding

toJSONList :: [AccountDeclarationInfo] -> Value

toEncodingList :: [AccountDeclarationInfo] -> Encoding

Generic AccountDeclarationInfo

Defined in Hledger.Data.Types

Associated Types

type Rep AccountDeclarationInfo :: Type -> Type

Methods

from :: AccountDeclarationInfo -> Rep AccountDeclarationInfo x

to :: Rep AccountDeclarationInfo x -> AccountDeclarationInfo

Show AccountDeclarationInfo

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AccountDeclarationInfo -> ShowS

show :: AccountDeclarationInfo -> String

showList :: [AccountDeclarationInfo] -> ShowS

Eq AccountDeclarationInfo

Defined in Hledger.Data.Types

Methods

(==) :: AccountDeclarationInfo -> AccountDeclarationInfo -> Bool

(/=) :: AccountDeclarationInfo -> AccountDeclarationInfo -> Bool

type Rep AccountDeclarationInfo

Defined in Hledger.Data.Types

type Rep AccountDeclarationInfo = D1 ('MetaData "AccountDeclarationInfo" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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))))

data PayeeDeclarationInfo

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

ToJSON PayeeDeclarationInfo

Defined in Hledger.Data.Json

Methods

toJSON :: PayeeDeclarationInfo -> Value

toEncoding :: PayeeDeclarationInfo -> Encoding

toJSONList :: [PayeeDeclarationInfo] -> Value

toEncodingList :: [PayeeDeclarationInfo] -> Encoding

Generic PayeeDeclarationInfo

Defined in Hledger.Data.Types

Associated Types

type Rep PayeeDeclarationInfo :: Type -> Type

Methods

from :: PayeeDeclarationInfo -> Rep PayeeDeclarationInfo x

to :: Rep PayeeDeclarationInfo x -> PayeeDeclarationInfo

Show PayeeDeclarationInfo

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> PayeeDeclarationInfo -> ShowS

show :: PayeeDeclarationInfo -> String

showList :: [PayeeDeclarationInfo] -> ShowS

Eq PayeeDeclarationInfo

Defined in Hledger.Data.Types

Methods

(==) :: PayeeDeclarationInfo -> PayeeDeclarationInfo -> Bool

(/=) :: PayeeDeclarationInfo -> PayeeDeclarationInfo -> Bool

type Rep PayeeDeclarationInfo

Defined in Hledger.Data.Types

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

type StorageFormat = String

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

type ParsedJournal = Journal

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

data Journal

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)

• 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

ToJSON Journal

Defined in Hledger.Data.Json

Methods

toJSON :: Journal -> Value

toEncoding :: Journal -> Encoding

toJSONList :: [Journal] -> Value

toEncodingList :: [Journal] -> Encoding

Semigroup Journal

Defined in Hledger.Data.Journal

Methods

(<>) :: Journal -> Journal -> Journal

sconcat :: NonEmpty Journal -> Journal

stimes :: Integral b => b -> Journal -> Journal

Generic Journal

Defined in Hledger.Data.Types

Associated Types

type Rep Journal :: Type -> Type

Methods

from :: Journal -> Rep Journal x

to :: Rep Journal x -> Journal

Show Journal

Defined in Hledger.Data.Journal

Methods

showsPrec :: Int -> Journal -> ShowS

show :: Journal -> String

showList :: [Journal] -> ShowS

Default Journal

Defined in Hledger.Data.Journal

Methods

def :: Journal

Eq Journal

Defined in Hledger.Data.Types

Methods

(==) :: Journal -> Journal -> Bool

(/=) :: Journal -> Journal -> Bool

type Rep Journal

Defined in Hledger.Data.Types

type Rep Journal = D1 ('MetaData "Journal" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 "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 MarketPrice

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

FromJSON MarketPrice

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser MarketPrice

parseJSONList :: Value -> Parser [MarketPrice]

ToJSON MarketPrice

Defined in Hledger.Data.Json

Methods

toJSON :: MarketPrice -> Value

toEncoding :: MarketPrice -> Encoding

toJSONList :: [MarketPrice] -> Value

toEncodingList :: [MarketPrice] -> Encoding

Generic MarketPrice

Defined in Hledger.Data.Types

Associated Types

type Rep MarketPrice :: Type -> Type

Methods

from :: MarketPrice -> Rep MarketPrice x

to :: Rep MarketPrice x -> MarketPrice

Show MarketPrice

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> MarketPrice -> ShowS

show :: MarketPrice -> String

showList :: [MarketPrice] -> ShowS

Eq MarketPrice

Defined in Hledger.Data.Types

Methods

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

(/=) :: MarketPrice -> MarketPrice -> Bool

Ord MarketPrice

Defined in Hledger.Data.Types

Methods

compare :: MarketPrice -> MarketPrice -> Ordering

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

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

(>) :: MarketPrice -> MarketPrice -> Bool

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

max :: MarketPrice -> MarketPrice -> MarketPrice

min :: MarketPrice -> MarketPrice -> MarketPrice

type Rep MarketPrice

Defined in Hledger.Data.Types

type Rep MarketPrice = D1 ('MetaData "MarketPrice" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 PriceDirective

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

ToJSON PriceDirective

Defined in Hledger.Data.Json

Methods

toJSON :: PriceDirective -> Value

toEncoding :: PriceDirective -> Encoding

toJSONList :: [PriceDirective] -> Value

toEncodingList :: [PriceDirective] -> Encoding

Generic PriceDirective

Defined in Hledger.Data.Types

Associated Types

type Rep PriceDirective :: Type -> Type

Methods

from :: PriceDirective -> Rep PriceDirective x

to :: Rep PriceDirective x -> PriceDirective

Show PriceDirective

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> PriceDirective -> ShowS

show :: PriceDirective -> String

showList :: [PriceDirective] -> ShowS

Eq PriceDirective

Defined in Hledger.Data.Types

Methods

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

(/=) :: PriceDirective -> PriceDirective -> Bool

Ord PriceDirective

Defined in Hledger.Data.Types

Methods

compare :: PriceDirective -> PriceDirective -> Ordering

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

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

(>) :: PriceDirective -> PriceDirective -> Bool

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

max :: PriceDirective -> PriceDirective -> PriceDirective

min :: PriceDirective -> PriceDirective -> PriceDirective

type Rep PriceDirective

Defined in Hledger.Data.Types

type Rep PriceDirective = D1 ('MetaData "PriceDirective" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 TimeclockEntry

Constructors

TimeclockEntry

Fields

• tlsourcepos :: SourcePos
• tlcode :: TimeclockCode
• tldatetime :: LocalTime
• tlaccount :: AccountName
• tldescription :: Text

Instances

ToJSON TimeclockEntry

Defined in Hledger.Data.Json

Methods

toJSON :: TimeclockEntry -> Value

toEncoding :: TimeclockEntry -> Encoding

toJSONList :: [TimeclockEntry] -> Value

toEncodingList :: [TimeclockEntry] -> Encoding

Generic TimeclockEntry

Defined in Hledger.Data.Types

Associated Types

type Rep TimeclockEntry :: Type -> Type

Methods

from :: TimeclockEntry -> Rep TimeclockEntry x

to :: Rep TimeclockEntry x -> TimeclockEntry

Show TimeclockEntry

Defined in Hledger.Data.Timeclock

Methods

showsPrec :: Int -> TimeclockEntry -> ShowS

show :: TimeclockEntry -> String

showList :: [TimeclockEntry] -> ShowS

Eq TimeclockEntry

Defined in Hledger.Data.Types

Methods

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

(/=) :: TimeclockEntry -> TimeclockEntry -> Bool

Ord TimeclockEntry

Defined in Hledger.Data.Types

Methods

compare :: TimeclockEntry -> TimeclockEntry -> Ordering

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

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

(>) :: TimeclockEntry -> TimeclockEntry -> Bool

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

max :: TimeclockEntry -> TimeclockEntry -> TimeclockEntry

min :: TimeclockEntry -> TimeclockEntry -> TimeclockEntry

type Rep TimeclockEntry

Defined in Hledger.Data.Types

type Rep TimeclockEntry = D1 ('MetaData "TimeclockEntry" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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)))))

data TimeclockCode

Constructors

SetBalance

SetRequiredHours

In

Out

FinalOut

Instances

ToJSON TimeclockCode

Defined in Hledger.Data.Json

Methods

toJSON :: TimeclockCode -> Value

toEncoding :: TimeclockCode -> Encoding

toJSONList :: [TimeclockCode] -> Value

toEncodingList :: [TimeclockCode] -> Encoding

Generic TimeclockCode

Defined in Hledger.Data.Types

Associated Types

type Rep TimeclockCode :: Type -> Type

Methods

from :: TimeclockCode -> Rep TimeclockCode x

to :: Rep TimeclockCode x -> TimeclockCode

Read TimeclockCode

Defined in Hledger.Data.Timeclock

Methods

readsPrec :: Int -> ReadS TimeclockCode

readList :: ReadS [TimeclockCode]

readPrec :: ReadPrec TimeclockCode

readListPrec :: ReadPrec [TimeclockCode]

Show TimeclockCode

Defined in Hledger.Data.Timeclock

Methods

showsPrec :: Int -> TimeclockCode -> ShowS

show :: TimeclockCode -> String

showList :: [TimeclockCode] -> ShowS

Eq TimeclockCode

Defined in Hledger.Data.Types

Methods

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

(/=) :: TimeclockCode -> TimeclockCode -> Bool

Ord TimeclockCode

Defined in Hledger.Data.Types

Methods

compare :: TimeclockCode -> TimeclockCode -> Ordering

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

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

(>) :: TimeclockCode -> TimeclockCode -> Bool

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

max :: TimeclockCode -> TimeclockCode -> TimeclockCode

min :: TimeclockCode -> TimeclockCode -> TimeclockCode

type Rep TimeclockCode

Defined in Hledger.Data.Types

type Rep TimeclockCode = D1 ('MetaData "TimeclockCode" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 PeriodicTransaction

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.

• ptstatus :: Status

  some of Transaction's fields

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

Instances

ToJSON PeriodicTransaction

Defined in Hledger.Data.Json

Methods

toJSON :: PeriodicTransaction -> Value

toEncoding :: PeriodicTransaction -> Encoding

toJSONList :: [PeriodicTransaction] -> Value

toEncodingList :: [PeriodicTransaction] -> Encoding

Generic PeriodicTransaction

Defined in Hledger.Data.Types

Associated Types

type Rep PeriodicTransaction :: Type -> Type

Methods

from :: PeriodicTransaction -> Rep PeriodicTransaction x

to :: Rep PeriodicTransaction x -> PeriodicTransaction

Show PeriodicTransaction

Defined in Hledger.Data.PeriodicTransaction

Methods

showsPrec :: Int -> PeriodicTransaction -> ShowS

show :: PeriodicTransaction -> String

showList :: [PeriodicTransaction] -> ShowS

Eq PeriodicTransaction

Defined in Hledger.Data.Types

Methods

(==) :: PeriodicTransaction -> PeriodicTransaction -> Bool

(/=) :: PeriodicTransaction -> PeriodicTransaction -> Bool

type Rep PeriodicTransaction

Defined in Hledger.Data.Types

type Rep PeriodicTransaction = D1 ('MetaData "PeriodicTransaction" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 "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 TMPostingRule

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

ToJSON TMPostingRule

Defined in Hledger.Data.Json

Methods

toJSON :: TMPostingRule -> Value

toEncoding :: TMPostingRule -> Encoding

toJSONList :: [TMPostingRule] -> Value

toEncodingList :: [TMPostingRule] -> Encoding

Generic TMPostingRule

Defined in Hledger.Data.Types

Associated Types

type Rep TMPostingRule :: Type -> Type

Methods

from :: TMPostingRule -> Rep TMPostingRule x

to :: Rep TMPostingRule x -> TMPostingRule

Show TMPostingRule

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> TMPostingRule -> ShowS

show :: TMPostingRule -> String

showList :: [TMPostingRule] -> ShowS

Eq TMPostingRule

Defined in Hledger.Data.Types

Methods

(==) :: TMPostingRule -> TMPostingRule -> Bool

(/=) :: TMPostingRule -> TMPostingRule -> Bool

type Rep TMPostingRule

Defined in Hledger.Data.Types

type Rep TMPostingRule = D1 ('MetaData "TMPostingRule" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 TransactionModifier

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

ToJSON TransactionModifier

Defined in Hledger.Data.Json

Methods

toJSON :: TransactionModifier -> Value

toEncoding :: TransactionModifier -> Encoding

toJSONList :: [TransactionModifier] -> Value

toEncodingList :: [TransactionModifier] -> Encoding

Generic TransactionModifier

Defined in Hledger.Data.Types

Associated Types

type Rep TransactionModifier :: Type -> Type

Methods

from :: TransactionModifier -> Rep TransactionModifier x

to :: Rep TransactionModifier x -> TransactionModifier

Show TransactionModifier

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> TransactionModifier -> ShowS

show :: TransactionModifier -> String

showList :: [TransactionModifier] -> ShowS

Eq TransactionModifier

Defined in Hledger.Data.Types

Methods

(==) :: TransactionModifier -> TransactionModifier -> Bool

(/=) :: TransactionModifier -> TransactionModifier -> Bool

type Rep TransactionModifier

Defined in Hledger.Data.Types

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

data Transaction

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

FromJSON Transaction

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Transaction

parseJSONList :: Value -> Parser [Transaction]

ToJSON Transaction

Defined in Hledger.Data.Json

Methods

toJSON :: Transaction -> Value

toEncoding :: Transaction -> Encoding

toJSONList :: [Transaction] -> Value

toEncodingList :: [Transaction] -> Encoding

Generic Transaction

Defined in Hledger.Data.Types

Associated Types

type Rep Transaction :: Type -> Type

Methods

from :: Transaction -> Rep Transaction x

to :: Rep Transaction x -> Transaction

Show Transaction

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Transaction -> ShowS

show :: Transaction -> String

showList :: [Transaction] -> ShowS

Eq Transaction

Defined in Hledger.Data.Types

Methods

(==) :: Transaction -> Transaction -> Bool

(/=) :: Transaction -> Transaction -> Bool

type Rep Transaction

Defined in Hledger.Data.Types

type Rep Transaction = D1 ('MetaData "Transaction" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 Posting

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

FromJSON Posting

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Posting

parseJSONList :: Value -> Parser [Posting]

ToJSON Posting

Defined in Hledger.Data.Json

Methods

toJSON :: Posting -> Value

toEncoding :: Posting -> Encoding

toJSONList :: [Posting] -> Value

toEncodingList :: [Posting] -> Encoding

Generic Posting

Defined in Hledger.Data.Types

Associated Types

type Rep Posting :: Type -> Type

Methods

from :: Posting -> Rep Posting x

to :: Rep Posting x -> Posting

Show Posting

Posting's show instance elides the parent transaction so as not to recurse forever.

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Posting -> ShowS

show :: Posting -> String

showList :: [Posting] -> ShowS

Eq Posting

Defined in Hledger.Data.Types

Methods

(==) :: Posting -> Posting -> Bool

(/=) :: Posting -> Posting -> Bool

type Rep Posting

Defined in Hledger.Data.Types

type Rep Posting = D1 ('MetaData "Posting" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 BalanceAssertion

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

FromJSON BalanceAssertion

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser BalanceAssertion

parseJSONList :: Value -> Parser [BalanceAssertion]

ToJSON BalanceAssertion

Defined in Hledger.Data.Json

Methods

toJSON :: BalanceAssertion -> Value

toEncoding :: BalanceAssertion -> Encoding

toJSONList :: [BalanceAssertion] -> Value

toEncodingList :: [BalanceAssertion] -> Encoding

Generic BalanceAssertion

Defined in Hledger.Data.Types

Associated Types

type Rep BalanceAssertion :: Type -> Type

Methods

from :: BalanceAssertion -> Rep BalanceAssertion x

to :: Rep BalanceAssertion x -> BalanceAssertion

Show BalanceAssertion

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> BalanceAssertion -> ShowS

show :: BalanceAssertion -> String

showList :: [BalanceAssertion] -> ShowS

Eq BalanceAssertion

Defined in Hledger.Data.Types

Methods

(==) :: BalanceAssertion -> BalanceAssertion -> Bool

(/=) :: BalanceAssertion -> BalanceAssertion -> Bool

type Rep BalanceAssertion

Defined in Hledger.Data.Types

type Rep BalanceAssertion = D1 ('MetaData "BalanceAssertion" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 Status

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

FromJSON Status

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Status

parseJSONList :: Value -> Parser [Status]

ToJSON Status

Defined in Hledger.Data.Json

Methods

toJSON :: Status -> Value

toEncoding :: Status -> Encoding

toJSONList :: [Status] -> Value

toEncodingList :: [Status] -> Encoding

Bounded Status

Defined in Hledger.Data.Types

Methods

minBound :: Status

maxBound :: Status

Enum Status

Defined in Hledger.Data.Types

Methods

succ :: Status -> Status

pred :: Status -> Status

toEnum :: Int -> Status

fromEnum :: Status -> Int

enumFrom :: Status -> [Status]

enumFromThen :: Status -> Status -> [Status]

enumFromTo :: Status -> Status -> [Status]

enumFromThenTo :: Status -> Status -> Status -> [Status]

Generic Status

Defined in Hledger.Data.Types

Associated Types

type Rep Status :: Type -> Type

Methods

from :: Status -> Rep Status x

to :: Rep Status x -> Status

Show Status

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

Eq Status

Defined in Hledger.Data.Types

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Ord Status

Defined in Hledger.Data.Types

Methods

compare :: Status -> Status -> Ordering

(<) :: Status -> Status -> Bool

(<=) :: Status -> Status -> Bool

(>) :: Status -> Status -> Bool

(>=) :: Status -> Status -> Bool

max :: Status -> Status -> Status

min :: Status -> Status -> Status

type Rep Status

Defined in Hledger.Data.Types

type Rep Status = D1 ('MetaData "Status" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 DateTag = (TagName, Day)

type Tag

Arguments

 = (TagName, TagValue)

A tag name and (possibly empty) value.

type TagValue = Text

type TagName = Text

data PostingType

Constructors

RegularPosting

VirtualPosting

BalancedVirtualPosting

Instances

FromJSON PostingType

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser PostingType

parseJSONList :: Value -> Parser [PostingType]

ToJSON PostingType

Defined in Hledger.Data.Json

Methods

toJSON :: PostingType -> Value

toEncoding :: PostingType -> Encoding

toJSONList :: [PostingType] -> Value

toEncodingList :: [PostingType] -> Encoding

Generic PostingType

Defined in Hledger.Data.Types

Associated Types

type Rep PostingType :: Type -> Type

Methods

from :: PostingType -> Rep PostingType x

to :: Rep PostingType x -> PostingType

Show PostingType

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> PostingType -> ShowS

show :: PostingType -> String

showList :: [PostingType] -> ShowS

Eq PostingType

Defined in Hledger.Data.Types

Methods

(==) :: PostingType -> PostingType -> Bool

(/=) :: PostingType -> PostingType -> Bool

type Rep PostingType

Defined in Hledger.Data.Types

type Rep PostingType = D1 ('MetaData "PostingType" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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)))

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

pattern MixedAmountKeyNoPrice :: !CommoditySymbol -> MixedAmountKey

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

data MixedAmount

Instances

FromJSON MixedAmount

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser MixedAmount

parseJSONList :: Value -> Parser [MixedAmount]

ToJSON MixedAmount

Defined in Hledger.Data.Json

Methods

toJSON :: MixedAmount -> Value

toEncoding :: MixedAmount -> Encoding

toJSONList :: [MixedAmount] -> Value

toEncodingList :: [MixedAmount] -> Encoding

Monoid MixedAmount

Defined in Hledger.Data.Amount

Methods

mempty :: MixedAmount

mappend :: MixedAmount -> MixedAmount -> MixedAmount

mconcat :: [MixedAmount] -> MixedAmount

Semigroup MixedAmount

Defined in Hledger.Data.Amount

Methods

(<>) :: MixedAmount -> MixedAmount -> MixedAmount

sconcat :: NonEmpty MixedAmount -> MixedAmount

stimes :: Integral b => b -> MixedAmount -> MixedAmount

Generic MixedAmount

Defined in Hledger.Data.Types

Associated Types

type Rep MixedAmount :: Type -> Type

Methods

from :: MixedAmount -> Rep MixedAmount x

to :: Rep MixedAmount x -> MixedAmount

Num MixedAmount

Defined in Hledger.Data.Amount

Methods

(+) :: MixedAmount -> MixedAmount -> MixedAmount

(-) :: MixedAmount -> MixedAmount -> MixedAmount

(*) :: MixedAmount -> MixedAmount -> MixedAmount

negate :: MixedAmount -> MixedAmount

abs :: MixedAmount -> MixedAmount

signum :: MixedAmount -> MixedAmount

fromInteger :: Integer -> MixedAmount

Show MixedAmount

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> MixedAmount -> ShowS

show :: MixedAmount -> String

showList :: [MixedAmount] -> ShowS

Eq MixedAmount

Defined in Hledger.Data.Types

Methods

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

(/=) :: MixedAmount -> MixedAmount -> Bool

Ord MixedAmount

Defined in Hledger.Data.Types

Methods

compare :: MixedAmount -> MixedAmount -> Ordering

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

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

(>) :: MixedAmount -> MixedAmount -> Bool

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

max :: MixedAmount -> MixedAmount -> MixedAmount

min :: MixedAmount -> MixedAmount -> MixedAmount

type Rep MixedAmount

Defined in Hledger.Data.Types

type Rep MixedAmount = D1 ('MetaData "MixedAmount" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" 'True) (C1 ('MetaCons "Mixed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map MixedAmountKey Amount))))

data Amount

Constructors

Amount

Fields

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

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

Instances

FromJSON Amount

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Amount

parseJSONList :: Value -> Parser [Amount]

ToJSON Amount

Defined in Hledger.Data.Json

Methods

toJSON :: Amount -> Value

toEncoding :: Amount -> Encoding

toJSONList :: [Amount] -> Value

toEncodingList :: [Amount] -> Encoding

Generic Amount

Defined in Hledger.Data.Types

Associated Types

type Rep Amount :: Type -> Type

Methods

from :: Amount -> Rep Amount x

to :: Rep Amount x -> Amount

Num Amount

Defined in Hledger.Data.Amount

Methods

(+) :: Amount -> Amount -> Amount

(-) :: Amount -> Amount -> Amount

(*) :: Amount -> Amount -> Amount

negate :: Amount -> Amount

abs :: Amount -> Amount

signum :: Amount -> Amount

fromInteger :: Integer -> Amount

Show Amount

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Amount -> ShowS

show :: Amount -> String

showList :: [Amount] -> ShowS

Eq Amount

Defined in Hledger.Data.Types

Methods

(==) :: Amount -> Amount -> Bool

(/=) :: Amount -> Amount -> Bool

Ord Amount

Defined in Hledger.Data.Types

Methods

compare :: Amount -> Amount -> Ordering

(<) :: Amount -> Amount -> Bool

(<=) :: Amount -> Amount -> Bool

(>) :: Amount -> Amount -> Bool

(>=) :: Amount -> Amount -> Bool

max :: Amount -> Amount -> Amount

min :: Amount -> Amount -> Amount

type Rep Amount

Defined in Hledger.Data.Types

type Rep Amount = D1 ('MetaData "Amount" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 Commodity

Constructors

Commodity

Fields

• csymbol :: CommoditySymbol
• cformat :: Maybe AmountStyle

Instances

ToJSON Commodity

Defined in Hledger.Data.Json

Methods

toJSON :: Commodity -> Value

toEncoding :: Commodity -> Encoding

toJSONList :: [Commodity] -> Value

toEncodingList :: [Commodity] -> Encoding

Generic Commodity

Defined in Hledger.Data.Types

Associated Types

type Rep Commodity :: Type -> Type

Methods

from :: Commodity -> Rep Commodity x

to :: Rep Commodity x -> Commodity

Show Commodity

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Commodity -> ShowS

show :: Commodity -> String

showList :: [Commodity] -> ShowS

Eq Commodity

Defined in Hledger.Data.Types

Methods

(==) :: Commodity -> Commodity -> Bool

(/=) :: Commodity -> Commodity -> Bool

type Rep Commodity

Defined in Hledger.Data.Types

type Rep Commodity = D1 ('MetaData "Commodity" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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))))

type CommoditySymbol = Text

data DigitGroupStyle

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

FromJSON DigitGroupStyle

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser DigitGroupStyle

parseJSONList :: Value -> Parser [DigitGroupStyle]

ToJSON DigitGroupStyle

Defined in Hledger.Data.Json

Methods

toJSON :: DigitGroupStyle -> Value

toEncoding :: DigitGroupStyle -> Encoding

toJSONList :: [DigitGroupStyle] -> Value

toEncodingList :: [DigitGroupStyle] -> Encoding

Generic DigitGroupStyle

Defined in Hledger.Data.Types

Associated Types

type Rep DigitGroupStyle :: Type -> Type

Methods

from :: DigitGroupStyle -> Rep DigitGroupStyle x

to :: Rep DigitGroupStyle x -> DigitGroupStyle

Read DigitGroupStyle

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS DigitGroupStyle

readList :: ReadS [DigitGroupStyle]

readPrec :: ReadPrec DigitGroupStyle

readListPrec :: ReadPrec [DigitGroupStyle]

Show DigitGroupStyle

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> DigitGroupStyle -> ShowS

show :: DigitGroupStyle -> String

showList :: [DigitGroupStyle] -> ShowS

Eq DigitGroupStyle

Defined in Hledger.Data.Types

Methods

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

(/=) :: DigitGroupStyle -> DigitGroupStyle -> Bool

Ord DigitGroupStyle

Defined in Hledger.Data.Types

Methods

compare :: DigitGroupStyle -> DigitGroupStyle -> Ordering

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

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

(>) :: DigitGroupStyle -> DigitGroupStyle -> Bool

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

max :: DigitGroupStyle -> DigitGroupStyle -> DigitGroupStyle

min :: DigitGroupStyle -> DigitGroupStyle -> DigitGroupStyle

type Rep DigitGroupStyle

Defined in Hledger.Data.Types

type Rep DigitGroupStyle = D1 ('MetaData "DigitGroupStyle" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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

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. This can be from 0 to 255 digits (the maximum supported by the Decimal library), or NaturalPrecision meaning "show all significant decimal digits".

Constructors

Precision !Word8

NaturalPrecision

Instances

FromJSON AmountPrecision

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser AmountPrecision

parseJSONList :: Value -> Parser [AmountPrecision]

ToJSON AmountPrecision

Defined in Hledger.Data.Json

Methods

toJSON :: AmountPrecision -> Value

toEncoding :: AmountPrecision -> Encoding

toJSONList :: [AmountPrecision] -> Value

toEncodingList :: [AmountPrecision] -> Encoding

Generic AmountPrecision

Defined in Hledger.Data.Types

Associated Types

type Rep AmountPrecision :: Type -> Type

Methods

from :: AmountPrecision -> Rep AmountPrecision x

to :: Rep AmountPrecision x -> AmountPrecision

Read AmountPrecision

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS AmountPrecision

readList :: ReadS [AmountPrecision]

readPrec :: ReadPrec AmountPrecision

readListPrec :: ReadPrec [AmountPrecision]

Show AmountPrecision

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AmountPrecision -> ShowS

show :: AmountPrecision -> String

showList :: [AmountPrecision] -> ShowS

Eq AmountPrecision

Defined in Hledger.Data.Types

Methods

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

(/=) :: AmountPrecision -> AmountPrecision -> Bool

Ord AmountPrecision

Defined in Hledger.Data.Types

Methods

compare :: AmountPrecision -> AmountPrecision -> Ordering

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

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

(>) :: AmountPrecision -> AmountPrecision -> Bool

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

max :: AmountPrecision -> AmountPrecision -> AmountPrecision

min :: AmountPrecision -> AmountPrecision -> AmountPrecision

type Rep AmountPrecision

Defined in Hledger.Data.Types

type Rep AmountPrecision = D1 ('MetaData "AmountPrecision" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 AmountStyle

Display style for an amount.

Constructors

AmountStyle

Fields

• ascommodityside :: !Side

  does the symbol appear on the left or the right ?

• ascommodityspaced :: !Bool

  space between symbol and quantity ?

• asprecision :: !AmountPrecision

  number of digits displayed after the decimal point

• asdecimalpoint :: !(Maybe Char)

  character used as decimal point: period or comma. Nothing means "unspecified, use default"

• asdigitgroups :: !(Maybe DigitGroupStyle)

  style for displaying digit groups, if any

Instances

FromJSON AmountStyle

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser AmountStyle

parseJSONList :: Value -> Parser [AmountStyle]

ToJSON AmountStyle

Defined in Hledger.Data.Json

Methods

toJSON :: AmountStyle -> Value

toEncoding :: AmountStyle -> Encoding

toJSONList :: [AmountStyle] -> Value

toEncodingList :: [AmountStyle] -> Encoding

Generic AmountStyle

Defined in Hledger.Data.Types

Associated Types

type Rep AmountStyle :: Type -> Type

Methods

from :: AmountStyle -> Rep AmountStyle x

to :: Rep AmountStyle x -> AmountStyle

Read AmountStyle

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS AmountStyle

readList :: ReadS [AmountStyle]

readPrec :: ReadPrec AmountStyle

readListPrec :: ReadPrec [AmountStyle]

Show AmountStyle

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AmountStyle -> ShowS

show :: AmountStyle -> String

showList :: [AmountStyle] -> ShowS

Eq AmountStyle

Defined in Hledger.Data.Types

Methods

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

(/=) :: AmountStyle -> AmountStyle -> Bool

Ord AmountStyle

Defined in Hledger.Data.Types

Methods

compare :: AmountStyle -> AmountStyle -> Ordering

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

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

(>) :: AmountStyle -> AmountStyle -> Bool

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

max :: AmountStyle -> AmountStyle -> AmountStyle

min :: AmountStyle -> AmountStyle -> AmountStyle

type Rep AmountStyle

Defined in Hledger.Data.Types

type Rep AmountStyle = D1 ('MetaData "AmountStyle" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 "asprecision") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 AmountPrecision) :*: (S1 ('MetaSel ('Just "asdecimalpoint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Char)) :*: S1 ('MetaSel ('Just "asdigitgroups") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe DigitGroupStyle))))))

data AmountPrice

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

Constructors

UnitPrice !Amount

TotalPrice !Amount

Instances

FromJSON AmountPrice

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser AmountPrice

parseJSONList :: Value -> Parser [AmountPrice]

ToJSON AmountPrice

Defined in Hledger.Data.Json

Methods

toJSON :: AmountPrice -> Value

toEncoding :: AmountPrice -> Encoding

toJSONList :: [AmountPrice] -> Value

toEncodingList :: [AmountPrice] -> Encoding

Generic AmountPrice

Defined in Hledger.Data.Types

Associated Types

type Rep AmountPrice :: Type -> Type

Methods

from :: AmountPrice -> Rep AmountPrice x

to :: Rep AmountPrice x -> AmountPrice

Show AmountPrice

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AmountPrice -> ShowS

show :: AmountPrice -> String

showList :: [AmountPrice] -> ShowS

Eq AmountPrice

Defined in Hledger.Data.Types

Methods

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

(/=) :: AmountPrice -> AmountPrice -> Bool

Ord AmountPrice

Defined in Hledger.Data.Types

Methods

compare :: AmountPrice -> AmountPrice -> Ordering

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

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

(>) :: AmountPrice -> AmountPrice -> Bool

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

max :: AmountPrice -> AmountPrice -> AmountPrice

min :: AmountPrice -> AmountPrice -> AmountPrice

type Rep AmountPrice

Defined in Hledger.Data.Types

type Rep AmountPrice = D1 ('MetaData "AmountPrice" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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)))

type Quantity = Decimal

The basic numeric type used in amounts.

type DecimalMark = Char

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

data Side

Constructors

L

R

Instances

FromJSON Side

Defined in Hledger.Data.Json

Methods

parseJSON :: Value -> Parser Side

parseJSONList :: Value -> Parser [Side]

ToJSON Side

Defined in Hledger.Data.Json

Methods

toJSON :: Side -> Value

toEncoding :: Side -> Encoding

toJSONList :: [Side] -> Value

toEncodingList :: [Side] -> Encoding

Generic Side

Defined in Hledger.Data.Types

Associated Types

type Rep Side :: Type -> Type

Methods

from :: Side -> Rep Side x

to :: Rep Side x -> Side

Read Side

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS Side

readList :: ReadS [Side]

readPrec :: ReadPrec Side

readListPrec :: ReadPrec [Side]

Show Side

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Side -> ShowS

show :: Side -> String

showList :: [Side] -> ShowS

Eq Side

Defined in Hledger.Data.Types

Methods

(==) :: Side -> Side -> Bool

(/=) :: Side -> Side -> Bool

Ord Side

Defined in Hledger.Data.Types

Methods

compare :: Side -> Side -> Ordering

(<) :: Side -> Side -> Bool

(<=) :: Side -> Side -> Bool

(>) :: Side -> Side -> Bool

(>=) :: Side -> Side -> Bool

max :: Side -> Side -> Side

min :: Side -> Side -> Side

type Rep Side

Defined in Hledger.Data.Types

type Rep Side = D1 ('MetaData "Side" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" 'False) (C1 ('MetaCons "L" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "R" 'PrefixI 'False) (U1 :: Type -> Type))

data AccountAlias

Constructors

BasicAlias AccountName AccountName

RegexAlias Regexp Replacement

Instances

ToJSON AccountAlias

Defined in Hledger.Data.Json

Methods

toJSON :: AccountAlias -> Value

toEncoding :: AccountAlias -> Encoding

toJSONList :: [AccountAlias] -> Value

toEncodingList :: [AccountAlias] -> Encoding

Generic AccountAlias

Defined in Hledger.Data.Types

Associated Types

type Rep AccountAlias :: Type -> Type

Methods

from :: AccountAlias -> Rep AccountAlias x

to :: Rep AccountAlias x -> AccountAlias

Read AccountAlias

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS AccountAlias

readList :: ReadS [AccountAlias]

readPrec :: ReadPrec AccountAlias

readListPrec :: ReadPrec [AccountAlias]

Show AccountAlias

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AccountAlias -> ShowS

show :: AccountAlias -> String

showList :: [AccountAlias] -> ShowS

Eq AccountAlias

Defined in Hledger.Data.Types

Methods

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

(/=) :: AccountAlias -> AccountAlias -> Bool

Ord AccountAlias

Defined in Hledger.Data.Types

Methods

compare :: AccountAlias -> AccountAlias -> Ordering

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

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

(>) :: AccountAlias -> AccountAlias -> Bool

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

max :: AccountAlias -> AccountAlias -> AccountAlias

min :: AccountAlias -> AccountAlias -> AccountAlias

type Rep AccountAlias

Defined in Hledger.Data.Types

type Rep AccountAlias = D1 ('MetaData "AccountAlias" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 AccountType

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

ToJSON AccountType

Defined in Hledger.Data.Json

Methods

toJSON :: AccountType -> Value

toEncoding :: AccountType -> Encoding

toJSONList :: [AccountType] -> Value

toEncodingList :: [AccountType] -> Encoding

ToJSONKey AccountType

Defined in Hledger.Data.Json

Methods

toJSONKey :: ToJSONKeyFunction AccountType

toJSONKeyList :: ToJSONKeyFunction [AccountType]

Generic AccountType

Defined in Hledger.Data.Types

Associated Types

type Rep AccountType :: Type -> Type

Methods

from :: AccountType -> Rep AccountType x

to :: Rep AccountType x -> AccountType

Show AccountType

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AccountType -> ShowS

show :: AccountType -> String

showList :: [AccountType] -> ShowS

Eq AccountType

Defined in Hledger.Data.Types

Methods

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

(/=) :: AccountType -> AccountType -> Bool

Ord AccountType

Defined in Hledger.Data.Types

Methods

compare :: AccountType -> AccountType -> Ordering

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

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

(>) :: AccountType -> AccountType -> Bool

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

max :: AccountType -> AccountType -> AccountType

min :: AccountType -> AccountType -> AccountType

type Rep AccountType

Defined in Hledger.Data.Types

type Rep AccountType = D1 ('MetaData "AccountType" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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))))

type AccountName = Text

type Payee = Text

data Interval

Constructors

NoInterval

Days Int

Weeks Int

Months Int

Quarters Int

Years Int

DayOfMonth Int

WeekdayOfMonth Int Int

DaysOfWeek [Int]

DayOfYear Int Int

Instances

ToJSON Interval

Defined in Hledger.Data.Json

Methods

toJSON :: Interval -> Value

toEncoding :: Interval -> Encoding

toJSONList :: [Interval] -> Value

toEncodingList :: [Interval] -> Encoding

Generic Interval

Defined in Hledger.Data.Types

Associated Types

type Rep Interval :: Type -> Type

Methods

from :: Interval -> Rep Interval x

to :: Rep Interval x -> Interval

Show Interval

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Interval -> ShowS

show :: Interval -> String

showList :: [Interval] -> ShowS

Default Interval

Defined in Hledger.Data.Types

Methods

def :: Interval

Eq Interval

Defined in Hledger.Data.Types

Methods

(==) :: Interval -> Interval -> Bool

(/=) :: Interval -> Interval -> Bool

Ord Interval

Defined in Hledger.Data.Types

Methods

compare :: Interval -> Interval -> Ordering

(<) :: Interval -> Interval -> Bool

(<=) :: Interval -> Interval -> Bool

(>) :: Interval -> Interval -> Bool

(>=) :: Interval -> Interval -> Bool

max :: Interval -> Interval -> Interval

min :: Interval -> Interval -> Interval

type Rep Interval

Defined in Hledger.Data.Types

type Rep Interval = D1 ('MetaData "Interval" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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))))))

data Period

Constructors

DayPeriod Day

WeekPeriod Day

MonthPeriod Year Month

QuarterPeriod Year Quarter

YearPeriod Year

PeriodBetween Day Day

PeriodFrom Day

PeriodTo Day

PeriodAll

Instances

ToJSON Period

Defined in Hledger.Data.Json

Methods

toJSON :: Period -> Value

toEncoding :: Period -> Encoding

toJSONList :: [Period] -> Value

toEncodingList :: [Period] -> Encoding

Generic Period

Defined in Hledger.Data.Types

Associated Types

type Rep Period :: Type -> Type

Methods

from :: Period -> Rep Period x

to :: Rep Period x -> Period

Show Period

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Period -> ShowS

show :: Period -> String

showList :: [Period] -> ShowS

Default Period

Defined in Hledger.Data.Types

Methods

def :: Period

Eq Period

Defined in Hledger.Data.Types

Methods

(==) :: Period -> Period -> Bool

(/=) :: Period -> Period -> Bool

Ord Period

Defined in Hledger.Data.Types

Methods

compare :: Period -> Period -> Ordering

(<) :: Period -> Period -> Bool

(<=) :: Period -> Period -> Bool

(>) :: Period -> Period -> Bool

(>=) :: Period -> Period -> Bool

max :: Period -> Period -> Period

min :: Period -> Period -> Period

type Rep Period

Defined in Hledger.Data.Types

type Rep Period = D1 ('MetaData "Period" "Hledger.Data.Types" "hledger-lib-1.28-1sYuTIz9MN21SCq5RkjAmv" '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 DateSpan

Constructors

DateSpan (Maybe Day) (Maybe Day)

Instances

ToJSON DateSpan

Defined in Hledger.Data.Json

Methods

toJSON :: DateSpan -> Value

toEncoding :: DateSpan -> Encoding

toJSONList :: [DateSpan] -> Value

toEncodingList :: [DateSpan] -> Encoding

Generic DateSpan

Defined in Hledger.Data.Types

Associated Types

type Rep DateSpan :: Type -> Type

Methods

from :: DateSpan -> Rep DateSpan x

to :: Rep DateSpan x -> DateSpan

Show DateSpan

Defined in Hledger.Data.Dates

Methods

showsPrec :: Int -> DateSpan -> ShowS

show :: DateSpan -> String

showList :: [DateSpan] -> ShowS

Default DateSpan

Defined in Hledger.Data.Types

Methods

def :: DateSpan

Eq DateSpan

Defined in Hledger.Data.Types

Methods

(==) :: DateSpan -> DateSpan -> Bool

(/=) :: DateSpan -> DateSpan -> Bool

Ord DateSpan

Defined in Hledger.Data.Types

Methods

compare :: DateSpan -> DateSpan -> Ordering

(<) :: DateSpan -> DateSpan -> Bool

(<=) :: DateSpan -> DateSpan -> Bool

(>) :: DateSpan -> DateSpan -> Bool

(>=) :: DateSpan -> DateSpan -> Bool

max :: DateSpan -> DateSpan -> DateSpan

min :: DateSpan -> DateSpan -> DateSpan

type Rep DateSpan

Defined in Hledger.Data.Types

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

data WhichDate

Constructors

PrimaryDate

SecondaryDate

Instances

Show WhichDate

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> WhichDate -> ShowS

show :: WhichDate -> String

showList :: [WhichDate] -> ShowS

Eq WhichDate

Defined in Hledger.Data.Types

Methods

(==) :: WhichDate -> WhichDate -> Bool

(/=) :: WhichDate -> WhichDate -> Bool

data SmartInterval

Constructors

Day

Week

Month

Quarter

Year

Instances

Show SmartInterval

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> SmartInterval -> ShowS

show :: SmartInterval -> String

showList :: [SmartInterval] -> ShowS

data SmartDate

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

Show SmartDate

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> SmartDate -> ShowS

show :: SmartDate -> String

showList :: [SmartDate] -> ShowS

type WeekDay = Int

type MonthDay = Int

type YearDay = Int

type MonthWeek = Int

type YearWeek = Int

type Quarter = Int

type Month = Int

isBalanceSheetAccountType :: AccountType -> Bool

isIncomeStatementAccountType :: AccountType -> Bool

isAccountSubtypeOf :: AccountType -> AccountType -> Bool

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

isDecimalMark :: Char -> Bool

maCompare :: MixedAmount -> MixedAmount -> Ordering

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

nulltransactionmodifier :: TransactionModifier

nullperiodictransaction :: PeriodicTransaction

nullpayeedeclarationinfo :: PayeeDeclarationInfo

nullaccountdeclarationinfo :: AccountDeclarationInfo

module Hledger.Data.Valuation

tests_Data :: TestTree