Methods

ACCRINT()

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

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.

int $frequency

the number of coupon payments per year. Valid frequency values are: 1 Annual 2 Semi-Annual 4 Quarterly If working in Gnumeric Mode, the following frequency options are also available 6 Bimonthly 12 Monthly

int $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 —

ACCRINTM()

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

ACCRINTM

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

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

Parameters

mixed $issue
mixed $settlement
mixed $rate
mixed $par
mixed $basis

Returns

float —

AMORDEGRC()

AMORDEGRC(mixed  $cost, mixed  $purchased, mixed  $firstPeriod, mixed  $salvage, mixed  $period, mixed  $rate, mixed  $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

mixed $cost
mixed $purchased
mixed $firstPeriod
mixed $salvage
mixed $period
mixed $rate
mixed $basis

Returns

float —

AMORLINC()

AMORLINC(mixed  $cost, mixed  $purchased, mixed  $firstPeriod, mixed  $salvage, mixed  $period, mixed  $rate, mixed  $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

mixed $cost
mixed $purchased
mixed $firstPeriod
mixed $salvage
mixed $period
mixed $rate
mixed $basis

Returns

float —

COUPDAYBS()

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

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
mixed $maturity
mixed $frequency
mixed $basis

Returns

float —

COUPDAYS()

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

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
mixed $maturity
mixed $frequency
mixed $basis

Returns

float —

COUPDAYSNC()

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

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
mixed $maturity
mixed $frequency
mixed $basis

Returns

float —

COUPNCD()

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

COUPNCD

Returns the next coupon date after the settlement date.

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

Parameters

mixed $settlement
mixed $maturity
mixed $frequency
mixed $basis

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, mixed  $basis) : int

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
mixed $maturity
mixed $frequency
mixed $basis

Returns

int —

COUPPCD()

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

COUPPCD

Returns the previous coupon date before the settlement date.

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

Parameters

mixed $settlement
mixed $maturity
mixed $frequency
mixed $basis

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, int  $nper, float  $pv, int  $start, int  $end, int  $type) : float

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

int $nper

The total number of payment periods

float $pv

Present Value

int $start

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

int $end

The last period in the calculation.

int $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 —

CUMPRINC()

CUMPRINC(float  $rate, int  $nper, float  $pv, int  $start, int  $end, int  $type) : float

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

int $nper

The total number of payment periods

float $pv

Present Value

int $start

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

int $end

The last period in the calculation.

int $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 —

DB()

DB(mixed  $cost, mixed  $salvage, mixed  $life, mixed  $period, mixed  $month = 12) : float

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

mixed $cost
mixed $salvage
mixed $life
mixed $period
mixed $month

Returns

float —

DDB()

DDB(mixed  $cost, mixed  $salvage, mixed  $life, mixed  $period, mixed  $factor = 2.0) : float

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

mixed $cost
mixed $salvage
mixed $life
mixed $period
mixed $factor

Returns

float —

DISC()

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

DISC

Returns the discount rate for a security.

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

Parameters

mixed $settlement
mixed $maturity
mixed $price
mixed $redemption
mixed $basis

Returns

float —

DOLLARDE()

DOLLARDE(float  $fractional_dollar = Null, int  $fraction) : float

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

int $fraction

Fraction

Returns

float —

DOLLARFR()

DOLLARFR(float  $decimal_dollar = Null, int  $fraction) : float

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

int $fraction

Fraction

Returns

float —

EFFECT()

EFFECT(float  $nominal_rate, int  $npery) : float

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

int $npery

Number of compounding payments per year

Returns

float —

FV()

FV(float  $rate, int  $nper, float  $pmt, float  $pv, int  $type) : float

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

int $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.

int $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 —

FVSCHEDULE()

FVSCHEDULE(float  $principal, 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.

float[] $schedule

An array of interest rates to apply.

Returns

float —

INTRATE()

INTRATE(mixed  $settlement, mixed  $maturity, int  $investment, int  $redemption, int  $basis) : float

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.

int $investment

The amount invested in the security.

int $redemption

The amount to be received at maturity.

int $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 —

IPMT()

IPMT(float  $rate, int  $per, int  $nper, float  $pv, float  $fv, int  $type) : float

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

int $per

Period for which we want to find the interest

int $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

int $type

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

Returns

float —

IRR()

IRR(float[]  $values, float  $guess = 0.1) : float

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

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 —

ISPMT()

ISPMT() : mixed

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

Returns

mixed —

MIRR()

MIRR(float[]  $values, float  $finance_rate, float  $reinvestment_rate) : float

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

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 —

NOMINAL()

NOMINAL(float  $effect_rate, int  $npery) : float

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

int $npery

Number of compounding payments per year

Returns

float —

NPER()

NPER(float  $rate, int  $pmt, float  $pv, float  $fv, int  $type) : float

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

int $pmt

Periodic payment (annuity)

float $pv

Present Value

float $fv

Future Value

int $type

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

Returns

float —

NPV()

NPV() : float

NPV

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

Returns

float —

PMT()

PMT(float  $rate, int  $nper, float  $pv, float  $fv, int  $type) : float

PMT

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

Parameters

float $rate

Interest rate per period

int $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

int $type

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

Returns

float —

PPMT()

PPMT(float  $rate, int  $per, int  $nper, float  $pv, float  $fv, int  $type) : float

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

int $per

Period for which we want to find the interest

int $nper

Number of periods

float $pv

Present Value

float $fv

Future Value

int $type

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

Returns

float —

PRICE()

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

Parameters

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

Returns

mixed —

PRICEDISC()

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

PRICEDISC

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

Parameters

mixed $settlement
mixed $maturity
mixed $discount
mixed $redemption
mixed $basis

Returns

float —

PRICEMAT()

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

PRICEMAT

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

Parameters

mixed $settlement
mixed $maturity
mixed $issue
mixed $rate
mixed $yield
mixed $basis

Returns

float —

PV()

PV(float  $rate, int  $nper, float  $pmt, float  $fv, int  $type) : float

PV

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

Parameters

float $rate

Interest rate per period

int $nper

Number of periods

float $pmt

Periodic payment (annuity)

float $fv

Future Value

int $type

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

Returns

float —

RATE()

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

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

mixed $nper
mixed $pmt
mixed $pv
mixed $fv
mixed $type
mixed $guess

Returns

float —

RECEIVED()

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

RECEIVED

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

Parameters

mixed $settlement
mixed $maturity
mixed $investment
mixed $discount
mixed $basis

Returns

float —

SLN()

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

SLN

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

Parameters

mixed $cost
mixed $salvage
mixed $life

Returns

float —

SYD()

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

SYD

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

Parameters

mixed $cost
mixed $salvage
mixed $life
mixed $period

Returns

float —

TBILLEQ()

TBILLEQ(mixed  $settlement, mixed  $maturity, mixed  $discount) : float

TBILLEQ

Returns the bond-equivalent yield for a Treasury bill.

Parameters

mixed $settlement
mixed $maturity
mixed $discount

Returns

float —

TBILLPRICE()

TBILLPRICE(mixed  $settlement, mixed  $maturity, mixed  $discount) : float

TBILLPRICE

Returns the yield for a Treasury bill.

Parameters

mixed $settlement
mixed $maturity
mixed $discount

Returns

float —

TBILLYIELD()

TBILLYIELD(mixed  $settlement, mixed  $maturity, mixed  $price) : float

TBILLYIELD

Returns the yield for a Treasury bill.

Parameters

mixed $settlement
mixed $maturity
mixed $price

Returns

float —

XIRR()

XIRR(mixed  $values, mixed  $dates, mixed  $guess = 0.1) : mixed

Parameters

mixed $values
mixed $dates
mixed $guess

Returns

mixed —

XNPV()

XNPV(float  $rate, mixed  $values, mixed  $dates) : float

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.

mixed $values
mixed $dates

Returns

float —

YIELDDISC()

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

YIELDDISC

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

Parameters

mixed $settlement
mixed $maturity
mixed $price
mixed $redemption
mixed $basis

Returns

float —

YIELDMAT()

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

YIELDMAT

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

Parameters

mixed $settlement
mixed $maturity
mixed $issue
mixed $rate
mixed $price
mixed $basis

Returns

float —

_lastDayOfMonth()

_lastDayOfMonth(\DateTime  $testDate) : bool

_lastDayOfMonth

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

Parameters

\DateTime $testDate

The date for testing

Returns

bool —

_firstDayOfMonth()

_firstDayOfMonth(\DateTime  $testDate) : bool

_firstDayOfMonth

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

Parameters

\DateTime $testDate

The date for testing

Returns

bool —

_coupFirstPeriodDate()

_coupFirstPeriodDate(mixed  $settlement, mixed  $maturity, mixed  $frequency, mixed  $next) : mixed

Parameters

mixed $settlement
mixed $maturity
mixed $frequency
mixed $next

Returns

mixed —

_validFrequency()

_validFrequency(mixed  $frequency) : mixed

Parameters

mixed $frequency

Returns

mixed —

_daysPerYear()

_daysPerYear(int  $year, int  $basis) : int

_daysPerYear

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

Parameters

int $year

The year against which we're testing

int $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

int —

_interestAndPrincipal()

_interestAndPrincipal(mixed  $rate, mixed  $per, mixed  $nper, mixed  $pv, mixed  $fv, mixed  $type) : mixed

Parameters

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

Returns

mixed —