RATE

function RATE(
  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 rate per period of a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.

Parameters

arg1numberdefault: null

Is the total number of payment periods for the loan or investment.

arg2numberdefault: null

Is the payment made each period and cannot change over the life of the loan or investment.

arg3numberdefault: null

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

arg4numberdefault: null

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

arg5numberdefault: null

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

arg6numberdefault: null

Is your guess for what the rate will be; if omitted, Guess = 0.1 (10 percent).

Returns

number | string | boolean

Try It

var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.RATE(2*12, -500, 10000, 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).