Compare Canadian mortgage renewal offers
compare_renewal_offersRead-only
Use this when a user has two or three Canadian mortgage offers for the same balance, such as a renewal letter from the current lender and a quote to switch lender at renewal, and wants them compared. Compares the user-supplied rates, terms, amortizations, cashback and switching costs over a common horizon. Returns payments, interest, debt left, modeled borrowing cost and missing facts. Do not use for leaving a mortgage before the term ends (use compare_break_or_stay). Does not search or predict rates, confirm qualification or recommend a lender. An unknown cost is never treated as zero.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offers | Yes | ||
| horizonMonths | No | Comparison horizon in months. Defaults to the shortest supplied term, at most 120. | |
| currentPayment | No | A fact is {state:"known",value,origin:"user"} when the user stated it; {state:"assumed",value,acknowledged:true,reason} only after the user has agreed to the assumption; {state:"unknown"} otherwise. Unknown is never treated as zero. | |
| scheduleWindow | No | ||
| startingBalance | Yes | Mortgage balance now, in CAD, as digits only: no $ sign, no commas, no spaces, for example "412000" or "412000.50". Before any costs are added. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| links | Yes | ||
| scope | Yes | ||
| payoff | No | ||
| status | Yes | ||
| horizon | No | ||
| reasons | Yes | ||
| sources | Yes | ||
| currency | Yes | ||
| schedule | No | ||
| breakEven | No | ||
| scenarios | Yes | ||
| assumptions | Yes | ||
| differences | No | ||
| sensitivity | No | ||
| dateMappings | No | ||
| missingInputs | Yes | ||
| nextQuestions | Yes | ||
| schemaVersion | Yes | ||
| evaluatedThrough | No | ||
| requestedHorizon | No | ||
| illustrativeRatio | No | ||
| calculationVersion | Yes |