IPMT

function IPMT(
  arg1: number = null,
  arg2: number = null,
  arg3: number = null,
  arg4: number = null,
  arg5: number = null,
  arg6: number = null,
): number | string | boolean

Description

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

Parameters

arg1numberdefault: null

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

arg2numberdefault: null

Is the period for which you want to find the interest and must be in the range 1 to Nper.

arg3numberdefault: null

Is the total number of payment periods in an investment.

arg4numberdefault: null

Is the present value, or the lump-sum amount that a series of future payments is worth now.

arg5numberdefault: null

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

arg6numberdefault: null

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

number | string | boolean

Try It

var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.IPMT(0.1/12, 1, 2*12, 2000, 0));

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).