Skip to main content

RRI

Returns an equivalent interest rate for the growth of an investment.

Syntax

expression.RRI(arg1, arg2, arg3);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRange | ApiName | numberThe number of periods for the investment.
arg2RequiredApiRange | ApiName | numberThe present value of the investment.
arg3RequiredApiRange | ApiName | numberThe future value of the investment.

Returns

number

Example

let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.RRI(12, 10000, 20000));