XFA Specification
Chapter 23, FormCalc Specification
Financial Built-in Functions
859
IPmt()
This function returns the amount of interest paid on a loan over a period of time.
Syntax
IPmt(n1, n2, n3, n4, n5)
Parameters
n1
is the principal amount of the loan.
n2
is the annual interest rate.
n3
is the monthly payment.
n4
is the first month of the computation.
n5
is the number of months to be computed.
Returns
The interest amount or null if any of its parameters are null.
If any of n1, n2, or n3 are non-positive, the function generates an error exception.
If n4 or n5 are negative, the function generates an error exception.
If the payment is less than the monthly interest load, the function returns 0.
Examples
IPmt(30000, .085, 295.50, 7, 3)
returns 624.88
*
which is the amount of interest paid starting in July (month 7) for 3 months on a loan of
$30,000.00 at an annual interest rate of 8.5% being repaid at a rate of $295.50 per month.