Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
NUMBER_UNLIMITED The numeric constant used to identify an unlimited number of repeated events.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_ANNUALY The numeric constant used to identify an annual period.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_BI_ANNUALLY The numeric constant used to identify a bi-annual period (twice every year).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_BI_MONTHLY The numeric constant used to identify a bi-monthly period (twice every month).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_DAILY The numeric constant used to identify a daily period.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_FOUR_MONTHLY The numeric constant used to identify a four-monthly period (once every four months).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_FOUR_WEEKLY The numeric constant used to identify a four-weekly period (once every four weeks).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_MONTHLY The numeric constant used to identify a monthly period.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_NONE The numeric constant used to identify that there is no period.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_QUARTERLY The numeric constant used to identify a quarterly period (once every three months).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_TWO_MONTHLY The numeric constant used to identify a two-monthly period (once every two months).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_TWO_WEEKLY The numeric constant used to identify a two-weekly period (once every two weeks).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
PERIOD_WEEKLY The numeric constant used to identify a weekly period.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
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.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addCompoundPeriodChange(newPeriod, date) Adds a compound period change.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addLoan(amount, date) Adds a loan.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addLoan(amount, firstDate, lastDate, period) Adds a loan.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addLoan(amount, firstDate, lastDate, period, number) Adds a loan.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addLoan(amount, firstDate, lastDate, period, number, startday) Adds a loan.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addPayment(amount, date) Adds a payment.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addPayment(amount, firstDate, lastDate, period) Adds a payment.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addPayment(amount, firstDate, lastDate, period, number) Adds a payment.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addPayment(amount, firstDate, lastDate, period, number, startday) Adds a payment.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addRateChange(newRate, date) Sets a new interest rate.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
calculateAmortizationSchedule() Calculates the amortization schedule.

Table Row (tr)

Table Cell (td)
JSDataSet

Table Cell (td)
getAmortizationSchedule() Gets the amortization schedule as a JSDataSet.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getError() Returns the error that remains when solving for the unknown.

Table Row (tr)

Table Cell (td)
JSDataSet

Table Cell (td)
getEvents() Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getRestBalance() Gets the rest balance after the amortization schedule.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getUnknown() Returns the solveForUnknown value.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
isValidPeriod(period) Returns true if the period is valid, or false if the period is not valid.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
roundMoney(amount) Rounds a number up to the nearest cents.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
solveForUnknown() Returns true if successful or false if the call failed.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
sortEvents() Sorts the amortization events ascending by date.

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Details

Table Body (tbody)

id	NUMBER_UNLIMITED

Table Row (tr)

id	name

Table Cell (td)
NUMBER_UNLIMITED

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify an unlimited number of repeated events.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_ANNUALY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_ANNUALY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify an annual period.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_BI_ANNUALLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_BI_ANNUALLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a bi-annual period (twice every year).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_BI_MONTHLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_BI_MONTHLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a bi-monthly period (twice every month).
TODO: this period is not supported yet.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_DAILY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_DAILY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a daily period.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_FOUR_MONTHLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_FOUR_MONTHLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a four-monthly period (once every four months).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_FOUR_WEEKLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_FOUR_WEEKLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a four-weekly period (once every four weeks).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_MONTHLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_MONTHLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a monthly period.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_NONE

Table Row (tr)

id	name

Table Cell (td)
PERIOD_NONE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify that there is no period.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_QUARTERLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_QUARTERLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a quarterly period (once every three months).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_TWO_MONTHLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_TWO_MONTHLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a two-monthly period (once every two months).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_TWO_WEEKLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_TWO_WEEKLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a two-weekly period (once every two weeks).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	PERIOD_WEEKLY

Table Row (tr)

id	name

Table Cell (td)
PERIOD_WEEKLY

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The numeric constant used to identify a weekly period.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	STARTDAY_NORMAL

Table Row (tr)

id	name

Table Cell (td)
STARTDAY_NORMAL

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	addCompoundPeriodChange-Number_Date

Table Row (tr)

id	name

Table Cell (td)
addCompoundPeriodChange

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addCompoundPeriodChange

Span
(newPeriod, date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a compound period change.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} newPeriod
{Date} date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addLoan-Number_Date

Table Row (tr)

id	name

Table Cell (td)
addLoan

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addLoan

Span
(amount, date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a loan.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addLoan-Number_Date_Date_Number

Table Row (tr)

id	name

Table Cell (td)
addLoan

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addLoan

Span
(amount, firstDate, lastDate, period)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a loan.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addLoan-Number_Date_Date_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addLoan

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addLoan

Span
(amount, firstDate, lastDate, period, number)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a loan.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period
{Number} number

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addLoan-Number_Date_Date_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addLoan

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addLoan

Span
(amount, firstDate, lastDate, period, number, startday)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a loan.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period
{Number} number
{Number} startday

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPayment-Number_Date

Table Row (tr)

id	name

Table Cell (td)
addPayment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addPayment

Span
(amount, date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a payment.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPayment-Number_Date_Date_Number

Table Row (tr)

id	name

Table Cell (td)
addPayment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addPayment

Span
(amount, firstDate, lastDate, period)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a payment.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPayment-Number_Date_Date_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addPayment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addPayment

Span
(amount, firstDate, lastDate, period, number)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a payment.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period
{Number} number

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addPayment-Number_Date_Date_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
addPayment

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addPayment

Span
(amount, firstDate, lastDate, period, number, startday)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Adds a payment.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount
{Date} firstDate
{Date} lastDate
{Number} period
{Number} number
{Number} startday

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addRateChange-Number_Date

Table Row (tr)

id	name

Table Cell (td)
addRateChange

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addRateChange

Span
(newRate, date)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sets a new interest rate.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} newRate
{Date} date

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	calculateAmortizationSchedule

Table Row (tr)

id	name

Table Cell (td)
calculateAmortizationSchedule

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

calculateAmortizationSchedule

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Calculates the amortization schedule.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.calculateAmortizationSchedule();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getAmortizationSchedule

Table Row (tr)

id	name

Table Cell (td)
getAmortizationSchedule

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSDataSet

Span

style	font-weight: bold;

getAmortizationSchedule

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the amortization schedule as a JSDataSet.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSDataSet

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getAmortizationSchedule();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getError

Table Row (tr)

id	name

Table Cell (td)
getError

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getError

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getEvents

Table Row (tr)

id	name

Table Cell (td)
getEvents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSDataSet

Span

style	font-weight: bold;

getEvents

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all the amortization events - such as rate changes, loan events, payment events, compounding period changes.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSDataSet

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getEvents();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRestBalance

Table Row (tr)

id	name

Table Cell (td)
getRestBalance

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getRestBalance

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the rest balance after the amortization schedule.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var rb = plugins.amortization.getRestBalance();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUnknown

Table Row (tr)

id	name

Table Cell (td)
getUnknown

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getUnknown

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the solveForUnknown value.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.getUnknown();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isValidPeriod-Number

Table Row (tr)

id	name

Table Cell (td)
isValidPeriod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isValidPeriod

Span
(period)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if the period is valid, or false if the period is not valid.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} period

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var v_period = plugins.amortization.isValidPeriod(12);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	roundMoney-Number

Table Row (tr)

id	name

Table Cell (td)
roundMoney

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

roundMoney

Span
(amount)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Rounds a number up to the nearest cents.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} amount

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//rounds the number up to 34.35
var rm = plugins.amortization.roundMoney(34.349384);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	solveForUnknown

Table Row (tr)

id	name

Table Cell (td)
solveForUnknown

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

solveForUnknown

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns true if successful or false if the call failed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.solveForUnknown();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sortEvents

Table Row (tr)

id	name

Table Cell (td)
sortEvents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

sortEvents

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sorts the amortization events ascending by date.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.amortization.sortEvents();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 26

New Version Current

Key

NUMBER_UNLIMITED

PERIOD_ANNUALY

PERIOD_BI_ANNUALLY

PERIOD_BI_MONTHLY

PERIOD_DAILY

PERIOD_FOUR_MONTHLY

PERIOD_FOUR_WEEKLY

PERIOD_MONTHLY

PERIOD_NONE

PERIOD_QUARTERLY

PERIOD_TWO_MONTHLY

PERIOD_TWO_WEEKLY

PERIOD_WEEKLY

STARTDAY_NORMAL

addCompoundPeriodChange

addLoan

addLoan

addLoan

addLoan

addPayment

addPayment

addPayment

addPayment

addRateChange

calculateAmortizationSchedule

getAmortizationSchedule

getError

getEvents

getRestBalance

getUnknown

isValidPeriod

roundMoney

solveForUnknown

sortEvents