parameters: (rate, per, nper, pv, fv=0, when='end')
return_statement: return total - ipmt(rate, per, nper, pv, fv, when)
docstring: Compute the payment against loan principal.
  
      .. deprecated:: 1.18
  
         `ppmt` is deprecated; for details, see NEP 32 [1]_.
         Use the corresponding function in the numpy-financial library,
         https://pypi.org/project/numpy-financial.
  
      Parameters
      ----------
      rate : array_like
          Rate of interest (per period)
      per : array_like, int
          Amount paid against the loan changes.  The `per` is the period of
          interest.
      nper : array_like
          Number of compounding periods
      pv : array_like
          Present value
      fv : array_like, optional
          Future value
      when : {{'begin', 1}, {'end', 0}}, {string, int}
          When payments are due ('begin' (1) or 'end' (0))
  
      See Also
      --------
      pmt, pv, ipmt
  
      References
      ----------
      .. [1] NumPy Enhancement Proposal (NEP) 32,
         https://numpy.org/neps/nep-0032-remove-financial-functions.html
docstring_summary: Compute the payment against loan principal.
docstring_tokens: Compute the payment against loan principal .
function: def ppmt(rate, per, nper, pv, fv=0, when='end'):
      """
      Compute the payment against loan principal.
  
      .. deprecated:: 1.18
  
         `ppmt` is deprecated; for details, see NEP 32 [1]_.
         Use the corresponding function in the numpy-financial library,
         https://pypi.org/project/numpy-financial.
  
      Parameters
      ----------
      rate : array_like
          Rate of interest (per period)
      per : array_like, int
          Amount paid against the loan changes.  The `per` is the period of
          interest.
      nper : array_like
          Number of compounding periods
      pv : array_like
          Present value
      fv : array_like, optional
          Future value
      when : {{'begin', 1}, {'end', 0}}, {string, int}
          When payments are due ('begin' (1) or 'end' (0))
  
      See Also
      --------
      pmt, pv, ipmt
  
      References
      ----------
      .. [1] NumPy Enhancement Proposal (NEP) 32,
         https://numpy.org/neps/nep-0032-remove-financial-functions.html
  
      """
      total = pmt(rate, nper, pv, fv, when)
      return total - ipmt(rate, per, nper, pv, fv, when)
function_tokens: def ppmt ( rate , per , nper , pv , fv = 0 , when = 'end' ) : total = pmt ( rate , nper , pv , fv , when ) return total - ipmt ( rate , per , nper , pv , fv , when )