YIELD
function YIELD(
arg1: any = null,
arg2: any = null,
arg3: any = null,
arg4: any = null,
arg5: any = null,
arg6: any = null,
arg7: any = null,
): number | string | boolean
Description
Returns the yield on a security that pays periodic interest.
Parameters
- arg1
any
null Is the security's settlement date, expressed as a serial date number.
- arg2
any
null Is the security's maturity date, expressed as a serial date number.
- arg3
any
null Is the security's annual coupon rate.
- arg4
any
null Is the security's price per $100 face value.
- arg5
any
null Is the security's redemption value per $100 face value.
- arg6
any
null Is the number of coupon payments per year.
- arg7
any
null Is the type of day count basis to use.
Returns
number | string | boolean
Try It
var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.YIELD("1/10/2018", "11/20/2019", "3.75%", 90, 100, 4));