TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

YIELD

YIELD(arg1, arg2, arg3, arg4, arg5, arg6, arg7) → { number | string | boolean }

Returns the yield on a security that pays periodic interest.

Parameters:

Name Type Description
arg1 any

Is the security's settlement date, expressed as a serial date number.

arg2 any

Is the security's maturity date, expressed as a serial date number.

arg3 any

Is the security's annual coupon rate.

arg4 any

Is the security's price per $100 face value.

arg5 any

Is the security's redemption value per $100 face value.

arg6 any

Is the number of coupon payments per year.

arg7 any

Is the type of day count basis to use.

Returns:

Type
number | string | boolean

Example

Copy code
builder.CreateFile("xlsx");
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));
builder.SaveFile("xlsx", "YIELD.xlsx");
builder.CloseFile();

Resulting document