'Declaration Public Class UltraCalcFunctionIPmt Inherits BuiltInFunctionBase
public class UltraCalcFunctionIPmt : BuiltInFunctionBase
IPMT(interestRate, periodNumber, nPeriods, presentValue, futureValue, paymentDue)
InterestRate is a fixed rate of interest per period. This function assumes there is one payment made on each period, therefore in cases where you want to calculate quarterly or monthly payments you should adjust an annual interestRate accordingly by dividing it by the number of payments per year.
PeriodNumber identifies the period of the current payment, where the first payment has the number 1. The periodNumber must not exceed the total number of periods (nPeriods).
NPeriods is the total number of payments over the course of this investment or loan.
PresentValue is the discounted value of this series of future payments, if you could take a lump sum payment today and invest it at the fixed interestRate until the future date when this investment or loan had been repaid.
FutureValue is the expected value of this series of payments after the last payment has been made, where all previous payments have been accumulating interest at the fixed interestRate. When omitted, such as when this function is used for calculating loan payments that reduce an outstanding liability, the future value is assumed to be zero.
PaymentDue is a numeric value indicating that payments are due at the beginning of each period (1) or at the end of each period (0).
The IPMT() function calculates the portion of a fixed payment attributed to interest. If you need to calculate the portion of a fixed payment repaying loan principal then use the PPMT() function. To calculate fixed payment amounts, use the PMT() function.
Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2