tmval.Loan.sink_payments

Loan.sink_payments(payments: tmval.value.Payments) → dict[source]

Calculates a sinking fund schedule for a list of payments. Intended to be called externally only if the payments differ from the original sinking fund schedule. Otherwise, use the sinking() method. The return type is a dict which can be passed to a pandas DataFrame for further analysis and viewing.

Parameters

payments (Payments) – A list of payments.

Returns

The sinking fund schedule for the payments.

Return type

dict