WorksheetFunction.Pmt Method

Calculates the payment for a loan based on 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 Pmt ( _
    Arg1 As Double, _
    Arg2 As Double, _
    Arg3 As Double, _
    Arg4 As Object, _
    Arg5 As Object _
) As Double
'Usage
Dim instance As WorksheetFunction
Dim Arg1 As Double
Dim Arg2 As Double
Dim Arg3 As Double
Dim Arg4 As Object
Dim Arg5 As Object
Dim returnValue As Double

returnValue = instance.Pmt(Arg1, Arg2, _
    Arg3, Arg4, Arg5)
double Pmt(
    double Arg1,
    double Arg2,
    double Arg3,
    Object Arg4,
    Object Arg5
)

Parameters

  • Arg1
    Type: System.Double

    Rate - the interest rate for the loan.

  • Arg2
    Type: System.Double

    Nper - the total number of payments for the loan.

  • Arg3
    Type: System.Double

    Pv - the present value, or the total amount that a series of future payments is worth now; also known as the principal.

  • Arg4
    Type: System.Object

    Fv - 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 (zero), that is, the future value of a loan is 0.

  • Arg5
    Type: System.Object

    Type - the number 0 (zero) or 1 and indicates when payments are due.

Return Value

Type: System.Double

Remarks

For a more complete description of the arguments in Pmt, see the Pv(Double, Double, Double, Object, Object) function.

Set type equal to

If payments are due

0 or omitted

At the end of the period

1

At the beginning of the period

The payment returned by Pmt includes principal and interest but no taxes, reserve payments, or fees sometimes associated with loans.

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 nper. If you make annual payments on the same loan, use 12 percent for rate and 4 for nper.

See Also

Reference

WorksheetFunction Interface

WorksheetFunction Members

Microsoft.Office.Interop.Excel Namespace