Documentation

Cumulative
in package

Table of Contents

Methods

interest()  : string|float|int
CUMIPMT.
principal()  : string|float|int
CUMPRINC.

Methods

interest()

CUMIPMT.

public static interest(mixed $rate, mixed $periods, mixed $presentValue, mixed $start, mixed $end[, mixed $type = FinancialConstants::PAYMENT_END_OF_PERIOD ]) : string|float|int

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 : mixed

The Interest rate

$periods : mixed

The total number of payment periods

$presentValue : mixed

Present Value

$start : mixed

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

$end : mixed

the last period in the calculation

$type : mixed = FinancialConstants::PAYMENT_END_OF_PERIOD

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.

Return values
string|float|int

principal()

CUMPRINC.

public static principal(mixed $rate, mixed $periods, mixed $presentValue, mixed $start, mixed $end[, mixed $type = FinancialConstants::PAYMENT_END_OF_PERIOD ]) : string|float|int

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 : mixed

The Interest rate

$periods : mixed

The total number of payment periods as an integer

$presentValue : mixed

Present Value

$start : mixed

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

$end : mixed

the last period in the calculation

$type : mixed = FinancialConstants::PAYMENT_END_OF_PERIOD

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.

Return values
string|float|int

        
On this page

Search results