Apr (FSharp.Finance.Personal) | FSharp.Finance.Personal

FSharp.Finance.Personal

Apr Module

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

calculating the APR according to various country-specific regulations

Types and nested modules

Type/Module	Description
UnitedKingdom	APR as in https://www.handbook.fca.org.uk/handbook/MCOB/10/?view=chapter
UsActuarial	APR as in https://www.consumerfinance.gov/rules-policy/regulations/1026/j/
CalculationMethod	the calculation method used to determine the APR
Transfer	details of an advance or a payment
TransferType	whether a transfer is an advance or a payment

Functions and values

Function or value	Description
`annualPercentageRate unitPeriodRate unitPeriodsPerYear` Full Usage: `annualPercentageRate unitPeriodRate unitPeriodsPerYear` Parameters: unitPeriodRate : `decimal` unitPeriodsPerYear : `decimal` Returns: `decimal`	basic calculation to determine the APR unitPeriodRate : `decimal` unitPeriodsPerYear : `decimal` Returns: `decimal`
`calculate method advanceValue advanceDate transfers` Full Usage: `calculate method advanceValue advanceDate transfers` Parameters: method : `CalculationMethod` advanceValue : `int64<MeasureProduct<Cent, MeasureOne>>` advanceDate : `Date` transfers : `Transfer array` Returns: `Solution`	calculates the APR to a given precision for a single-advance transaction where the consummation date, first finance-charge earned date and advance date are all the same method : `CalculationMethod` advanceValue : `int64<MeasureProduct<Cent, MeasureOne>>` advanceDate : `Date` transfers : `Transfer array` Returns: `Solution`
`roughUnitPeriodRate principal interestTotal paymentCount` Full Usage: `roughUnitPeriodRate principal interestTotal paymentCount` Parameters: principal : `decimal` interestTotal : `decimal` paymentCount : `decimal` Returns: `decimal`	an approximation of the unit-period equivalent of the APR principal : `decimal` interestTotal : `decimal` paymentCount : `decimal` Returns: `decimal`
`toPercent aprMethod aprSolution` Full Usage: `toPercent aprMethod aprSolution` Parameters: aprMethod : `CalculationMethod` aprSolution : `Solution` Returns: `Percent voption`	converts an APR solution to a percentage, if possible aprMethod : `CalculationMethod` aprSolution : `Solution` Returns: `Percent voption`
`ukUnitPeriodRate unitPeriod apr` Full Usage: `ukUnitPeriodRate unitPeriod apr` Parameters: unitPeriod : `UnitPeriod` apr : `Percent` Returns: `Percent`	calculates the APR rate for the specified unit-period as per UK regulation unitPeriod : `UnitPeriod` apr : `Percent` Returns: `Percent`