TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

COUPNUM

COUPNUM(arg1, arg2, arg3, arg4) → { number | string | boolean }

Returns the number of coupons payable between the settlement date and maturity date.

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 number of coupon payments per year.

arg4 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.COUPNUM("1/10/2018", "6/15/2019", 4, 1));
builder.SaveFile("xlsx", "COUPNUM.xlsx");
builder.CloseFile();

Resulting document