Hledger.Data.Valuation

Convert amounts to some related value in various ways. This involves looking up historical market prices (exchange rates) between commodities.

Documentation

data ValuationType

What kind of value conversion should be done on amounts ? UI: --value=cost|end|now|DATE[,COMM]

Constructors

AtCost (Maybe CommoditySymbol)

convert to cost commodity using transaction prices, then optionally to given commodity using market prices at posting date

AtEnd (Maybe CommoditySymbol)

convert to default valuation commodity or given commodity, using market prices at period end(s)

AtNow (Maybe CommoditySymbol)

convert to default valuation commodity or given commodity, using current market prices

AtDate Day (Maybe CommoditySymbol)

convert to default valuation commodity or given commodity, using market prices on some date

AtDefault (Maybe CommoditySymbol)

works like AtNow in single period reports, like AtEnd in multiperiod reports

Instances

Eq ValuationType

Defined in Hledger.Data.Valuation

Methods

(==) :: ValuationType -> ValuationType -> Bool

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

Data ValuationType

Defined in Hledger.Data.Valuation

Methods

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

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

toConstr :: ValuationType -> Constr

dataTypeOf :: ValuationType -> DataType

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

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

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

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

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

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

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

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

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

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

Show ValuationType

Defined in Hledger.Data.Valuation

Methods

showsPrec :: Int -> ValuationType -> ShowS

show :: ValuationType -> String

showList :: [ValuationType] -> ShowS

type PriceOracle = (Day, CommoditySymbol, Maybe CommoditySymbol) -> Maybe (CommoditySymbol, Quantity)

A price oracle is a magic function that looks up market prices (exchange rates) from one commodity to another (or if unspecified, to a default valuation commodity) on a given date, somewhat efficiently.

journalPriceOracle :: Journal -> PriceOracle

mixedAmountApplyValuation :: PriceOracle -> Map CommoditySymbol AmountStyle -> Day -> Day -> Bool -> ValuationType -> MixedAmount -> MixedAmount

Apply a specified valuation to this mixed amount, using the provided price oracle, commodity styles, period-end/current dates, and whether this is for a multiperiod report or not.

mixedAmountValueAtDate :: PriceOracle -> Map CommoditySymbol AmountStyle -> Maybe CommoditySymbol -> Day -> MixedAmount -> MixedAmount

Find the market value of each component amount in the given commodity, or its default valuation commodity, at the given valuation date, using the given market price oracle. When market prices available on that date are not sufficient to calculate the value, amounts are left unchanged.

marketPriceReverse :: MarketPrice -> MarketPrice

priceDirectiveToMarketPrice :: PriceDirective -> MarketPrice

tests_Valuation :: Test ()