Hledger.Data.Types

Most data types are defined here to avoid import cycles. Here is an overview of the hledger data model:

Journal                  -- a journal is read from one or more data files. It contains..
 [Transaction]           -- journal transactions (aka entries), which have date, cleared status, code, description and..
  [Posting]              -- multiple account postings, which have account name and amount
 [MarketPrice]           -- historical market prices for commodities

Ledger                   -- a ledger is derived from a journal, by applying a filter specification and doing some further processing. It contains..
 Journal                 -- a filtered copy of the original journal, containing only the transactions and postings we are interested in
 [Account]               -- all accounts, in tree order beginning with a "root" account", with their balances and sub/parent accounts

For more detailed documentation on each type, see the corresponding modules.

Documentation

type SmartDate = (String, String, String)

A possibly incomplete date, whose missing parts will be filled from a reference date. A numeric year, month, and day of month, or the empty string for any of these. See the smartdate parser.

data WhichDate

Constructors

PrimaryDate

SecondaryDate

Instances

Eq WhichDate

Defined in Hledger.Data.Types

Methods

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

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

Show WhichDate

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> WhichDate -> ShowS

show :: WhichDate -> String

showList :: [WhichDate] -> ShowS

data DateSpan

Constructors

DateSpan (Maybe Day) (Maybe Day)

Instances

Eq DateSpan

Defined in Hledger.Data.Types

Methods

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

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

Data DateSpan

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DateSpan -> c DateSpan

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DateSpan

toConstr :: DateSpan -> Constr

dataTypeOf :: DateSpan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DateSpan)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DateSpan)

gmapT :: (forall b. Data b => b -> b) -> DateSpan -> DateSpan

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DateSpan -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DateSpan -> r

gmapQ :: (forall d. Data d => d -> u) -> DateSpan -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DateSpan -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DateSpan -> m DateSpan

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DateSpan -> m DateSpan

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DateSpan -> m DateSpan

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

Show DateSpan

Defined in Hledger.Data.Dates

Methods

showsPrec :: Int -> DateSpan -> ShowS

show :: DateSpan -> String

showList :: [DateSpan] -> ShowS

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

Default DateSpan

Defined in Hledger.Data.Types

Methods

def :: DateSpan

NFData DateSpan

Defined in Hledger.Data.Types

Methods

rnf :: DateSpan -> ()

type Rep DateSpan

Defined in Hledger.Data.Types

type Rep DateSpan = D1 (MetaData "DateSpan" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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))))

type Year = Integer

type Month = Int

type Quarter = Int

type YearWeek = Int

type MonthWeek = Int

type YearDay = Int

type MonthDay = Int

type WeekDay = 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

Eq Period

Defined in Hledger.Data.Types

Methods

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

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

Data Period

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Period -> c Period

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Period

toConstr :: Period -> Constr

dataTypeOf :: Period -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Period)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Period)

gmapT :: (forall b. Data b => b -> b) -> Period -> Period

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Period -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Period -> r

gmapQ :: (forall d. Data d => d -> u) -> Period -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Period -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Period -> m Period

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Period -> m Period

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Period -> m Period

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

Show Period

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Period -> ShowS

show :: Period -> String

showList :: [Period] -> ShowS

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

Default Period

Defined in Hledger.Data.Types

Methods

def :: Period

type Rep Period

Defined in Hledger.Data.Types

type Rep Period = D1 (MetaData "Period" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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 Interval

Constructors

NoInterval

Days Int

Weeks Int

Months Int

Quarters Int

Years Int

DayOfMonth Int

WeekdayOfMonth Int Int

DayOfWeek Int

DayOfYear Int Int

Instances

Eq Interval

Defined in Hledger.Data.Types

Methods

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

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

Data Interval

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Interval -> c Interval

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Interval

toConstr :: Interval -> Constr

dataTypeOf :: Interval -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Interval)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Interval)

gmapT :: (forall b. Data b => b -> b) -> Interval -> Interval

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Interval -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Interval -> r

gmapQ :: (forall d. Data d => d -> u) -> Interval -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Interval -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Interval -> m Interval

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Interval -> m Interval

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Interval -> m Interval

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

Show Interval

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Interval -> ShowS

show :: Interval -> String

showList :: [Interval] -> ShowS

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

Default Interval

Defined in Hledger.Data.Types

Methods

def :: Interval

NFData Interval

Defined in Hledger.Data.Types

Methods

rnf :: Interval -> ()

type Rep Interval

Defined in Hledger.Data.Types

type Rep Interval = D1 (MetaData "Interval" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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 "DayOfWeek" 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 AccountName = Text

data AccountType

Constructors

Asset

Liability

Equity

Revenue

Expense

Instances

Eq AccountType

Defined in Hledger.Data.Types

Methods

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

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

Data AccountType

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AccountType -> c AccountType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AccountType

toConstr :: AccountType -> Constr

dataTypeOf :: AccountType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AccountType)

gmapT :: (forall b. Data b => b -> b) -> AccountType -> AccountType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AccountType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AccountType -> r

gmapQ :: (forall d. Data d => d -> u) -> AccountType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AccountType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AccountType -> m AccountType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountType -> m AccountType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountType -> m AccountType

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

Show AccountType

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> AccountType -> ShowS

show :: AccountType -> String

showList :: [AccountType] -> ShowS

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

NFData AccountType

Defined in Hledger.Data.Types

Methods

rnf :: AccountType -> ()

type Rep AccountType

Defined in Hledger.Data.Types

type Rep AccountType = D1 (MetaData "AccountType" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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))))

data AccountAlias

Constructors

BasicAlias AccountName AccountName

RegexAlias Regexp Replacement

Instances

Eq AccountAlias

Defined in Hledger.Data.Types

Methods

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

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

Data AccountAlias

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AccountAlias -> c AccountAlias

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AccountAlias

toConstr :: AccountAlias -> Constr

dataTypeOf :: AccountAlias -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountAlias)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AccountAlias)

gmapT :: (forall b. Data b => b -> b) -> AccountAlias -> AccountAlias

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AccountAlias -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AccountAlias -> r

gmapQ :: (forall d. Data d => d -> u) -> AccountAlias -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AccountAlias -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AccountAlias -> m AccountAlias

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountAlias -> m AccountAlias

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AccountAlias -> m AccountAlias

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

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

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

NFData AccountAlias

Defined in Hledger.Data.Types

Methods

rnf :: AccountAlias -> ()

type Rep AccountAlias

Defined in Hledger.Data.Types

type Rep AccountAlias = D1 (MetaData "AccountAlias" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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

Constructors

L

R

Instances

Eq Side

Defined in Hledger.Data.Types

Methods

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

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

Data Side

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Side -> c Side

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Side

toConstr :: Side -> Constr

dataTypeOf :: Side -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Side)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Side)

gmapT :: (forall b. Data b => b -> b) -> Side -> Side

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Side -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Side -> r

gmapQ :: (forall d. Data d => d -> u) -> Side -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Side -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Side -> m Side

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Side -> m Side

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Side -> m Side

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

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

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

NFData Side

Defined in Hledger.Data.Types

Methods

rnf :: Side -> ()

type Rep Side

Defined in Hledger.Data.Types

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

type Quantity = Decimal

The basic numeric type used in amounts.

data Price

An amount's price (none, per unit, or total) in another commodity. The price amount should always be positive.

Constructors

NoPrice

UnitPrice Amount

TotalPrice Amount

Instances

Eq Price

Defined in Hledger.Data.Types

Methods

(==) :: Price -> Price -> Bool

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

Data Price

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Price -> c Price

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Price

toConstr :: Price -> Constr

dataTypeOf :: Price -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Price)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Price)

gmapT :: (forall b. Data b => b -> b) -> Price -> Price

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Price -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Price -> r

gmapQ :: (forall d. Data d => d -> u) -> Price -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Price -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Price -> m Price

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Price -> m Price

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Price -> m Price

Ord Price

Defined in Hledger.Data.Types

Methods

compare :: Price -> Price -> Ordering

(<) :: Price -> Price -> Bool

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

(>) :: Price -> Price -> Bool

(>=) :: Price -> Price -> Bool

max :: Price -> Price -> Price

min :: Price -> Price -> Price

Show Price

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Price -> ShowS

show :: Price -> String

showList :: [Price] -> ShowS

Generic Price

Defined in Hledger.Data.Types

Associated Types

type Rep Price :: Type -> Type

Methods

from :: Price -> Rep Price x

to :: Rep Price x -> Price

NFData Price

Defined in Hledger.Data.Types

Methods

rnf :: Price -> ()

type Rep Price

Defined in Hledger.Data.Types

type Rep Price = D1 (MetaData "Price" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "NoPrice" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "UnitPrice" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Amount)) :+: C1 (MetaCons "TotalPrice" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Amount))))

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 :: !Int

  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

Eq AmountStyle

Defined in Hledger.Data.Types

Methods

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

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

Data AmountStyle

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AmountStyle -> c AmountStyle

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AmountStyle

toConstr :: AmountStyle -> Constr

dataTypeOf :: AmountStyle -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AmountStyle)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AmountStyle)

gmapT :: (forall b. Data b => b -> b) -> AmountStyle -> AmountStyle

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AmountStyle -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AmountStyle -> r

gmapQ :: (forall d. Data d => d -> u) -> AmountStyle -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> AmountStyle -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AmountStyle -> m AmountStyle

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AmountStyle -> m AmountStyle

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AmountStyle -> m AmountStyle

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

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

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

NFData AmountStyle

Defined in Hledger.Data.Types

Methods

rnf :: AmountStyle -> ()

type Rep AmountStyle

Defined in Hledger.Data.Types

type Rep AmountStyle = D1 (MetaData "AmountStyle" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "AmountStyle" PrefixI True) ((S1 (MetaSel (Just "ascommodityside") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Side) :*: S1 (MetaSel (Just "ascommodityspaced") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :*: (S1 (MetaSel (Just "asprecision") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "asdecimalpoint") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Char)) :*: S1 (MetaSel (Just "asdigitgroups") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe DigitGroupStyle))))))

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 [Int]

Instances

Eq DigitGroupStyle

Defined in Hledger.Data.Types

Methods

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

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

Data DigitGroupStyle

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DigitGroupStyle -> c DigitGroupStyle

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DigitGroupStyle

toConstr :: DigitGroupStyle -> Constr

dataTypeOf :: DigitGroupStyle -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DigitGroupStyle)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DigitGroupStyle)

gmapT :: (forall b. Data b => b -> b) -> DigitGroupStyle -> DigitGroupStyle

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DigitGroupStyle -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DigitGroupStyle -> r

gmapQ :: (forall d. Data d => d -> u) -> DigitGroupStyle -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DigitGroupStyle -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DigitGroupStyle -> m DigitGroupStyle

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DigitGroupStyle -> m DigitGroupStyle

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DigitGroupStyle -> m DigitGroupStyle

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

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

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

NFData DigitGroupStyle

Defined in Hledger.Data.Types

Methods

rnf :: DigitGroupStyle -> ()

type Rep DigitGroupStyle

Defined in Hledger.Data.Types

type Rep DigitGroupStyle = D1 (MetaData "DigitGroupStyle" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "DigitGroups" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Char) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Int])))

type CommoditySymbol = Text

data Commodity

Constructors

Commodity

Fields

• csymbol :: CommoditySymbol
• cformat :: Maybe AmountStyle

Instances

Eq Commodity

Defined in Hledger.Data.Types

Methods

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

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

Data Commodity

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Commodity -> c Commodity

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Commodity

toConstr :: Commodity -> Constr

dataTypeOf :: Commodity -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Commodity)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Commodity)

gmapT :: (forall b. Data b => b -> b) -> Commodity -> Commodity

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Commodity -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Commodity -> r

gmapQ :: (forall d. Data d => d -> u) -> Commodity -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Commodity -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Commodity -> m Commodity

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Commodity -> m Commodity

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Commodity -> m Commodity

Show Commodity

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Commodity -> ShowS

show :: Commodity -> String

showList :: [Commodity] -> ShowS

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

NFData Commodity

Defined in Hledger.Data.Types

Methods

rnf :: Commodity -> ()

type Rep Commodity

Defined in Hledger.Data.Types

type Rep Commodity = D1 (MetaData "Commodity" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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))))

data Amount

Constructors

Amount

Fields

• acommodity :: CommoditySymbol
• aquantity :: Quantity
• aprice :: Price

  the (fixed) price for this amount, if any

• astyle :: AmountStyle
• amultiplier :: Bool

  kludge: a flag marking this amount and posting as a multiplier in a TMPostingRule. In a regular Posting, should always be false.

Instances

Eq Amount

Defined in Hledger.Data.Types

Methods

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

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

Data Amount

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Amount -> c Amount

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Amount

toConstr :: Amount -> Constr

dataTypeOf :: Amount -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Amount)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Amount)

gmapT :: (forall b. Data b => b -> b) -> Amount -> Amount

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Amount -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Amount -> r

gmapQ :: (forall d. Data d => d -> u) -> Amount -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Amount -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Amount -> m Amount

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Amount -> m Amount

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Amount -> m 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

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

Show Amount

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Amount -> ShowS

show :: Amount -> String

showList :: [Amount] -> ShowS

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

NFData Amount

Defined in Hledger.Data.Types

Methods

rnf :: Amount -> ()

type Rep Amount

Defined in Hledger.Data.Types

type Rep Amount = D1 (MetaData "Amount" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "Amount" PrefixI True) ((S1 (MetaSel (Just "acommodity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CommoditySymbol) :*: S1 (MetaSel (Just "aquantity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Quantity)) :*: (S1 (MetaSel (Just "aprice") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Price) :*: (S1 (MetaSel (Just "astyle") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 AmountStyle) :*: S1 (MetaSel (Just "amultiplier") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))))

newtype MixedAmount

Constructors

Mixed [Amount]

Instances

Eq MixedAmount

Defined in Hledger.Data.Types

Methods

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

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

Data MixedAmount

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MixedAmount -> c MixedAmount

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MixedAmount

toConstr :: MixedAmount -> Constr

dataTypeOf :: MixedAmount -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MixedAmount)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MixedAmount)

gmapT :: (forall b. Data b => b -> b) -> MixedAmount -> MixedAmount

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MixedAmount -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MixedAmount -> r

gmapQ :: (forall d. Data d => d -> u) -> MixedAmount -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MixedAmount -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MixedAmount -> m MixedAmount

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MixedAmount -> m MixedAmount

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MixedAmount -> m 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

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

Show MixedAmount

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> MixedAmount -> ShowS

show :: MixedAmount -> String

showList :: [MixedAmount] -> ShowS

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

NFData MixedAmount

Defined in Hledger.Data.Types

Methods

rnf :: MixedAmount -> ()

type Rep MixedAmount

Defined in Hledger.Data.Types

type Rep MixedAmount = D1 (MetaData "MixedAmount" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" True) (C1 (MetaCons "Mixed" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Amount])))

data PostingType

Constructors

RegularPosting

VirtualPosting

BalancedVirtualPosting

Instances

Eq PostingType

Defined in Hledger.Data.Types

Methods

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

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

Data PostingType

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PostingType -> c PostingType

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PostingType

toConstr :: PostingType -> Constr

dataTypeOf :: PostingType -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PostingType)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PostingType)

gmapT :: (forall b. Data b => b -> b) -> PostingType -> PostingType

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PostingType -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PostingType -> r

gmapQ :: (forall d. Data d => d -> u) -> PostingType -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PostingType -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PostingType -> m PostingType

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PostingType -> m PostingType

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PostingType -> m PostingType

Show PostingType

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> PostingType -> ShowS

show :: PostingType -> String

showList :: [PostingType] -> ShowS

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

NFData PostingType

Defined in Hledger.Data.Types

Methods

rnf :: PostingType -> ()

type Rep PostingType

Defined in Hledger.Data.Types

type Rep PostingType = D1 (MetaData "PostingType" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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

type TagValue = Text

type Tag

Arguments

 = (TagName, TagValue)

A tag name and (possibly empty) value.

type DateTag = (TagName, Day)

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

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]

Eq Status

Defined in Hledger.Data.Types

Methods

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

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

Data Status

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status

toConstr :: Status -> Constr

dataTypeOf :: Status -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status)

gmapT :: (forall b. Data b => b -> b) -> Status -> Status

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r

gmapQ :: (forall d. Data d => d -> u) -> Status -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status

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

Show Status

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

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

NFData Status

Defined in Hledger.Data.Types

Methods

rnf :: Status -> ()

type Rep Status

Defined in Hledger.Data.Types

type Rep Status = D1 (MetaData "Status" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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)))

data BalanceAssertion

The amount to compare an account's balance to, to verify that the history leading to a given point is correct or to set the account to a known value.

Constructors

BalanceAssertion

Fields

• baamount :: Amount

  the expected value of a particular commodity

• baexact :: Bool

  whether the assertion is exclusive, and doesn't allow other commodities alongside baamount

• baposition :: GenericSourcePos

Instances

Eq BalanceAssertion

Defined in Hledger.Data.Types

Methods

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

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

Data BalanceAssertion

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BalanceAssertion -> c BalanceAssertion

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BalanceAssertion

toConstr :: BalanceAssertion -> Constr

dataTypeOf :: BalanceAssertion -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BalanceAssertion)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BalanceAssertion)

gmapT :: (forall b. Data b => b -> b) -> BalanceAssertion -> BalanceAssertion

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BalanceAssertion -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BalanceAssertion -> r

gmapQ :: (forall d. Data d => d -> u) -> BalanceAssertion -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> BalanceAssertion -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BalanceAssertion -> m BalanceAssertion

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceAssertion -> m BalanceAssertion

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BalanceAssertion -> m BalanceAssertion

Show BalanceAssertion

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> BalanceAssertion -> ShowS

show :: BalanceAssertion -> String

showList :: [BalanceAssertion] -> ShowS

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

NFData BalanceAssertion

Defined in Hledger.Data.Types

Methods

rnf :: BalanceAssertion -> ()

type Rep BalanceAssertion

Defined in Hledger.Data.Types

type Rep BalanceAssertion = D1 (MetaData "BalanceAssertion" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "BalanceAssertion" PrefixI True) (S1 (MetaSel (Just "baamount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Amount) :*: (S1 (MetaSel (Just "baexact") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :*: S1 (MetaSel (Just "baposition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 GenericSourcePos))))

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 comment

• pbalanceassertion :: Maybe BalanceAssertion

  optional: the expected balance in this commodity in the account after this posting

• ptransaction :: Maybe Transaction

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

• porigin :: 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

Eq Posting

Defined in Hledger.Data.Types

Methods

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

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

Data Posting

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Posting -> c Posting

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Posting

toConstr :: Posting -> Constr

dataTypeOf :: Posting -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Posting)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Posting)

gmapT :: (forall b. Data b => b -> b) -> Posting -> Posting

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Posting -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Posting -> r

gmapQ :: (forall d. Data d => d -> u) -> Posting -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Posting -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Posting -> m Posting

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Posting -> m Posting

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Posting -> m 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

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

NFData Posting

Defined in Hledger.Data.Types

Methods

rnf :: Posting -> ()

type Rep Posting

Defined in Hledger.Data.Types

type Rep Posting = D1 (MetaData "Posting" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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 "porigin") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Posting)))))))

data GenericSourcePos

The position of parse errors (eg), like parsec's SourcePos but generic.

Constructors

GenericSourcePos FilePath Int Int

file path, 1-based line number and 1-based column number.

JournalSourcePos FilePath (Int, Int)

file path, inclusive range of 1-based line numbers (first, last).

Instances

Eq GenericSourcePos

Defined in Hledger.Data.Types

Methods

(==) :: GenericSourcePos -> GenericSourcePos -> Bool

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

Data GenericSourcePos

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GenericSourcePos -> c GenericSourcePos

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GenericSourcePos

toConstr :: GenericSourcePos -> Constr

dataTypeOf :: GenericSourcePos -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GenericSourcePos)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GenericSourcePos)

gmapT :: (forall b. Data b => b -> b) -> GenericSourcePos -> GenericSourcePos

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GenericSourcePos -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GenericSourcePos -> r

gmapQ :: (forall d. Data d => d -> u) -> GenericSourcePos -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GenericSourcePos -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GenericSourcePos -> m GenericSourcePos

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericSourcePos -> m GenericSourcePos

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GenericSourcePos -> m GenericSourcePos

Ord GenericSourcePos

Defined in Hledger.Data.Types

Methods

compare :: GenericSourcePos -> GenericSourcePos -> Ordering

(<) :: GenericSourcePos -> GenericSourcePos -> Bool

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

(>) :: GenericSourcePos -> GenericSourcePos -> Bool

(>=) :: GenericSourcePos -> GenericSourcePos -> Bool

max :: GenericSourcePos -> GenericSourcePos -> GenericSourcePos

min :: GenericSourcePos -> GenericSourcePos -> GenericSourcePos

Read GenericSourcePos

Defined in Hledger.Data.Types

Methods

readsPrec :: Int -> ReadS GenericSourcePos

readList :: ReadS [GenericSourcePos]

readPrec :: ReadPrec GenericSourcePos

readListPrec :: ReadPrec [GenericSourcePos]

Show GenericSourcePos

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> GenericSourcePos -> ShowS

show :: GenericSourcePos -> String

showList :: [GenericSourcePos] -> ShowS

Generic GenericSourcePos

Defined in Hledger.Data.Types

Associated Types

type Rep GenericSourcePos :: Type -> Type

Methods

from :: GenericSourcePos -> Rep GenericSourcePos x

to :: Rep GenericSourcePos x -> GenericSourcePos

NFData GenericSourcePos

Defined in Hledger.Data.Types

Methods

rnf :: GenericSourcePos -> ()

type Rep GenericSourcePos

Defined in Hledger.Data.Types

type Rep GenericSourcePos = D1 (MetaData "GenericSourcePos" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "GenericSourcePos" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))) :+: C1 (MetaCons "JournalSourcePos" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Int, Int))))

data Transaction

Constructors

Transaction

Fields

• tindex :: Integer

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

• tsourcepos :: GenericSourcePos
• 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

• tpreceding_comment_lines :: Text

  any comment lines immediately preceding this transaction

Instances

Eq Transaction

Defined in Hledger.Data.Types

Methods

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

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

Data Transaction

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Transaction -> c Transaction

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Transaction

toConstr :: Transaction -> Constr

dataTypeOf :: Transaction -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Transaction)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Transaction)

gmapT :: (forall b. Data b => b -> b) -> Transaction -> Transaction

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Transaction -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Transaction -> r

gmapQ :: (forall d. Data d => d -> u) -> Transaction -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Transaction -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Transaction -> m Transaction

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Transaction -> m Transaction

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Transaction -> m Transaction

Show Transaction

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> Transaction -> ShowS

show :: Transaction -> String

showList :: [Transaction] -> ShowS

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

NFData Transaction

Defined in Hledger.Data.Types

Methods

rnf :: Transaction -> ()

type Rep Transaction

Defined in Hledger.Data.Types

type Rep Transaction = D1 (MetaData "Transaction" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "Transaction" PrefixI True) (((S1 (MetaSel (Just "tindex") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer) :*: S1 (MetaSel (Just "tsourcepos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 GenericSourcePos)) :*: (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]) :*: S1 (MetaSel (Just "tpreceding_comment_lines") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))))

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

Eq TransactionModifier

Defined in Hledger.Data.Types

Methods

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

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

Data TransactionModifier

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TransactionModifier -> c TransactionModifier

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TransactionModifier

toConstr :: TransactionModifier -> Constr

dataTypeOf :: TransactionModifier -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TransactionModifier)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TransactionModifier)

gmapT :: (forall b. Data b => b -> b) -> TransactionModifier -> TransactionModifier

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TransactionModifier -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TransactionModifier -> r

gmapQ :: (forall d. Data d => d -> u) -> TransactionModifier -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TransactionModifier -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TransactionModifier -> m TransactionModifier

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TransactionModifier -> m TransactionModifier

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TransactionModifier -> m TransactionModifier

Show TransactionModifier

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> TransactionModifier -> ShowS

show :: TransactionModifier -> String

showList :: [TransactionModifier] -> ShowS

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

NFData TransactionModifier

Defined in Hledger.Data.Types

Methods

rnf :: TransactionModifier -> ()

type Rep TransactionModifier

Defined in Hledger.Data.Types

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

nulltransactionmodifier :: TransactionModifier

type TMPostingRule = Posting

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

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

Eq PeriodicTransaction

Defined in Hledger.Data.Types

Methods

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

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

Data PeriodicTransaction

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PeriodicTransaction -> c PeriodicTransaction

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PeriodicTransaction

toConstr :: PeriodicTransaction -> Constr

dataTypeOf :: PeriodicTransaction -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PeriodicTransaction)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PeriodicTransaction)

gmapT :: (forall b. Data b => b -> b) -> PeriodicTransaction -> PeriodicTransaction

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PeriodicTransaction -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PeriodicTransaction -> r

gmapQ :: (forall d. Data d => d -> u) -> PeriodicTransaction -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PeriodicTransaction -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PeriodicTransaction -> m PeriodicTransaction

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PeriodicTransaction -> m PeriodicTransaction

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PeriodicTransaction -> m PeriodicTransaction

Show PeriodicTransaction

Defined in Hledger.Data.PeriodicTransaction

Methods

showsPrec :: Int -> PeriodicTransaction -> ShowS

show :: PeriodicTransaction -> String

showList :: [PeriodicTransaction] -> ShowS

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

NFData PeriodicTransaction

Defined in Hledger.Data.Types

Methods

rnf :: PeriodicTransaction -> ()

type Rep PeriodicTransaction

Defined in Hledger.Data.Types

type Rep PeriodicTransaction = D1 (MetaData "PeriodicTransaction" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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]))))))

nullperiodictransaction :: PeriodicTransaction

data TimeclockCode

Constructors

SetBalance

SetRequiredHours

In

Out

FinalOut

Instances

Eq TimeclockCode

Defined in Hledger.Data.Types

Methods

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

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

Data TimeclockCode

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TimeclockCode -> c TimeclockCode

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TimeclockCode

toConstr :: TimeclockCode -> Constr

dataTypeOf :: TimeclockCode -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TimeclockCode)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TimeclockCode)

gmapT :: (forall b. Data b => b -> b) -> TimeclockCode -> TimeclockCode

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TimeclockCode -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TimeclockCode -> r

gmapQ :: (forall d. Data d => d -> u) -> TimeclockCode -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TimeclockCode -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TimeclockCode -> m TimeclockCode

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TimeclockCode -> m TimeclockCode

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TimeclockCode -> m TimeclockCode

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

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

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

NFData TimeclockCode

Defined in Hledger.Data.Types

Methods

rnf :: TimeclockCode -> ()

type Rep TimeclockCode

Defined in Hledger.Data.Types

type Rep TimeclockCode = D1 (MetaData "TimeclockCode" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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

Constructors

TimeclockEntry

Fields

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

Instances

Eq TimeclockEntry

Defined in Hledger.Data.Types

Methods

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

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

Data TimeclockEntry

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TimeclockEntry -> c TimeclockEntry

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TimeclockEntry

toConstr :: TimeclockEntry -> Constr

dataTypeOf :: TimeclockEntry -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TimeclockEntry)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TimeclockEntry)

gmapT :: (forall b. Data b => b -> b) -> TimeclockEntry -> TimeclockEntry

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TimeclockEntry -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TimeclockEntry -> r

gmapQ :: (forall d. Data d => d -> u) -> TimeclockEntry -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TimeclockEntry -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TimeclockEntry -> m TimeclockEntry

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TimeclockEntry -> m TimeclockEntry

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TimeclockEntry -> m TimeclockEntry

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

Show TimeclockEntry

Defined in Hledger.Data.Timeclock

Methods

showsPrec :: Int -> TimeclockEntry -> ShowS

show :: TimeclockEntry -> String

showList :: [TimeclockEntry] -> ShowS

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

NFData TimeclockEntry

Defined in Hledger.Data.Types

Methods

rnf :: TimeclockEntry -> ()

type Rep TimeclockEntry

Defined in Hledger.Data.Types

type Rep TimeclockEntry = D1 (MetaData "TimeclockEntry" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "TimeclockEntry" PrefixI True) ((S1 (MetaSel (Just "tlsourcepos") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 GenericSourcePos) :*: 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 MarketPrice

Constructors

MarketPrice

Fields

• mpdate :: Day
• mpcommodity :: CommoditySymbol
• mpamount :: Amount

Instances

Eq MarketPrice

Defined in Hledger.Data.Types

Methods

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

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

Data MarketPrice

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MarketPrice -> c MarketPrice

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MarketPrice

toConstr :: MarketPrice -> Constr

dataTypeOf :: MarketPrice -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MarketPrice)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MarketPrice)

gmapT :: (forall b. Data b => b -> b) -> MarketPrice -> MarketPrice

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MarketPrice -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MarketPrice -> r

gmapQ :: (forall d. Data d => d -> u) -> MarketPrice -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MarketPrice -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MarketPrice -> m MarketPrice

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MarketPrice -> m MarketPrice

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MarketPrice -> m MarketPrice

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

Show MarketPrice

Defined in Hledger.Data.Amount

Methods

showsPrec :: Int -> MarketPrice -> ShowS

show :: MarketPrice -> String

showList :: [MarketPrice] -> ShowS

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

NFData MarketPrice

Defined in Hledger.Data.Types

Methods

rnf :: MarketPrice -> ()

type Rep MarketPrice

Defined in Hledger.Data.Types

type Rep MarketPrice = D1 (MetaData "MarketPrice" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" False) (C1 (MetaCons "MarketPrice" PrefixI True) (S1 (MetaSel (Just "mpdate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Day) :*: (S1 (MetaSel (Just "mpcommodity") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 CommoditySymbol) :*: S1 (MetaSel (Just "mpamount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Amount))))

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

• 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]
• jdeclaredaccounts :: [AccountName]

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

• jdeclaredaccounttypes :: Map AccountType [AccountName]

  Accounts whose type has been declared in account directives (usually 5 top-level accounts)

• jcommodities :: Map CommoditySymbol Commodity

  commodities and formats declared by commodity directives

• jinferredcommodities :: Map CommoditySymbol AmountStyle

  commodities and formats inferred from journal amounts TODO misnamed - jusedstyles

• jmarketprices :: [MarketPrice]
• 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.

• jlastreadtime :: ClockTime

  when this journal was last read from its file(s)

Instances

Eq Journal

Defined in Hledger.Data.Types

Methods

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

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

Data Journal

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Journal -> c Journal

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Journal

toConstr :: Journal -> Constr

dataTypeOf :: Journal -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Journal)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Journal)

gmapT :: (forall b. Data b => b -> b) -> Journal -> Journal

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Journal -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Journal -> r

gmapQ :: (forall d. Data d => d -> u) -> Journal -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Journal -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Journal -> m Journal

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Journal -> m Journal

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Journal -> m Journal

Show Journal

Defined in Hledger.Data.Journal

Methods

showsPrec :: Int -> Journal -> ShowS

show :: Journal -> String

showList :: [Journal] -> ShowS

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

Semigroup Journal

Defined in Hledger.Data.Journal

Methods

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

sconcat :: NonEmpty Journal -> Journal

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

Monoid Journal

Defined in Hledger.Data.Journal

Methods

mempty :: Journal

mappend :: Journal -> Journal -> Journal

mconcat :: [Journal] -> Journal

NFData Journal

Defined in Hledger.Data.Types

Methods

rnf :: Journal -> ()

type Rep Journal

Defined in Hledger.Data.Types

type Rep Journal = D1 (MetaData "Journal" "Hledger.Data.Types" "hledger-lib-1.12-C1edeYzPhe89lFaDGGE6bC" 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 "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 "jdeclaredaccounts") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [AccountName]) :*: S1 (MetaSel (Just "jdeclaredaccounttypes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map AccountType [AccountName]))))) :*: (((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 "jmarketprices") 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 ClockTime)))))))

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.

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.

data Account

An account, with name, balances and links to parent/subaccounts which let you walk up or down the account tree.

Constructors

Account

Fields

• aname :: AccountName

  this account's full name

• adeclarationorder :: Maybe Int

  the relative position of this account's account directive, if any. Normally a natural number.

• aebalance :: MixedAmount

  this account's balance, excluding subaccounts

• asubs :: [Account]

  sub-accounts

• anumpostings :: Int

  number of postings to this account derived from the above :

• aibalance :: MixedAmount

  this account's balance, including subaccounts

• aparent :: Maybe Account

  parent account

• aboring :: Bool

  used in the accounts report to label elidable parents

Instances

Eq Account

Defined in Hledger.Data.Account

Methods

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

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

Data Account

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Account -> c Account

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Account

toConstr :: Account -> Constr

dataTypeOf :: Account -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Account)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Account)

gmapT :: (forall b. Data b => b -> b) -> Account -> Account

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r

gmapQ :: (forall d. Data d => d -> u) -> Account -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Account -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Account -> m Account

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account

Show Account

Defined in Hledger.Data.Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

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

type Rep Account

Defined in Hledger.Data.Types

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

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

Eq NormalSign

Defined in Hledger.Data.Types

Methods

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

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

Data NormalSign

Defined in Hledger.Data.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NormalSign -> c NormalSign

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c NormalSign

toConstr :: NormalSign -> Constr

dataTypeOf :: NormalSign -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c NormalSign)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c NormalSign)

gmapT :: (forall b. Data b => b -> b) -> NormalSign -> NormalSign

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NormalSign -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NormalSign -> r

gmapQ :: (forall d. Data d => d -> u) -> NormalSign -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> NormalSign -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> NormalSign -> m NormalSign

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NormalSign -> m NormalSign

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NormalSign -> m NormalSign

Show NormalSign

Defined in Hledger.Data.Types

Methods

showsPrec :: Int -> NormalSign -> ShowS

show :: NormalSign -> String

showList :: [NormalSign] -> ShowS

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

Show Ledger

Defined in Hledger.Data.Ledger

Methods

showsPrec :: Int -> Ledger -> ShowS

show :: Ledger -> String

showList :: [Ledger] -> ShowS

Orphan instances

Data ClockTime

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ClockTime -> c ClockTime

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ClockTime

toConstr :: ClockTime -> Constr

dataTypeOf :: ClockTime -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ClockTime)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ClockTime)

gmapT :: (forall b. Data b => b -> b) -> ClockTime -> ClockTime

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ClockTime -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ClockTime -> r

gmapQ :: (forall d. Data d => d -> u) -> ClockTime -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ClockTime -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ClockTime -> m ClockTime

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ClockTime -> m ClockTime

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ClockTime -> m ClockTime

Generic ClockTime

Associated Types

type Rep ClockTime :: Type -> Type

Methods

from :: ClockTime -> Rep ClockTime x

to :: Rep ClockTime x -> ClockTime

ToMarkup Quantity

Methods

toMarkup :: Quantity -> Markup

preEscapedToMarkup :: Quantity -> Markup

NFData ClockTime

Methods

rnf :: ClockTime -> ()

Data (DecimalRaw Integer)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DecimalRaw Integer -> c (DecimalRaw Integer)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (DecimalRaw Integer)

toConstr :: DecimalRaw Integer -> Constr

dataTypeOf :: DecimalRaw Integer -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (DecimalRaw Integer))

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (DecimalRaw Integer))

gmapT :: (forall b. Data b => b -> b) -> DecimalRaw Integer -> DecimalRaw Integer

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DecimalRaw Integer -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DecimalRaw Integer -> r

gmapQ :: (forall d. Data d => d -> u) -> DecimalRaw Integer -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DecimalRaw Integer -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DecimalRaw Integer -> m (DecimalRaw Integer)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DecimalRaw Integer -> m (DecimalRaw Integer)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DecimalRaw Integer -> m (DecimalRaw Integer)