AccruedInterest
in package
Table of Contents
Constants
Methods
- atMaturity() : float|string
- ACCRINTM.
- periodic() : float|string
- ACCRINT.
Constants
ACCRINT_CALCMODE_FIRST_INTEREST_TO_SETTLEMENT
public
mixed
ACCRINT_CALCMODE_FIRST_INTEREST_TO_SETTLEMENT
= false
ACCRINT_CALCMODE_ISSUE_TO_SETTLEMENT
public
mixed
ACCRINT_CALCMODE_ISSUE_TO_SETTLEMENT
= true
Methods
atMaturity()
ACCRINTM.
public
static atMaturity(mixed $issue, mixed $settlement, mixed $rate[, mixed $parValue = 1000 ][, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ]) : float|string
Returns the accrued interest for a security that pays interest at maturity.
Excel Function: ACCRINTM(issue,settlement,rate[,par[,basis]])
Parameters
- $issue : mixed
-
The security's issue date
- $settlement : mixed
-
The security's settlement (or maturity) date
- $rate : mixed
-
The security's annual coupon rate
- $parValue : mixed = 1000
-
The security's par value. If you omit parValue, ACCRINT uses $1,000.
- $basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD
-
The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360
Return values
float|string —Result, or a string containing an error
periodic()
ACCRINT.
public
static periodic(mixed $issue, mixed $firstInterest, mixed $settlement, mixed $rate[, mixed $parValue = 1000 ][, mixed $frequency = FinancialConstants::FREQUENCY_ANNUAL ][, mixed $basis = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD ][, mixed $calcMethod = self::ACCRINT_CALCMODE_ISSUE_TO_SETTLEMENT ]) : float|string
Returns the accrued interest for a security that pays periodic interest.
Excel Function: ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis][,calc_method])
Parameters
- $issue : mixed
-
the security's issue date
- $firstInterest : mixed
-
the security's first interest date
- $settlement : mixed
-
The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
- $rate : mixed
-
The security's annual coupon rate
- $parValue : mixed = 1000
-
The security's par value. If you omit par, ACCRINT uses $1,000.
- $frequency : mixed = FinancialConstants::FREQUENCY_ANNUAL
-
The number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly
- $basis : mixed = FinancialConstants::BASIS_DAYS_PER_YEAR_NASD
-
The type of day count to use. 0 or omitted US (NASD) 30/360 1 Actual/actual 2 Actual/360 3 Actual/365 4 European 30/360
- $calcMethod : mixed = self::ACCRINT_CALCMODE_ISSUE_TO_SETTLEMENT
-
Unused by PhpSpreadsheet, and apparently by Excel (https://exceljet.net/functions/accrint-function)
Return values
float|string —Result, or a string containing an error