PPMT
function PPMT(
arg1: number = null,
arg2: number = null,
arg3: number = null,
arg4: number = null,
arg5: number = null,
arg6: number = null,
): number | string | boolean
Description
Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.
Parameters
- arg1
number
null Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.
- arg2
number
null Specifies the period and must be in the range 1 to nper.
- arg3
number
null Is the total number of payment periods in an investment.
- arg4
number
null Is the present value: the total amount that a series of future payments is worth now.
- arg5
number
null Is the future value, or cash balance you want to attain after the last payment is made.
- arg6
number
null Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.
Returns
number | string | boolean
Try It
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.PPMT(0.1/12, 1, 2*12, 2000, 0));