EFFECT
Returns the effective annual interest rate.
Syntax
expression.EFFECT(arg1, arg2);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The nominal interest rate. | |
| arg2 | Required | ApiRange | ApiName | number | The number of compounding periods per year. |
Returns
number
Example
This example shows how to return the effective annual interest rate.
- Code
- Result
// How to get an effective annual interest rate.
// Use function to get effective annual interest rate.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.EFFECT(0.57, 4));