Overview

Packages

  • JAMA
  • None
  • PHP
  • PHPExcel
    • CachedObjectStorage
    • Calculation
    • Cell
    • Chart
      • Renderer
    • Reader
      • Excel2007
      • Excel5
    • RichText
    • Settings
    • Shared
      • Escher
      • OLE
      • Trend
      • ZipArchive
    • Style
    • Worksheet
      • Drawing
    • Writer
      • 2007
      • CSV
      • Excel2007
      • Excel5
      • HTML
      • PDF

Classes

  • PHPExcel_CalcEngine_CyclicReferenceStack
  • PHPExcel_CalcEngine_Logger
  • PHPExcel_Calculation
  • PHPExcel_Calculation_Database
  • PHPExcel_Calculation_DateTime
  • PHPExcel_Calculation_Engineering
  • PHPExcel_Calculation_ExceptionHandler
  • PHPExcel_Calculation_Financial
  • PHPExcel_Calculation_FormulaParser
  • PHPExcel_Calculation_FormulaToken
  • PHPExcel_Calculation_Function
  • PHPExcel_Calculation_Functions
  • PHPExcel_Calculation_Logical
  • PHPExcel_Calculation_LookupRef
  • PHPExcel_Calculation_MathTrig
  • PHPExcel_Calculation_Statistical
  • PHPExcel_Calculation_TextData
  • PHPExcel_Calculation_Token_Stack

Exceptions

  • PHPExcel_Calculation_Exception

Functions

  • acosh
  • asinh
  • atanh
  • mb_str_replace
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class PHPExcel_Calculation_Financial

PHPExcel_Calculation_Financial

Package: PHPExcel\Calculation
Category: PHPExcel
Copyright: Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)
License: LGPL
Located at controlador/include/phpexcel/PHPExcel/Calculation/Financial.php
Methods summary
private static boolean
# _lastDayOfMonth( DateTime $testDate )

_lastDayOfMonth

_lastDayOfMonth

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

Parameters

$testDate
The date for testing

Returns

boolean
private static boolean
# _firstDayOfMonth( DateTime $testDate )

_firstDayOfMonth

_firstDayOfMonth

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

Parameters

$testDate
The date for testing

Returns

boolean
private static
# _coupFirstPeriodDate( $settlement, $maturity, $frequency, $next )
private static
# _validFrequency( $frequency )
private static integer
# _daysPerYear( integer $year, integer $basis = 0 )

_daysPerYear

_daysPerYear

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

Parameters

$year
The year against which we're testing
$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
private static
# _interestAndPrincipal( $rate = 0, $per = 0, $nper = 0, $pv = 0, $fv = 0, $type = 0 )
public static float
# ACCRINT( mixed $issue, mixed $firstinterest, mixed $settlement, float $rate, float $par = 1000, integer $frequency = 1, integer $basis = 0 )

ACCRINT

ACCRINT

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

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

Parameters

$issue
The security's issue date.
$firstinterest
The security's first interest date.
$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.

$rate
The security's annual coupon rate.
$par

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

$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

$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

Category

Financial Functions
public static float
# ACCRINTM( mixed $issue, mixed $settlement, float $rate, float $par = 1000, integer $basis = 0 )

ACCRINTM

ACCRINTM

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

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

Parameters

$issue
The security's issue date.
$settlement
The security's settlement (or maturity) date.
$rate
The security's annual coupon rate.
$par

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

$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

Category

Financial Functions
public static float
# AMORDEGRC( float $cost, mixed $purchased, mixed $firstPeriod, mixed $salvage, float $period, float $rate, integer $basis = 0 )

AMORDEGRC

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

$cost
The cost of the asset.
$purchased
Date of the purchase of the asset.
$firstPeriod
Date of the end of the first period.
$salvage
The salvage value at the end of the life of the asset.
$period
The period.
$rate
Rate of depreciation.
$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

Category

Financial Functions
public static float
# AMORLINC( float $cost, mixed $purchased, mixed $firstPeriod, mixed $salvage, float $period, float $rate, integer $basis = 0 )

AMORLINC

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

$cost
The cost of the asset.
$purchased
Date of the purchase of the asset.
$firstPeriod
Date of the end of the first period.
$salvage
The salvage value at the end of the life of the asset.
$period
The period.
$rate
Rate of depreciation.
$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

Category

Financial Functions
public static float
# COUPDAYBS( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPDAYBS

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

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

$maturity

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

$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

$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

Category

Financial Functions
public static float
# COUPDAYS( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPDAYS

COUPDAYS

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

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

Parameters

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

$maturity

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

$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

$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

Category

Financial Functions
public static float
# COUPDAYSNC( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPDAYSNC

COUPDAYSNC

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

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

Parameters

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

$maturity

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

$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

$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

Category

Financial Functions
public static mixed
# COUPNCD( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPNCD

COUPNCD

Returns the next coupon date after the settlement date.

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

Parameters

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

$maturity

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

$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

$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

Category

Financial Functions
public static integer
# COUPNUM( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPNUM

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

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

$maturity

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

$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

$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

Category

Financial Functions
public static mixed
# COUPPCD( mixed $settlement, mixed $maturity, mixed $frequency, integer $basis = 0 )

COUPPCD

COUPPCD

Returns the previous coupon date before the settlement date.

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

Parameters

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

$maturity

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

$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

$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

Category

Financial Functions
public static float
# CUMIPMT( float $rate, integer $nper, float $pv, integer $start, integer $end, integer $type = 0 )

CUMIPMT

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

$rate
The Interest rate
$nper
The total number of payment periods
$pv
Present Value
$start

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

$end
The last period in the calculation.
$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

Category

Financial Functions
public static float
# CUMPRINC( float $rate, integer $nper, float $pv, integer $start, integer $end, integer $type = 0 )

CUMPRINC

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

$rate
The Interest rate
$nper
The total number of payment periods
$pv
Present Value
$start

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

$end
The last period in the calculation.
$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

Category

Financial Functions
public static float
# DB( float $cost, float $salvage, integer $life, integer $period, integer $month = 12 )

DB

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

$cost
Initial cost of the asset.
$salvage

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

$life

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

$period

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

$month

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

Returns

float

Category

Financial Functions
public static float
# DDB( float $cost, float $salvage, integer $life, integer $period, float $factor = 2.0 )

DDB

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

$cost
Initial cost of the asset.
$salvage

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

$life

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

$period

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

$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

Category

Financial Functions
public static float
# DISC( mixed $settlement, mixed $maturity, integer $price, integer $redemption, integer $basis = 0 )

DISC

DISC

Returns the discount rate for a security.

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

Parameters

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

$maturity

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

$price
The security's price per $100 face value.
$redemption
The security's redemption value per $100 face value.
$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

Category

Financial Functions
public static float
# DOLLARDE( float $fractional_dollar = Null, integer $fraction = 0 )

DOLLARDE

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

$fractional_dollar
Fractional Dollar
$fraction
Fraction

Returns

float

Category

Financial Functions
public static float
# DOLLARFR( float $decimal_dollar = Null, integer $fraction = 0 )

DOLLARFR

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

$decimal_dollar
Decimal Dollar
$fraction
Fraction

Returns

float

Category

Financial Functions
public static float
# EFFECT( float $nominal_rate = 0, integer $npery = 0 )

EFFECT

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

$nominal_rate
Nominal interest rate
$npery
Number of compounding payments per year

Returns

float

Category

Financial Functions
public static float
# FV( float $rate = 0, integer $nper = 0, float $pmt = 0, float $pv = 0, integer $type = 0 )

FV

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

$rate
The interest rate per period
$nper
Total number of payment periods in an annuity
$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.

$pv

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

$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

Category

Financial Functions
public static float
# FVSCHEDULE( float $principal, float[] $schedule )

FVSCHEDULE

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

$principal
The present value.
$schedule
An array of interest rates to apply.

Returns

float
public static float
# INTRATE( mixed $settlement, mixed $maturity, integer $investment, integer $redemption, integer $basis = 0 )

INTRATE

INTRATE

Returns the interest rate for a fully invested security.

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

Parameters

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

$maturity

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

$investment
The amount invested in the security.
$redemption
The amount to be received at maturity.
$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
public static float
# IPMT( float $rate, integer $per, integer $nper, float $pv, float $fv = 0, integer $type = 0 )

IPMT

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

$rate
Interest rate per period
$per
Period for which we want to find the interest
$nper
Number of periods
$pv
Present Value
$fv
Future Value
$type
Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float
public static float
# IRR( float[] $values, float $guess = 0.1 )

IRR

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

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

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

Returns

float
public static
# ISPMT( )

ISPMT

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

public static float
# MIRR( float[] $values, float $finance_rate, float $reinvestment_rate )

MIRR

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

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

$finance_rate
The interest rate you pay on the money used in the cash flows
$reinvestment_rate
The interest rate you receive on the cash flows as you reinvest them

Returns

float
public static float
# NOMINAL( float $effect_rate = 0, integer $npery = 0 )

NOMINAL

NOMINAL

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

Parameters

$effect_rate
Effective interest rate
$npery
Number of compounding payments per year

Returns

float
public static float
# NPER( float $rate = 0, integer $pmt = 0, float $pv = 0, float $fv = 0, integer $type = 0 )

NPER

NPER

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

Parameters

$rate
Interest rate per period
$pmt
Periodic payment (annuity)
$pv
Present Value
$fv
Future Value
$type
Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float
public static float
# NPV( )

NPV

NPV

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

Returns

float
public static float
# PMT( float $rate = 0, integer $nper = 0, float $pv = 0, float $fv = 0, integer $type = 0 )

PMT

PMT

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

Parameters

$rate
Interest rate per period
$nper
Number of periods
$pv
Present Value
$fv
Future Value
$type
Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float
public static float
# PPMT( float $rate, integer $per, integer $nper, float $pv, float $fv = 0, integer $type = 0 )

PPMT

PPMT

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

Parameters

$rate
Interest rate per period
$per
Period for which we want to find the interest
$nper
Number of periods
$pv
Present Value
$fv
Future Value
$type
Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float
public static
# PRICE( $settlement, $maturity, $rate, $yield, $redemption, $frequency, $basis = 0 )
public static float
# PRICEDISC( mixed $settlement, mixed $maturity, integer $discount, integer $redemption, integer $basis = 0 )

PRICEDISC

PRICEDISC

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

Parameters

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

$maturity

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

$discount
The security's discount rate.
$redemption
The security's redemption value per $100 face value.
$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
public static float
# PRICEMAT( mixed $settlement, mixed $maturity, mixed $issue, integer $rate, integer $yield, integer $basis = 0 )

PRICEMAT

PRICEMAT

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

Parameters

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

$maturity

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

$issue
The security's issue date.
$rate
The security's interest rate at date of issue.
$yield
The security's annual yield.
$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
public static float
# PV( float $rate = 0, integer $nper = 0, float $pmt = 0, float $fv = 0, integer $type = 0 )

PV

PV

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

Parameters

$rate
Interest rate per period
$nper
Number of periods
$pmt
Periodic payment (annuity)
$fv
Future Value
$type
Payment type: 0 = at the end of each period, 1 = at the beginning of each period

Returns

float
public static float
# RATE( float $nper, float $pmt, float $pv, float $fv = 0.0, integer $type = 0, float $guess = 0.1 )

RATE

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

$nper
The total number of payment periods in an annuity.
$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.

$pv

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

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

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

$guess

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

Returns

float

Category

Financial Functions
public static float
# RECEIVED( mixed $settlement, mixed $maturity, integer $investment, integer $discount, integer $basis = 0 )

RECEIVED

RECEIVED

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

Parameters

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

$maturity

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

$investment
The amount invested in the security.
$discount
The security's discount rate.
$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
public static float
# SLN( cost $cost, salvage $salvage, life $life )

SLN

SLN

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

Parameters

$cost
cost of the asset
$salvage
at the end of the depreciation
$life
of periods over which the asset is depreciated

Returns

float
public static float
# SYD( cost $cost, salvage $salvage, life $life, period $period )

SYD

SYD

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

Parameters

$cost
cost of the asset
$salvage
at the end of the depreciation
$life
of periods over which the asset is depreciated
$period
Period

Returns

float
public static float
# TBILLEQ( mixed $settlement, mixed $maturity, integer $discount )

TBILLEQ

TBILLEQ

Returns the bond-equivalent yield for a Treasury bill.

Parameters

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

$maturity

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

$discount
The Treasury bill's discount rate.

Returns

float
public static float
# TBILLPRICE( mixed $settlement, mixed $maturity, integer $discount )

TBILLPRICE

TBILLPRICE

Returns the yield for a Treasury bill.

Parameters

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

$maturity

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

$discount
The Treasury bill's discount rate.

Returns

float
public static float
# TBILLYIELD( mixed $settlement, mixed $maturity, integer $price )

TBILLYIELD

TBILLYIELD

Returns the yield for a Treasury bill.

Parameters

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

$maturity

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

$price
The Treasury bill's price per $100 face value.

Returns

float
public static
# XIRR( $values, $dates, $guess = 0.1 )
public static float
# XNPV( float $rate, array $values, array $dates )

XNPV

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

$rate
The discount rate to apply to the cash flows.
$values
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.
$dates
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
public static float
# YIELDDISC( mixed $settlement, mixed $maturity, integer $price, integer $redemption, integer $basis = 0 )

YIELDDISC

YIELDDISC

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

Parameters

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

$maturity

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

$price
The security's price per $100 face value.
$redemption
The security's redemption value per $100 face value.
$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
public static float
# YIELDMAT( mixed $settlement, mixed $maturity, mixed $issue, integer $rate, integer $price, integer $basis = 0 )

YIELDMAT

YIELDMAT

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

Parameters

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

$maturity

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

$issue
The security's issue date.
$rate
The security's interest rate at date of issue.
$price
The security's price per $100 face value.
$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
Autene API documentation generated by ApiGen