accounts

Loan payoff simulator: what-if projection for an alternative payment, recurring/one-off extras, or a target payoff month (solved to the required payment)

get/households/{householdId}/accounts/{accountId}/loan-simulation

Request

  • Base URL: https://api.vokse.ai
  • URL: https://api.vokse.ai/households/{householdId}/accounts/{accountId}/loan-simulation
  • Auth: HTTP bearer

Path parameters

accountIdstring required

Query parameters

targetPayoffYearMonthunknown

Solve the minimal payment that pays off by this YYYY-MM

oneTimeExtraCentsunknown

One-off extra principal this month, integer cents

extraMonthlyCentsunknown

Extra principal every month, integer cents

paymentCentsunknown

Alternative full monthly payment, integer cents

Changes

No recorded changes to this operation across all 1 revision of this API.