- Function SecurityCouponDaysPreSettlement(SettlementDate, MaturityDate, Frequency, Basis)
SecurityCouponDaysPreSettlement
The function SecurityCouponDaysPreSettlement returns the number of
days from the last coupon-date previous to settlement date until
settlement date of a security that pays interest at the end of each
coupon period.
SecurityCouponDaysPreSettlement(
SettlementDate, ! (input) scalar string expression
MaturityDate, ! (input) scalar string expression
Frequency, ! (input) numerical expression
[Basis] ! (optional) 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).
- Basis
The day-count basis method to be used. The default is 1.
Return Value
The function
SecurityCouponDaysPreSettlementreturns the number of days from the previous coupon-date until the settlement date, using the specified day-count basis.
Note
The function SecurityCouponDaysPreSettlement is similar to the Excel
function COUPDAYBS <https://support.microsoft.com/en-us/office/coupdaybs-function-eb9a8dfb-2fb2-4c61-8e5d-690b320cf872>.
Example
The number of days since the last coupon issued up to the settlement date?
_p_scdps := SecurityCouponDaysPreSettlement(
SettlementDate : "2025-02-01",
MaturityDate : "2030-01-01",
Frequency : 4,
Basis : 1);
block where single_column_display := 1, listing_number_precision := 6 ;
display _p_scdps ;
endblock ;
Day basis 1, just one months, so that is 30 days:
_p_scdps := 30 ;