WorksheetFunction.Ipmt Method
Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.
Namespace: Microsoft.Office.Interop.Excel
Assembly: Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)
Syntax
'Declaration
Function Ipmt ( _
Arg1 As Double, _
Arg2 As Double, _
Arg3 As Double, _
Arg4 As Double, _
Arg5 As Object, _
Arg6 As Object _
) As Double
'Usage
Dim instance As WorksheetFunction
Dim Arg1 As Double
Dim Arg2 As Double
Dim Arg3 As Double
Dim Arg4 As Double
Dim Arg5 As Object
Dim Arg6 As Object
Dim returnValue As Double
returnValue = instance.Ipmt(Arg1, Arg2, _
Arg3, Arg4, Arg5, Arg6)
double Ipmt(
double Arg1,
double Arg2,
double Arg3,
double Arg4,
Object Arg5,
Object Arg6
)
Parameters
Arg1
Type: System.DoubleRate - the interest rate per period.
Arg2
Type: System.DoublePer - the period for which you want to find the interest and must be in the range 1 to nper.
Arg3
Type: System.DoubleNper - the total number of payment periods in an annuity.
Arg4
Type: System.DoublePv - the present value, or the lump-sum amount that a series of future payments is worth right now.
Arg5
Type: System.ObjectFv - 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).
Arg6
Type: System.ObjectType - the number 0 or 1 and indicates when payments are due. If type is omitted, it is assumed to be 0.
Return Value
Type: System.Double
Remarks
Set type equal to |
If payments are due |
|---|---|
0 |
At the end of the period |
1 |
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 12 percent annual interest, use 12%/12 for rate and 4*12 for nper. If you make annual payments on the same loan, use 12% for rate and 4 for nper.
For all the arguments, cash you pay out, such as deposits to savings, is represented by negative numbers; cash you receive, such as dividend checks, is represented by positive numbers.