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
Type
Name
Summary
The numeric constant used to identify an unlimited number of repeated events.
The numeric constant used to identify an annual period.
The numeric constant used to identify a bi-annual period (twice every year).
The numeric constant used to identify a bi-monthly period (twice every month).
The numeric constant used to identify a daily period.
The numeric constant used to identify a four-monthly period (once every four months).
The numeric constant used to identify a four-weekly period (once every four weeks).
The numeric constant used to identify a monthly period.
The numeric constant used to identify that there is no period.
The numeric constant used to identify a quarterly period (once every three months).
The numeric constant used to identify a two-monthly period (once every two months).
The numeric constant used to identify a two-weekly period (once every two weeks).
The numeric constant used to identify a weekly period.
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.
Methods Summarized
Type
Name
Summary
Adds a compound period change.
Adds a loan.
Adds a loan.
Adds a loan.
Adds a loan.
Adds a payment.
Adds a payment.
Adds a payment.
Adds a payment.
Sets a new interest rate.
Calculates the amortization schedule.
Gets the amortization schedule as a JSDataSet.
Returns the error that remains when solving for the unknown.
Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.
Gets the rest balance after the amortization schedule.
Returns the solveForUnknown value.
Returns true if the period is valid, or false if the period is not valid.
Rounds a number up to the nearest cents.
Returns true if successful or false if the call failed.
void
Sorts the amortization events ascending by date.
Constants Detailed
NUMBER_UNLIMITED
The numeric constant used to identify an unlimited number of repeated events.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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).
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(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.
Sample
var c = plugins.amortization.newCalculation();
c.addPayment(500, new Date(2005, 1, 28), null,
plugins.amortization.AmortizationCalculation.PERIOD_DAILY, 5,
plugins.amortization.AmortizationCalculation.STARTDAY_NORMAL);
var c2 = plugins.amortization.newCalculation();
c2.addPayment(300, new Date(2006, 11, 24), new Date(2006, 12, 24),
plugins.amortization.AmortizationCalculation.PERIOD_BI_MONTHLY,
plugins.amortization.AmortizationCalculation.NUMBER_UNLIMITED, 30);
Methods Detailed
addCompoundPeriodChange(newPeriod, date)
Adds a compound period change.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
addLoan(amount, date)
Adds a loan.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
addLoan(amount, firstDate, lastDate, period)
Adds a loan.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
addPayment(amount, date)
Adds a payment.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
addPayment(amount, firstDate, lastDate, period)
Adds a payment.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
addRateChange(newRate, date)
Sets a new interest rate.
Parameters
Sample
var c = plugins.amortization.newCalculation();
c.addRateChange(r, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
c.addPayment(500, new Date(2005, 1, 28), null, 12, 5, 31);
Returns the error that remains when solving for the unknown.
Please note that the error should be less or equal to 1E-8 - otherwise, the solveForUnknown value is incorrect.
Sample
var c = plugins.amortization.newCalculation();
// sets the rate to -1 for unknown.
c.addRateChange(-1, new Date(2005, 0, 1));
c.addCompoundPeriodChange(12, new Date(2005, 0, 1));
c.addLoan(2000, new Date(2005, 0, 1));
var lastDate = null;
var period = 12;
var number_count = 5;
var startday = 31;
c.addPayment(500, new Date(2005, 1, 28), lastDate, period,number_count, startday);
// solves for the interest rate.
c.solveForUnknown();
// gets the interest rate and the error in the calculation.
// which should be small (otherwise the calculation did
// not converge for some reason.
var r = c.getUnknown();
var e = c.getError();
getEvents()
Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.
Sample
plugins.amortization.getEvents();
getRestBalance()
Gets the rest balance after the amortization schedule.
Sample
var rb = plugins.amortization.getRestBalance();
getUnknown()
Returns the solveForUnknown value.
Sample
plugins.amortization.getUnknown();
isValidPeriod(period)
Returns true if the period is valid, or false if the period is not valid.
Parameters
Sample
var v_period = plugins.amortization.isValidPeriod(12);
roundMoney(amount)
Rounds a number up to the nearest cents.
Parameters
Sample
//rounds the number up to 34.35
var rm = plugins.amortization.roundMoney(34.349384);
solveForUnknown()
Returns true if successful or false if the call failed.