SpreadJS Documentation
COUPNUM
SpreadJS Documentation > Formula Reference > Formula Functions > COUPNUM

This function returns the number of coupons due between the settlement date and maturity date.

Syntax

COUPNUM(settlement,maturity,frequency,basis)

Arguments

This function has these arguments:

Argument Description
settlement Settlement date for the security
maturity Maturity date for the security
frequency Frequency of payment, number of coupon payments per year; must be 1, 2, or 4
basis [Optional] Integer representing the basis for day count (Refer to Day Count Basis.)

Remarks

This function returns an error if settlement or maturity is invalid (#VALUE!), or if frequency is a number other than 1, 2, or 4 (#NUM!). All arguments are truncated to integers. If basis is greater than 4 or less than 0, a #NUM! error is returned. If settlement is greater than or equal to maturity, a #NUM! error is returned.

Data Types

Accepts numeric and DateTime object data. Returns numeric data.

Examples

COUPNUM(A1,A2,A3,A4)

COUPNUM(R6C3:R9C4)

See Also