SpreadJS Documentation
YIELDMAT
SpreadJS Documentation > Formula Reference > Formula Functions > YIELDMAT

This function calculates the annual yield of a security that pays interest at maturity.

Syntax

YIELDMAT(settle,maturity,issue,issrate,price,basis)

Arguments

This function has these arguments:

Argument Description
settle Settlement date for the security
maturity Maturity date for the security
issue Issue date for the security
issrate Interest rate for the security at the date of issue
price Price per $100 face value for the security
basis [Optional] Integer representing the basis for day count (Refer to Day Count Basis.)

Remarks

This function returns a #VALUE! error when settle, maturity, or issue is invalid. If issrate is less than 0 or price is less than or equal to 0, a #NUM! error is returned. If basis is less than 0 or greater than 4, a #NUM! error is returned. If settle is greater than or equal to maturity, a #NUM! error is returned. Settle, maturity, issue, and basis are truncated to integers.

Data Types

Accepts numeric and date data. Returns numeric data.

Examples

YIELDMAT(C1,C2,C3,C4,C5,C6)

See Also