Amortisation (FSharp.Finance.Personal)

Amortisation Module

calculating the principal balance over time, taking into account the effects of charges, interest and fees

Type/Module	Description
ScheduleItem (Module)	amortisation schedule item showing apportionment of payments to principal, fees, interest and charges
Accumulator	a container for aggregating figures separately from the main schedule
BalanceStatus	the status of the balance on a given offset day
Schedule	a schedule showing the amortisation, itemising the effects of payments and calculating balances for each item, and producing some final statistics resulting from the calculations
ScheduleItem (Type)	amortisation schedule item showing apportionment of payments to principal, fees, interest and charges

Function or value	Description
`calculateStats sp settlementDay items` Full Usage: `calculateStats sp settlementDay items` Parameters: sp : `Parameters` settlementDay : `'a voption` items : `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduleItem>` Returns: `Schedule`	wraps the amortisation schedule in some statistics, and optionally calculates the final APR (optional because it can be processor-intensive) sp : `Parameters` settlementDay : `'a voption` items : `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduleItem>` Returns: `Schedule`
`generate sp settlementDay trimEnd actualPayments` Full Usage: `generate sp settlementDay trimEnd actualPayments` Parameters: sp : `Parameters` settlementDay : `SettlementDay voption` trimEnd : `bool` actualPayments : `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ActualPayment array>` Returns: `Schedule`	generates an amortisation schedule and final statistics sp : `Parameters` settlementDay : `SettlementDay voption` trimEnd : `bool` actualPayments : `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ActualPayment array>` Returns: `Schedule`