Scheduling (FSharp.Finance.Personal)

Scheduling Module

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

functions for generating a regular payment schedule, with payment amounts, interest and APR

Types and nested modules

Type/Module	Description
ActualPayment (Module)	an actual payment made by the customer, optionally including metadata such as bank references etc.
ActualPaymentStatus (Module)	the status of the payment, allowing for delays due to payment-provider processing times
Apportionment (Module)	a breakdown of how an actual payment is apportioned to principal, fees, interest and charges
GeneratedPayment (Module)	a generated payment, where applicable
ScheduledPayment (Module)
SimpleItem (Module)	a scheduled payment item, with running calculations of interest and principal balance
ActualPayment (Type)	an actual payment made by the customer, optionally including metadata such as bank references etc.
ActualPaymentStatus (Type)	the status of the payment, allowing for delays due to payment-provider processing times
Apportionment (Type)	a breakdown of how an actual payment is apportioned to principal, fees, interest and charges
AutoGenerateSchedule	a regular schedule based on a unit-period config with a specific number of payments with an auto-calculated amount
CloseBalanceOption	how to handle a final balance if not closed: leave it open or modify/add payments at the end of the schedule
FixedSchedule	a regular schedule based on a unit-period config with a specific number of payments of a specified amount
GeneratedPayment (Type)	a generated payment, where applicable
MinimumPayment	how to handle cases where the payment due is less than the minimum that payment providers can process
OriginalPayment	an originally scheduled payment, including the original simple interest and contractual interest calculations
Parameters	parameters for creating a payment schedule
PaymentConfig	how to treat scheduled payments
PaymentStatus	the status of a payment made by the customer
RescheduledPayment	a rescheduled payment, including the day on which the payment was created
ScheduleConfig	whether a payment plan is generated according to a regular schedule or is an irregular array of payments
ScheduleType	the type of the schedule; for scheduled payments, this affects how any payment due is calculated
ScheduledPayment (Type)	any original or rescheduled payment, affecting how any payment due is calculated
ScheduledPaymentOption	whether to stick to scheduled payment amounts or add charges and interest to them
SettlementDay	the intended day on which to quote a settlement
SimpleItem (Type)	a scheduled payment item, with running calculations of interest and principal balance
SimpleSchedule	a schedule of payments, with final statistics based on the payments being made on time and in full

Functions and values

Function or value	Description
`calculate toleranceOption sp` Full Usage: `calculate toleranceOption sp` Parameters: toleranceOption : `TargetTolerance` sp : `Parameters` Returns: `SimpleSchedule`	calculates the number of days between two offset days on which interest is chargeable toleranceOption : `TargetTolerance` sp : `Parameters` Returns: `SimpleSchedule`
`generatePaymentMap startDate paymentSchedule` Full Usage: `generatePaymentMap startDate paymentSchedule` Parameters: startDate : `Date` paymentSchedule : `ScheduleConfig` Returns: `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduledPayment>`	generates a map of offset days and payments based on a start date and payment schedule startDate : `Date` paymentSchedule : `ScheduleConfig` Returns: `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduledPayment>`
`mergeScheduledPayments scheduledPayments` Full Usage: `mergeScheduledPayments scheduledPayments` Parameters: scheduledPayments : `(int<MeasureProduct<OffsetDay, MeasureOne>> * ScheduledPayment) array` Returns: `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduledPayment>`	merges scheduled payments, determining the currently valid original and rescheduled payments, and preserving a record of any previous payments that have been superseded scheduledPayments : `(int<MeasureProduct<OffsetDay, MeasureOne>> * ScheduledPayment) array` Returns: `Map<int<MeasureProduct<OffsetDay, MeasureOne>>, ScheduledPayment>`
`toValueOption _arg1` Full Usage: `toValueOption _arg1` Parameters: _arg1 : `'a option` Returns: `'a voption`	convert an option to a value option _arg1 : `'a option` Returns: `'a voption`