Skip to main content

RATE

Returns the interest rate per period for a loan or an investment. For example, use 6%/4 for quarterly payments at 6% APR.

Syntax

expression.RATE(arg1, arg2, arg3, arg4, arg5, arg6);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRangeApiNamenumber
arg2RequiredApiRangeApiNamenumber
arg3RequiredApiRangeApiNamenumber
arg4RequiredApiRangeApiNamenumber
arg5RequiredApiRangeApiNamenumber
arg6RequiredApiRangeApiNamenumber

Returns

number

Example

var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.RATE(2*12, -500, 10000, 0));