TRY NEW VERSION

IPMT

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

Returns the interest payment for a given period for an 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

Is the period for which you want to find the interest 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, or the lump-sum amount that a series of future payments is worth now.

arg5 number

Is the future value, or a cash balance you want to attain after the last payment is made. If omitted, Fv = 0.

arg6 number

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

Returns:

Type
number | string | boolean

Example

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

Resulting document