# IPmt

| **Name**    | ***IPmt***                                                                                                                 |
| ----------- | -------------------------------------------------------------------------------------------------------------------------- |
| Syntax      | IPmt (Real Rate, Real Periods, Real numPeriods, Real PV)                                                                   |
| Purpose     | To return a value by applying the interest payment function on specified values.                                           |
| Description | Returns the interest payment for a given period of an annuity based on periodic, fixed payments and a fixed interest rate. |
| Return Type | Double                                                                                                                     |
| Parameters  | <p>Rate \[System.Double]</p><p>periods \[System.Double]</p><p>numPeriods \[System.Double]</p><p>PV \[System.Double]</p>    |

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/0%20\(36\).png)

### **Example**

In this example, we will be passing the required parameters to the function transformation object using a *Variables* object.

Where,

*rate* = 3

*periods* = 5

*numPeriods* = 100

*PV* = 5000000

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/1%20\(37\).png)

Right-click on the function transformation object and select *Preview Output.* You can see that Astera Data Stack has applied the IPmt function, and returned the interest amount of an annuity, dependent on a specified period and period amount.

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/2%20\(37\).png)