TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

PPMT

PPMT(arg1, arg2, arg3, arg4, arg5, arg6) → { number | string | boolean }

Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.

Parameters:

Name Type Description
arg1 number

Is the interest rate per period. For example, use 6%/4 for quarterly payments at 6% APR.

arg2 number

Specifies the period and must be in the range 1 to nper.

arg3 number

Is the total number of payment periods in an investment.

arg4 number

Is the present value: the total amount that a series of future payments is worth now.

arg5 number

Is the future value, or cash balance you want to attain after the last payment is made.

arg6 number

Is a logical value: payment at the beginning of the period = 1; payment at the end of the period = 0 or omitted.

Returns:

Type
number | string | boolean

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.PPMT(0.1/12, 1, 2*12, 2000, 0));
builder.SaveFile("xlsx", "PPMT.xlsx");
builder.CloseFile();

Resulting document