IFinance.CumIpmt

Fore Syntax

CumIpmt(Rate: Double;

PeriodCount: Integer;

PresentValue: Double;

StartPeriod: Integer;

EndPeriod: Integer;

Type: Integer): Doulbe;

Fore.NET Syntax

CumIpmt(Rate: double;

PeriodCount: integer;

PresentValue: double;

StartPeriod: integer;

EndPeriod: integer;

Type: integer): doulbe;

Parameters

Parameters	Description	Constraints
Rate	Interest rate.	Must be positive.
PeriodCount	Number of payment periods.	Must be positive.
PresentValue	Current investments value.	Must be positive.
StartPeriod	The number of the first period, included into calculations. Payment periods are numbered, starting from 1.	Must be in the [1;PeriodCount] interval.
EndPeriod	The number of the last period, included into calculations.	Must be in the [StartPeriod;PeriodCount] interval.
Type	Selecting time of payment: 0 - in the end of the period. 1 - in the beginning of the period.	Must take the value 0 or 1.

Description

The CumImpt method returns cumulative sum of interest on loan paid between two settlement periods.

Comments

CumImpt is calculated using the following formula:

Where:

Pmt. Monthly payment on loan.

To get monthly payment on loan, use the IFinance.Pmt method.

Fore Example

To execute the example, add a link to the MathFin system assembly.

Sub UserProc;
Var
    r: Double;
Begin
    r := Finance.CumIpmt(3.5, 24, 12000, 1, 1, 0);
    Debug.WriteLine(r);
End Sub UserProc;

After executing the example the console window displays the cumulative sum of interest equal to -42000.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.MathFin;
…
Public Shared Sub Main(Params: StartParams);
Var
    r: double;
    Finance: FinanceClass = New FinanceClass();
Begin
    r := Finance.CumIpmt(3.5, 24, 12000, 1, 1, 0);
    System.Diagnostics.Debug.WriteLine(r);
End Sub;