tmval.get_savings_pmt

tmval.annuity.get_savings_pmt(fv: float, period: float, term: float, gr: Union[float, tmval.rate.Rate], cents=False) → Union[float, tuple]

Returns the savings payments, made at regular installments specified by period, that grow to the desired future value. When cents is set to True, rounds the payments to the next cent, except for the last payment which is adjusted so that the desired future value is reached without over/under payment.

Parameters

• fv (float) – The desired future value.

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

• term (float) – The amount of time required to reach the desired future value, in years.

• gr (Rate) – A growth rate object.

• cents (bool) – Whether you want the payments rounded up to the next cent, except the final one.

Returns

A payment amount.

Return type

float, or tuple if cents is True