Charge (FSharp.Finance.Personal) | FSharp.Finance.Personal

FSharp.Finance.Personal

Charge Module

Namespace: FSharp.Finance.Personal
Assembly: FSharp.Finance.Personal.dll

a penalty charge > NB: differences between charges and fees: > - charges are not up-front amounts, they are incurred as a result of a breach of agreed terms > - charges are not added to the principal balance and do not therefore accrue interest

Types and nested modules

Type/Module	Description
Config (Module)	options specifying the types of charges, their amounts, and any restrictions on these
ChargeGrouping	options on how to handle multiple charges
ChargeType	the type and amount of any charge
Config (Type)	options specifying the types of charges, their amounts, and any restrictions on these

Functions and values

Function or value	Description
`grandTotal chargeConfig baseValue customChargeTypes` Full Usage: `grandTotal chargeConfig baseValue customChargeTypes` Parameters: chargeConfig : `Config` baseValue : `int64<MeasureProduct<Cent, MeasureOne>>` customChargeTypes : `ChargeType array voption` Returns: `int64<MeasureProduct<Cent, MeasureOne>>`	calculates the total sum of any charges incurred chargeConfig : `Config` baseValue : `int64<MeasureProduct<Cent, MeasureOne>>` customChargeTypes : `ChargeType array voption` Returns: `int64<MeasureProduct<Cent, MeasureOne>>`
`holidayDates chargeConfig startDate` Full Usage: `holidayDates chargeConfig startDate` Parameters: chargeConfig : `Config` startDate : `Date` Returns: `int[]`	generates a date range during which charges are not incurred chargeConfig : `Config` startDate : `Date` Returns: `int[]`
`round config` Full Usage: `round config` Parameters: config : `Config` Returns: `decimal<MeasureProduct<Cent, MeasureOne>> -> int64<MeasureProduct<Cent, MeasureOne>>`	rounds a charge to the nearest integer cent using the specified rounding option config : `Config` Returns: `decimal<MeasureProduct<Cent, MeasureOne>> -> int64<MeasureProduct<Cent, MeasureOne>>`
`total chargeConfig baseValue chargeType` Full Usage: `total chargeConfig baseValue chargeType` Parameters: chargeConfig : `Config` baseValue : `int64<MeasureProduct<Cent, MeasureOne>>` chargeType : `ChargeType` Returns: `int64<MeasureProduct<Cent, MeasureOne>>`	calculates the total of a charge chargeConfig : `Config` baseValue : `int64<MeasureProduct<Cent, MeasureOne>>` chargeType : `ChargeType` Returns: `int64<MeasureProduct<Cent, MeasureOne>>`