AmortizationCalculation
Overview
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
addLoanandaddPaymentsupport different configurations, including start and end dates, periodic intervals, and repetitions.Rate Changes and Period Adjustments:
addRateChangeandaddCompoundPeriodChangeenable dynamic updates to interest rates and compounding periods.Amortization Schedule Handling: Methods like
calculateAmortizationScheduleandgetAmortizationSchedulecompute and retrieve detailed schedules, whilegetRestBalanceandsolveForUnknownprovide insights into financial balances and unknown variables.
Features
Utilities like
isValidPeriodandroundMoneyensure 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
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 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 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 that the same start day should be used as the day of the month of the starting date of the event.
Methods Summarized
Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.
Returns true if the period is valid, or false if the period is not valid.
Constants Detailed
NUMBER_UNLIMITED
The numeric constant used to identify an unlimited number of repeated events.
Type Number
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.
Type Number
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).
Type Number
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.
Type Number
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.
Type Number
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).
Type Number
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).
Type Number
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.
Type Number
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.
Type Number
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).
Type Number
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).
Type Number
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).
Type Number
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.
Type Number
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.
Type Number
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
Returns: Boolean the total number of pages printed during the meta print job.
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
Returns: Boolean true if the loan event was added successfully, false otherwise.
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
Returns: Boolean true if the loan event was added successfully, false otherwise.
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, number)
Adds a loan.
Parameters
Returns: Boolean true if the loan event was added successfully, false otherwise.
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, number, startday)
Adds a loan.
Parameters
Returns: Boolean true if the loan event was added successfully, false otherwise.
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, date)
Adds a payment.
Parameters
Returns: Boolean true if the payment event was added successfully, false otherwise.
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
Returns: Boolean true if the payment event was added successfully, false otherwise.
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, number)
Adds a payment.
Parameters
Returns: Boolean true if the payment event was added successfully, false otherwise.
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, number, startday)
Adds a payment.
Parameters
Returns: Boolean true if the payment event was added successfully, false otherwise.
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);addRateChange(newRate, date)
Sets a new interest rate.
Parameters
Returns: Boolean true if the rate change was added successfully, false otherwise.
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);calculateAmortizationSchedule()
Calculates the amortization schedule.
Returns: Boolean true if the amortization schedule was calculated successfully, false otherwise.
Sample
plugins.amortization.calculateAmortizationSchedule();getAmortizationSchedule()
Gets the amortization schedule as a JSDataSet.
Returns: JSDataSet the amortization schedule as a JSDataSet.
Sample
plugins.amortization.getAmortizationSchedule();getError()
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.
Returns: Number the error value resulting from solving for the unknown.
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.
Returns: JSDataSet all amortization events such as rate changes, loans, payments, and compounding period changes as a JSDataSet.
Sample
plugins.amortization.getEvents();getRestBalance()
Gets the rest balance after the amortization schedule.
Returns: Number the remaining balance after the amortization schedule.
Sample
var rb = plugins.amortization.getRestBalance();getUnknown()
Returns the solveForUnknown value.
Returns: Number the value of the unknown parameter solved during amortization.
Sample
plugins.amortization.getUnknown();isValidPeriod(period)
Returns true if the period is valid, or false if the period is not valid.
Parameters
Number period ;
Returns: Boolean true if the specified period is valid, false otherwise.
Sample
var v_period = plugins.amortization.isValidPeriod(12);roundMoney(amount)
Rounds a number up to the nearest cents.
Parameters
Number amount ;
Returns: Number the amount rounded to the nearest cent.
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.
Returns: Boolean true if the unknown value was successfully solved, false otherwise.
Sample
plugins.amortization.solveForUnknown();sortEvents()
Sorts the amortization events ascending by date.
Returns: void
Sample
plugins.amortization.sortEvents();Last updated
Was this helpful?