Constants

FINANCIAL_MAX_ITERATIONS

FINANCIAL_MAX_ITERATIONS = 128

FINANCIAL_PRECISION

FINANCIAL_PRECISION = 1.0E-8

Methods

ACCRINT()

ACCRINT(mixed  $issue, mixed  $firstinterest, mixed  $settlement, float  $rate, float  $par = 1000, integer  $frequency = 1, integer  $basis) : float|string

ACCRINT.

Returns the accrued interest for a security that pays periodic interest.

Excel Function: ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis])

Parameters

mixed $issue

the security's issue date

mixed $firstinterest

the security's first interest date

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

float $rate

the security's annual coupon rate

float $par

The security's par value. If you omit par, ACCRINT uses $1,000.

integer $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

float|string —

Result, or a string containing an error

ACCRINTM()

ACCRINTM(mixed  $issue, mixed  $settlement, float  $rate, float  $par = 1000, integer  $basis) : float|string

ACCRINTM.

Returns the accrued interest for a security that pays interest at maturity.

Excel Function: ACCRINTM(issue,settlement,rate[,par[,basis]])

Parameters

mixed $issue

The security's issue date

mixed $settlement

The security's settlement (or maturity) date

float $rate

The security's annual coupon rate

float $par

The security's par value. If you omit par, ACCRINT uses $1,000.

integer $basis

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

Returns

float|string —

Result, or a string containing an error

AMORDEGRC()

AMORDEGRC(float  $cost, mixed  $purchased, mixed  $firstPeriod, mixed  $salvage, float  $period, float  $rate, integer  $basis) : float

AMORDEGRC.

Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account. The function is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets. This function will return the depreciation until the last period of the life of the assets or until the cumulated value of depreciation is greater than the cost of the assets minus the salvage value.

Excel Function: AMORDEGRC(cost,purchased,firstPeriod,salvage,period,rate[,basis])

Parameters

float $cost

The cost of the asset

mixed $purchased

Date of the purchase of the asset

mixed $firstPeriod

Date of the end of the first period

mixed $salvage

The salvage value at the end of the life of the asset

float $period

The period

float $rate

Rate of depreciation

integer $basis

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

Returns

float

AMORLINC()

AMORLINC(float  $cost, mixed  $purchased, mixed  $firstPeriod, mixed  $salvage, float  $period, float  $rate, integer  $basis) : float

AMORLINC.

Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account.

Excel Function: AMORLINC(cost,purchased,firstPeriod,salvage,period,rate[,basis])

Parameters

float $cost

The cost of the asset

mixed $purchased

Date of the purchase of the asset

mixed $firstPeriod

Date of the end of the first period

mixed $salvage

The salvage value at the end of the life of the asset

float $period

The period

float $rate

Rate of depreciation

integer $basis

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

Returns

float

COUPDAYBS()

COUPDAYBS(mixed  $settlement, mixed  $maturity, integer  $frequency, integer  $basis) : float|string

COUPDAYBS.

Returns the number of days from the beginning of the coupon period to the settlement date.

Excel Function: COUPDAYBS(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

float|string

COUPDAYS()

COUPDAYS(mixed  $settlement, mixed  $maturity, mixed  $frequency, integer  $basis) : float|string

COUPDAYS.

Returns the number of days in the coupon period that contains the settlement date.

Excel Function: COUPDAYS(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

float|string

COUPDAYSNC()

COUPDAYSNC(mixed  $settlement, mixed  $maturity, mixed  $frequency, integer  $basis) : float|string

COUPDAYSNC.

Returns the number of days from the settlement date to the next coupon date.

Excel Function: COUPDAYSNC(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

float|string

COUPNCD()

COUPNCD(mixed  $settlement, mixed  $maturity, mixed  $frequency, integer  $basis) : mixed

COUPNCD.

Returns the next coupon date after the settlement date.

Excel Function: COUPNCD(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

mixed —

Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

COUPNUM()

COUPNUM(mixed  $settlement, mixed  $maturity, mixed  $frequency, integer  $basis) : integer|string

COUPNUM.

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

Excel Function: COUPNUM(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

integer|string

COUPPCD()

COUPPCD(mixed  $settlement, mixed  $maturity, mixed  $frequency, integer  $basis) : mixed

COUPPCD.

Returns the previous coupon date before the settlement date.

Excel Function: COUPPCD(settlement,maturity,frequency[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly

integer $basis

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

Returns

mixed —

Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag

CUMIPMT()

CUMIPMT(float  $rate, integer  $nper, float  $pv, integer  $start, integer  $end, integer  $type) : float|string

CUMIPMT.

Returns the cumulative interest paid on a loan between the start and end periods.

Excel Function: CUMIPMT(rate,nper,pv,start,end[,type])

Parameters

float $rate

The Interest rate

integer $nper

The total number of payment periods

float $pv

Present Value

integer $start

The first period in the calculation. Payment periods are numbered beginning with 1.

integer $end

the last period in the calculation

integer $type

A number 0 or 1 and indicates when payments are due: 0 or omitted At the end of the period. 1 At the beginning of the period.

Returns

float|string

CUMPRINC()

CUMPRINC(float  $rate, integer  $nper, float  $pv, integer  $start, integer  $end, integer  $type) : float|string

CUMPRINC.

Returns the cumulative principal paid on a loan between the start and end periods.

Excel Function: CUMPRINC(rate,nper,pv,start,end[,type])

Parameters

float $rate

The Interest rate

integer $nper

The total number of payment periods

float $pv

Present Value

integer $start

The first period in the calculation. Payment periods are numbered beginning with 1.

integer $end

the last period in the calculation

integer $type

A number 0 or 1 and indicates when payments are due: 0 or omitted At the end of the period. 1 At the beginning of the period.

Returns

float|string

DB()

DB(float  $cost, float  $salvage, integer  $life, integer  $period, integer  $month = 12) : float|string

DB.

Returns the depreciation of an asset for a specified period using the fixed-declining balance method. This form of depreciation is used if you want to get a higher depreciation value at the beginning of the depreciation (as opposed to linear depreciation). The depreciation value is reduced with every depreciation period by the depreciation already deducted from the initial cost.

Excel Function: DB(cost,salvage,life,period[,month])

Parameters

float $cost

Initial cost of the asset

float $salvage

Value at the end of the depreciation. (Sometimes called the salvage value of the asset)

integer $life

Number of periods over which the asset is depreciated. (Sometimes called the useful life of the asset)

integer $period

The period for which you want to calculate the depreciation. Period must use the same units as life.

integer $month

Number of months in the first year. If month is omitted, it defaults to 12.

Returns

float|string

DDB()

DDB(float  $cost, float  $salvage, integer  $life, integer  $period, float  $factor = 2.0) : float|string

DDB.

Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.

Excel Function: DDB(cost,salvage,life,period[,factor])

Parameters

float $cost

Initial cost of the asset

float $salvage

Value at the end of the depreciation. (Sometimes called the salvage value of the asset)

integer $life

Number of periods over which the asset is depreciated. (Sometimes called the useful life of the asset)

integer $period

The period for which you want to calculate the depreciation. Period must use the same units as life.

float $factor

The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method).

Returns

float|string

DISC()

DISC(mixed  $settlement, mixed  $maturity, integer  $price, integer  $redemption, integer  $basis) : float|string

DISC.

Returns the discount rate for a security.

Excel Function: DISC(settlement,maturity,price,redemption[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $price

The security's price per $100 face value

integer $redemption

The security's redemption value per $100 face value

integer $basis

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

Returns

float|string

DOLLARDE()

DOLLARDE(float  $fractional_dollar = null, integer  $fraction) : float|string

DOLLARDE.

Converts a dollar price expressed as an integer part and a fraction part into a dollar price expressed as a decimal number. Fractional dollar numbers are sometimes used for security prices.

Excel Function: DOLLARDE(fractional_dollar,fraction)

Parameters

float $fractional_dollar

Fractional Dollar

integer $fraction

Fraction

Returns

float|string

DOLLARFR()

DOLLARFR(float  $decimal_dollar = null, integer  $fraction) : float|string

DOLLARFR.

Converts a dollar price expressed as a decimal number into a dollar price expressed as a fraction. Fractional dollar numbers are sometimes used for security prices.

Excel Function: DOLLARFR(decimal_dollar,fraction)

Parameters

float $decimal_dollar

Decimal Dollar

integer $fraction

Fraction

Returns

float|string

EFFECT()

EFFECT(float  $nominal_rate, integer  $npery) : float|string

EFFECT.

Returns the effective interest rate given the nominal rate and the number of compounding payments per year.

Excel Function: EFFECT(nominal_rate,npery)

Parameters

float $nominal_rate

Nominal interest rate

integer $npery

Number of compounding payments per year

Returns

float|string

FV()

FV(float  $rate, integer  $nper, float  $pmt, float  $pv, integer  $type) : float|string

FV.

Returns the Future Value of a cash flow with constant payments and interest rate (annuities).

Excel Function: FV(rate,nper,pmt[,pv[,type]])

Parameters

float $rate

The interest rate per period

integer $nper

Total number of payment periods in an annuity

float $pmt

The payment made each period: it cannot change over the life of the annuity. Typically, pmt contains principal and interest but no other fees or taxes.

float $pv

present Value, or the lump-sum amount that a series of future payments is worth right now

integer $type

A number 0 or 1 and indicates when payments are due: 0 or omitted At the end of the period. 1 At the beginning of the period.

Returns

float|string

FVSCHEDULE()

FVSCHEDULE(float  $principal, array<mixed,float>  $schedule) : float

FVSCHEDULE.

Returns the future value of an initial principal after applying a series of compound interest rates. Use FVSCHEDULE to calculate the future value of an investment with a variable or adjustable rate.

Excel Function: FVSCHEDULE(principal,schedule)

Parameters

float $principal

the present value

array<mixed,float> $schedule

an array of interest rates to apply

Returns

float

INTRATE()

INTRATE(mixed  $settlement, mixed  $maturity, integer  $investment, integer  $redemption, integer  $basis) : float|string

INTRATE.

Returns the interest rate for a fully invested security.

Excel Function: INTRATE(settlement,maturity,investment,redemption[,basis])

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $investment

the amount invested in the security

integer $redemption

the amount to be received at maturity

integer $basis

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

Returns

float|string

IPMT()

IPMT(float  $rate, integer  $per, integer  $nper, float  $pv, float  $fv, integer  $type) : float|string

IPMT.

Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.

Excel Function: IPMT(rate,per,nper,pv[,fv][,type])

Parameters

float $rate

Interest rate per period

integer $per

Period for which we want to find the interest

integer $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

integer $type

Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float|string

IRR()

IRR(array<mixed,float>  $values, float  $guess = 0.1) : float|string

IRR.

Returns the internal rate of return for a series of cash flows represented by the numbers in values. These cash flows do not have to be even, as they would be for an annuity. However, the cash flows must occur at regular intervals, such as monthly or annually. The internal rate of return is the interest rate received for an investment consisting of payments (negative values) and income (positive values) that occur at regular periods.

Excel Function: IRR(values[,guess])

Parameters

array<mixed,float> $values

An array or a reference to cells that contain numbers for which you want to calculate the internal rate of return. Values must contain at least one positive value and one negative value to calculate the internal rate of return.

float $guess

A number that you guess is close to the result of IRR

Returns

float|string

ISPMT()

ISPMT(  $args) 

ISPMT.

Returns the interest payment for an investment based on an interest rate and a constant payment schedule.

Excel Function: =ISPMT(interest_rate, period, number_payments, PV)

interest_rate is the interest rate for the investment

period is the period to calculate the interest rate. It must be betweeen 1 and number_payments.

number_payments is the number of payments for the annuity

PV is the loan amount or present value of the payments

Parameters

$args

MIRR()

MIRR(array<mixed,float>  $values, float  $finance_rate, float  $reinvestment_rate) : float|string

MIRR.

Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost of the investment and the interest received on reinvestment of cash.

Excel Function: MIRR(values,finance_rate, reinvestment_rate)

Parameters

array<mixed,float> $values

An array or a reference to cells that contain a series of payments and income occurring at regular intervals. Payments are negative value, income is positive values.

float $finance_rate

The interest rate you pay on the money used in the cash flows

float $reinvestment_rate

The interest rate you receive on the cash flows as you reinvest them

Returns

float|string —

Result, or a string containing an error

NOMINAL()

NOMINAL(float  $effect_rate, integer  $npery) : float|string

NOMINAL.

Returns the nominal interest rate given the effective rate and the number of compounding payments per year.

Parameters

float $effect_rate

Effective interest rate

integer $npery

Number of compounding payments per year

Returns

float|string —

Result, or a string containing an error

NPER()

NPER(float  $rate, integer  $pmt, float  $pv, float  $fv, integer  $type) : float|string

NPER.

Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.

Parameters

float $rate

Interest rate per period

integer $pmt

Periodic payment (annuity)

float $pv

Present Value

float $fv

Future Value

integer $type

Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float|string —

Result, or a string containing an error

NPV()

NPV(  $args) : float

NPV.

Returns the Net Present Value of a cash flow series given a discount rate.

Parameters

$args

Returns

float

PDURATION()

PDURATION(float  $rate, float  $pv, float  $fv) : float|string

PDURATION.

Calculates the number of periods required for an investment to reach a specified value.

Parameters

float $rate

Interest rate per period

float $pv

Present Value

float $fv

Future Value

Returns

float|string —

Result, or a string containing an error

PMT()

PMT(float  $rate, integer  $nper, float  $pv, float  $fv, integer  $type) : float|string

PMT.

Returns the constant payment (annuity) for a cash flow with a constant interest rate.

Parameters

float $rate

Interest rate per period

integer $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

integer $type

Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float|string —

Result, or a string containing an error

PPMT()

PPMT(float  $rate, integer  $per, integer  $nper, float  $pv, float  $fv, integer  $type) : float|string

PPMT.

Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.

Parameters

float $rate

Interest rate per period

integer $per

Period for which we want to find the interest

integer $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

integer $type

Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float|string —

Result, or a string containing an error

PRICE()

PRICE(  $settlement,   $maturity,   $rate,   $yield,   $redemption,   $frequency,   $basis) 

Parameters

$settlement
$maturity
$rate
$yield
$redemption
$frequency
$basis

PRICEDISC()

PRICEDISC(mixed  $settlement, mixed  $maturity, integer  $discount, integer  $redemption, integer  $basis) : float|string

PRICEDISC.

Returns the price per $100 face value of a discounted security.

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $discount

The security's discount rate

integer $redemption

The security's redemption value per $100 face value

integer $basis

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

Returns

float|string —

Result, or a string containing an error

PRICEMAT()

PRICEMAT(mixed  $settlement, mixed  $maturity, mixed  $issue, integer  $rate, integer  $yield, integer  $basis) : float|string

PRICEMAT.

Returns the price per $100 face value of a security that pays interest at maturity.

Parameters

mixed $settlement

The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $issue

The security's issue date

integer $rate

The security's interest rate at date of issue

integer $yield

The security's annual yield

integer $basis

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

Returns

float|string —

Result, or a string containing an error

PV()

PV(float  $rate, integer  $nper, float  $pmt, float  $fv, integer  $type) : float|string

PV.

Returns the Present Value of a cash flow with constant payments and interest rate (annuities).

Parameters

float $rate

Interest rate per period

integer $nper

Number of periods

float $pmt

Periodic payment (annuity)

float $fv

Future Value

integer $type

Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float|string —

Result, or a string containing an error

RATE()

RATE(float  $nper, float  $pmt, float  $pv, float  $fv = 0.0, integer  $type, float  $guess = 0.1) : float|string

RATE.

Returns the interest rate per period of an annuity. RATE is calculated by iteration and can have zero or more solutions. If the successive results of RATE do not converge to within 0.0000001 after 20 iterations, RATE returns the #NUM! error value.

Excel Function: RATE(nper,pmt,pv[,fv[,type[,guess]]])

Parameters

float $nper

The total number of payment periods in an annuity

float $pmt

The payment made each period and cannot change over the life of the annuity. Typically, pmt includes principal and interest but no other fees or taxes.

float $pv

The present value - the total amount that a series of future payments is worth now

float $fv

The future value, or a cash balance you want to attain after the last payment is made. If fv is omitted, it is assumed to be 0 (the future value of a loan, for example, is 0).

integer $type

A number 0 or 1 and indicates when payments are due: 0 or omitted At the end of the period. 1 At the beginning of the period.

float $guess

Your guess for what the rate will be. If you omit guess, it is assumed to be 10 percent.

Returns

float|string

RECEIVED()

RECEIVED(mixed  $settlement, mixed  $maturity, integer  $investment, integer  $discount, integer  $basis) : float|string

RECEIVED.

Returns the price per $100 face value of a discounted security.

Parameters

mixed $settlement

The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $investment

The amount invested in the security

integer $discount

The security's discount rate

integer $basis

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

Returns

float|string —

Result, or a string containing an error

RRI()

RRI(float  $nper, float  $pv, float  $fv) : float|string

RRI.

Calculates the interest rate required for an investment to grow to a specified future value .

Parameters

float $nper

The number of periods over which the investment is made

float $pv

Present Value

float $fv

Future Value

Returns

float|string —

Result, or a string containing an error

SLN()

SLN(mixed  $cost, mixed  $salvage, mixed  $life) : float|string

SLN.

Returns the straight-line depreciation of an asset for one period

Parameters

mixed $cost

Initial cost of the asset

mixed $salvage

Value at the end of the depreciation

mixed $life

Number of periods over which the asset is depreciated

Returns

float|string —

Result, or a string containing an error

SYD()

SYD(mixed  $cost, mixed  $salvage, mixed  $life, mixed  $period) : float|string

SYD.

Returns the sum-of-years' digits depreciation of an asset for a specified period.

Parameters

mixed $cost

Initial cost of the asset

mixed $salvage

Value at the end of the depreciation

mixed $life

Number of periods over which the asset is depreciated

mixed $period

Period

Returns

float|string —

Result, or a string containing an error

TBILLEQ()

TBILLEQ(mixed  $settlement, mixed  $maturity, integer  $discount) : float|string

TBILLEQ.

Returns the bond-equivalent yield for a Treasury bill.

Parameters

mixed $settlement

The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.

mixed $maturity

The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.

integer $discount

The Treasury bill's discount rate

Returns

float|string —

Result, or a string containing an error

TBILLPRICE()

TBILLPRICE(mixed  $settlement, mixed  $maturity, integer  $discount) : float|string

TBILLPRICE.

Returns the yield for a Treasury bill.

Parameters

mixed $settlement

The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.

mixed $maturity

The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.

integer $discount

The Treasury bill's discount rate

Returns

float|string —

Result, or a string containing an error

TBILLYIELD()

TBILLYIELD(mixed  $settlement, mixed  $maturity, integer  $price) : float|mixed|string

TBILLYIELD.

Returns the yield for a Treasury bill.

Parameters

mixed $settlement

The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.

mixed $maturity

The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.

integer $price

The Treasury bill's price per $100 face value

Returns

float|mixed|string

XIRR()

XIRR(array<mixed,float>  $values, array<mixed,mixed>  $dates, float  $guess = 0.1) : float|mixed|string

XIRR.

Returns the internal rate of return for a schedule of cash flows that is not necessarily periodic.

Excel Function: =XIRR(values,dates,guess)

Parameters

array<mixed,float> $values

A series of cash flow payments The series of values must contain at least one positive value & one negative value

array<mixed,mixed> $dates

A series of payment dates The first payment date indicates the beginning of the schedule of payments All other dates must be later than this date, but they may occur in any order

float $guess

An optional guess at the expected answer

Returns

float|mixed|string

XNPV()

XNPV(float  $rate, array<mixed,float>  $values, array<mixed,mixed>  $dates) : float|mixed|string

XNPV.

Returns the net present value for a schedule of cash flows that is not necessarily periodic. To calculate the net present value for a series of cash flows that is periodic, use the NPV function.

Excel Function: =XNPV(rate,values,dates)

Parameters

float $rate

the discount rate to apply to the cash flows

array<mixed,float> $values

A series of cash flows that corresponds to a schedule of payments in dates. The first payment is optional and corresponds to a cost or payment that occurs at the beginning of the investment. If the first value is a cost or payment, it must be a negative value. All succeeding payments are discounted based on a 365-day year. The series of values must contain at least one positive value and one negative value.

array<mixed,mixed> $dates

A schedule of payment dates that corresponds to the cash flow payments. The first payment date indicates the beginning of the schedule of payments. All other dates must be later than this date, but they may occur in any order.

Returns

float|mixed|string

YIELDDISC()

YIELDDISC(mixed  $settlement, mixed  $maturity, integer  $price, integer  $redemption, integer  $basis) : float|string

YIELDDISC.

Returns the annual yield of a security that pays interest at maturity.

Parameters

mixed $settlement

The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

integer $price

The security's price per $100 face value

integer $redemption

The security's redemption value per $100 face value

integer $basis

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

Returns

float|string —

Result, or a string containing an error

YIELDMAT()

YIELDMAT(mixed  $settlement, mixed  $maturity, mixed  $issue, integer  $rate, integer  $price, integer  $basis) : float|string

YIELDMAT.

Returns the annual yield of a security that pays interest at maturity.

Parameters

mixed $settlement

The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.

mixed $maturity

The security's maturity date. The maturity date is the date when the security expires.

mixed $issue

The security's issue date

integer $rate

The security's interest rate at date of issue

integer $price

The security's price per $100 face value

integer $basis

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

Returns

float|string —

Result, or a string containing an error

isLastDayOfMonth()

isLastDayOfMonth(\DateTime  $testDate) : boolean

isLastDayOfMonth.

Returns a boolean TRUE/FALSE indicating if this date is the last date of the month

Parameters

\DateTime $testDate

The date for testing

Returns

boolean

couponFirstPeriodDate()

couponFirstPeriodDate(  $settlement,   $maturity,   $frequency,   $next) 

Parameters

$settlement
$maturity
$frequency
$next

isValidFrequency()

isValidFrequency(  $frequency) 

Parameters

$frequency

daysPerYear()

daysPerYear(integer|string  $year, integer|string  $basis) : integer|string

daysPerYear.

Returns the number of days in a specified year, as defined by the "basis" value

Parameters

integer|string $year

The year against which we're testing

integer|string $basis

The type of day count: 0 or omitted US (NASD) 360 1 Actual (365 or 366 in a leap year) 2 360 3 365 4 European 360

Returns

integer|string —

Result, or a string containing an error

interestAndPrincipal()

interestAndPrincipal(  $rate,   $per,   $nper,   $pv,   $fv,   $type) 

Parameters

$rate
$per
$nper
$pv
$fv
$type

validatePrice()

validatePrice(  $settlement,   $maturity,   $rate,   $yield,   $redemption,   $frequency,   $basis) 

Parameters

$settlement
$maturity
$rate
$yield
$redemption
$frequency
$basis

rateNextGuess()

rateNextGuess(  $rate,   $nper,   $pmt,   $pv,   $fv,   $type) 

Parameters

$rate
$nper
$pmt
$pv
$fv
$type

bothNegAndPos()

bothNegAndPos(  $neg,   $pos) 

Parameters

$neg
$pos

xirrPart2()

xirrPart2(  $values) 

Parameters

$values

xirrPart1()

xirrPart1(  $values,   $dates) 

Parameters

$values
$dates

xirrPart3()

xirrPart3(  $values,   $dates,   $x1,   $x2) 

Parameters

$values
$dates
$x1
$x2

validateXnpv()

validateXnpv(  $rate,   $values,   $dates) 

Parameters

$rate
$values
$dates

xnpvOrdered()

xnpvOrdered(  $rate,   $values,   $dates,   $ordered = true) 

Parameters

$rate
$values
$dates
$ordered