WorksheetFunction.CumPrinc Method

Definition

Returns the cumulative principal paid on a loan between start_period and end_period.

public:
 double CumPrinc(System::Object ^ Arg1, System::Object ^ Arg2, System::Object ^ Arg3, System::Object ^ Arg4, System::Object ^ Arg5, System::Object ^ Arg6);
public double CumPrinc (object Arg1, object Arg2, object Arg3, object Arg4, object Arg5, object Arg6);
Public Function CumPrinc (Arg1 As Object, Arg2 As Object, Arg3 As Object, Arg4 As Object, Arg5 As Object, Arg6 As Object) As Double

Parameters

Arg1
Object

The interest rate.

Arg2
Object

The total number of payment periods.

Arg3
Object

The present value.

Arg4
Object

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

Arg5
Object

The last period in the calculation.

Arg6
Object

The last period in the calculation.

Returns

Remarks

The following tables lists values used in Arg6.

0 (zero)Payment at the end of the period
1Payment at the beginning of the period

Make sure that you are consistent about the units you use for specifying rate and nper. If you make monthly payments on a four-year loan at an annual interest rate of 12 percent, use 12%/12 for rate and 4*12 for Arg2. If you make annual payments on the same loan, use 12% for rate and 4 for Arg2.

Arg2, Arg4, Arg5, and type are truncated to integers.

If rate ≤ 0, Arg2 ≤ 0, or Arg3 ≤ 0, CumPrinc generates an error.

If Arg4 < 1, Arg5 < 1, or Arg4 > Arg5, CumPrinc generates an error.

If Arg6 is any number other than 0 or 1, CumPrinc generates an error.

Applies to