WorksheetFunction.CumPrinc Method (Excel)
Returns the cumulative principal paid on a loan between start_period and end_period.
Syntax
expression .CumPrinc(Arg1, Arg2, Arg3, Arg4, Arg5, Arg6)
expression A variable that represents a WorksheetFunction object.
Parameters
Name |
Required/Optional |
Data Type |
Description |
|---|---|---|---|
Arg1 |
Required |
Variant |
The interest rate. |
Arg2 |
Required |
Variant |
The total number of payment periods. |
Arg3 |
Required |
Variant |
The present value. |
Arg4 |
Required |
Variant |
The first period in the calculation. Payment periods are numbered beginning with 1. |
Arg5 |
Required |
Variant |
The last period in the calculation. |
Arg6 |
Required |
Variant |
The timing of the payment. |
Return Value
Double
Remarks
The following tables lists values used in Arg6.
Type |
Timing |
|---|---|
0 (zero) |
Payment at the end of the period |
1 |
Payment 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.