This module details an amortization calculation system that defines constants for various periodic intervals and events, as well as methods for managing loans, payments, rate changes, and schedule calculations. ## Constants
The module includes constants representing various time periods, such as annual, bi-annual, monthly, and weekly intervals, as well as unique identifiers like NUMBER_UNLIMITED for unlimited occurrences and STARTDAY_NORMAL for consistent start-day tracking. These constants simplify configuring amortization schedules with precise periodicity and event behaviors.
Methods
Key methods facilitate:
Loan and Payment Management: Functions like addLoan and addPayment support different configurations, including start and end dates, periodic intervals, and repetitions.
Rate Changes and Period Adjustments: addRateChange and addCompoundPeriodChange enable dynamic updates to interest rates and compounding periods.
Amortization Schedule Handling: Methods like calculateAmortizationSchedule and getAmortizationSchedule compute and retrieve detailed schedules, while getRestBalance and solveForUnknown provide insights into financial balances and unknown variables.
Features
Utilities like isValidPeriod and roundMoney ensure input validity and precision.
Event management and sorting (sortEvents, getEvents) organize financial activities over time.
This module streamlines the creation and management of customized amortization schedules with precision and adaptability.
Constants Summarized
Methods Summarized
Constants Detailed
NUMBER_UNLIMITED
The numeric constant used to identify an unlimited number of repeated events.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_ANNUALY
The numeric constant used to identify an annual period.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_BI_ANNUALLY
The numeric constant used to identify a bi-annual period (twice every year).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_BI_MONTHLY
The numeric constant used to identify a bi-monthly period (twice every month).
TODO: this period is not supported yet.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_DAILY
The numeric constant used to identify a daily period.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_FOUR_MONTHLY
The numeric constant used to identify a four-monthly period (once every four months).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_FOUR_WEEKLY
The numeric constant used to identify a four-weekly period (once every four weeks).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_MONTHLY
The numeric constant used to identify a monthly period.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_NONE
The numeric constant used to identify that there is no period.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_QUARTERLY
The numeric constant used to identify a quarterly period (once every three months).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_TWO_MONTHLY
The numeric constant used to identify a two-monthly period (once every two months).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_TWO_WEEKLY
The numeric constant used to identify a two-weekly period (once every two weeks).
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
PERIOD_WEEKLY
The numeric constant used to identify a weekly period.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
STARTDAY_NORMAL
The numeric constant used to identify that the same start day should be used as the day of the month of the starting date of the event.
var c =plugins.amortization.newCalculation();c.addPayment(500,newDate(2005,1,28),null,plugins.amortization.AmortizationCalculation.PERIOD_DAILY,5,plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);var c2 =plugins.amortization.newCalculation();c2.addPayment(300,newDate(2006,11,24),newDate(2006,12,24),plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED,30);
var c =plugins.amortization.newCalculation();c.addRateChange(r,newDate(2005,0,1));c.addCompoundPeriodChange(12,newDate(2005,0,1));c.addLoan(2000,newDate(2005,0,1));c.addPayment(500,newDate(2005,1,28),null,12,5,31);