TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

CUMIPMT

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

Returns the cumulative interest paid between two periods.

Parameters:

Name Type Description
arg1 any

Is the interest rate.

arg2 any

Is the total number of payment periods.

arg3 any

Is the present value.

arg4 any

Is the first period in the calculation.

arg5 any

Is the last period in the calculation.

arg6 any

Is the timing of the payment.

Returns:

Type
number | string | boolean

Example

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

Resulting document