COUPDAYS
Returns the number of days in the coupon period that contains the settlement date.
Syntax
expression.COUPDAYS(arg1, arg2, arg3, arg4);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The security settlement date, expressed as a serial date number. | |
| arg2 | Required | ApiRange | ApiName | number | The maturity date of the security, expressed as a serial date number. | |
| arg3 | Required | ApiRange | ApiName | number | The number of interest payments per year. The possible values are: 1 for annual payments, 2 for semiannual payments, 4 for quarterly payments. | |
| arg4 | Optional | ApiRange | ApiName | number | The day count basis to use: -0 or omitted - US (NASD) 30/360; -1 - Actual/actual; -2 - Actual/360; -3 - Actual/365; -4 - European 30/360. |
Returns
number
Example
- Code
- Result
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.COUPDAYS("1/10/2018", "6/15/2019", 4, 1));