tmval.get_loan_amt

tmval.annuity.get_loan_amt(down_pmt: float, loan_pmt: float, period: float, term: float, gr: tmval.rate.Rate) → float[source]

Returns a loan amount, given a set of characteristics that defines an annuity.

Parameters
  • down_pmt (float) – A down payment amount, reduces the loan amount.

  • loan_pmt (float) – The periodic loan payment amount.

  • period (float) – The payment period, as a fraction of a year.

  • term (float) – The term of the loan, in years.

  • gr (Rate) – A growth rate object

Returns

A loan amount whose present value is equal to the annuity generated from the other arguments.

Return type

float