Coupnum (PQL)

Returns the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon.

  • Returned Output: Integer
  • Library: PQL \ Common \ Financial
  • Version: 2025.01.000
  • Compatibility:
    • It can be combined with other PQL functions throughout the application.
    • It CANNOT be used with MDX or VBA functions. But it can be used on MDX-based content in other parts of the application.

Syntax

Coupnum( <Date> , <Date> , <Numeric> )

* Click on the function's arguments above for more details on the input values.

Comments

This function is the same as the Microsoft Excel 'COUPNUM' function - using the same inputs, logic, and outputs.

Function Arguments

Name

Description

Type

Optional

settlement

Settlement date for the security.

String or Number (<Date>)

 

maturity

Maturity date for the security.

String or Number (<Date>)

 

frequency

Frequency of payment, number of coupon payments per year; must be 1, 2, or 4.

<Numeric>

 

basis

Integer representing the basis for day count.

<Numeric>

Y

Note: Literal encoding is in use; this means that Booleans and Dates are represented as numeric values (1 and 0 and timestamps or serial date numbers, respectively).

Example

This example calculates the number of coupons between the current settlement date (pulled dynamically from your dataset) and the maturity date of "2017-03-31":

Coupnum( [Data].[Date].Currentmember.caption, "2017-03-31", 1 )