- Function SecurityCouponNumber(SettlementDate, MaturityDate, Frequency)
SecurityCouponNumber
The function SecurityCouponNumber
returns the number of coupons from
settlement date and maturity date of a security that pays interest at
the end of each coupon period.
SecurityCouponNumber(
SettlementDate, ! (input) scalar string expression
MaturityDate, ! (input) scalar string expression
Frequency, ! (input) numerical expression
)
Arguments
- SettlementDate
The date of settlement of the security. SettlementDate must be in date format.
- MaturityDate
The date of maturity of the security. MaturityDate must also be in date format and must be a date after SettlementDate.
- Frequency
The number of coupon payments in one year. Frequency must be 1 (annual), 2 (semi-annual) or 4 (quarterly).
Return Value
The function
SecurityCouponNumber
returns the number of coupon payments from the settlement date until the maturity date.
Note
The function SecurityCouponNumber
is similar to the Excel function
COUPNUM.
Example
How many quarterly coupons are paid out over a period of five years?
_p_scn := SecurityCouponNumber(
SettlementDate : "2025-01-01",
MaturityDate : "2030-01-01",
Frequency : 4);
block where single_column_display := 1, listing_number_precision := 6 ;
display _p_scn ;
endblock ;
Twenty:
_p_scn := 20 ;