Raw schema
{
"type": "object",
"properties": {
"startingBalance": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$",
"description": "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."
},
"mortgage": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"annualRatePercent": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Annual interest rate as a percent number in a string, without the % sign: 4.89% is \"4.89\", never \"0.0489\". Wrapped as a fact."
},
"convention": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Compounding convention of the quoted rate: nominal_semiannual or nominal_monthly. The mortgage documents state it. Mark unknown if the user has not said; do not guess."
},
"termMonths": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Term length in months, never years: a 5-year term is 60."
},
"amortizationMonths": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Remaining amortization in months, never years: 25 years is 300. Never inferred from the payment."
},
"frequency": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"monthly",
"semi_monthly",
"biweekly",
"weekly",
"accelerated_biweekly",
"accelerated_weekly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"monthly",
"semi_monthly",
"biweekly",
"weekly",
"accelerated_biweekly",
"accelerated_weekly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Payment frequency. biweekly is 26 payments a year sized to the stated amortization. accelerated_biweekly is the monthly payment divided by 2, paid 26 times a year, so more is paid each year. weekly and accelerated_weekly are the same idea with 52 payments and division by 4. \"Every two weeks\" alone does not say which: mark unknown or ask."
},
"paymentMode": {
"type": "string",
"enum": [
"recalculate_payment",
"fixed_payment"
],
"description": "How the payment is set. recalculate_payment: the payment is calculated from the rate and amortization; use it for an ordinary mortgage, including a fixed-rate mortgage. fixed_payment: hold the dollar payment given in fixedPayment; it does not mean a fixed interest rate."
},
"fixedPayment": {
"description": "Dollar payment per payment period in CAD. Needed only when paymentMode is fixed_payment.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"costs": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"funding": {
"type": "string",
"enum": [
"cash",
"financed",
"lender_paid"
],
"description": "cash: paid out of pocket. financed: added to the mortgage balance, at the start only (atPeriod 0). lender_paid: paid by the lender and not counted."
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
}
},
"required": [
"label",
"amount",
"funding",
"atPeriod"
],
"additionalProperties": false
},
"description": "Fees for this offer (legal, discharge, appraisal). A cost the user cannot confirm must be listed with amount {state:\"unknown\"}; leaving it out means there is no such cost."
},
"credits": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
},
"destination": {
"type": "string",
"enum": [
"cash",
"principal"
],
"description": "cash: paid to the borrower. principal: applied to reduce the balance."
},
"clawback": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000
}
},
"required": [
"amount",
"atPeriod"
],
"additionalProperties": false
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000
}
},
"required": [
"amount",
"atPeriod"
],
"additionalProperties": false
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Cashback repayment condition from the lender's agreement. amount: how much of the cashback must be repaid if the mortgage ends early. atPeriod: the payment number that condition refers to (with monthly payments, the month). A known clawback is reported as a warning and is not counted as a cost: the figures assume the mortgage is kept. {state:\"unknown\"} adds a warning to ask the lender and changes no figure. No clawback: {state:\"known\",value:{amount:\"0\",atPeriod:0},origin:\"user\"}."
}
},
"required": [
"label",
"amount",
"atPeriod",
"destination",
"clawback"
],
"additionalProperties": false
},
"description": "Cashback or other credits, with any clawback."
},
"ratePath": {
"description": "Rate changes during the term. Each entry: after payment number atPeriod, the annual rate becomes annualRatePercent (a percent number in a string, for example \"5.25\").",
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
},
"annualRatePercent": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$",
"description": "Annual interest rate as a percent number in a string, without the % sign: 19.99% is \"19.99\", never \"0.1999\"."
}
},
"required": [
"atPeriod",
"annualRatePercent"
],
"additionalProperties": false
}
},
"continuationSegments": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"durationMonths": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"annualRatePercent": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Annual interest rate as a percent number in a string, without the % sign: 19.99% is \"19.99\", never \"0.1999\"."
},
"convention": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"amortizationMonthsAtStart": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"paymentMode": {
"type": "string",
"enum": [
"recalculate_payment",
"fixed_payment"
],
"description": "How the payment is set. recalculate_payment: the payment is calculated from the rate and amortization; use it for an ordinary mortgage, including a fixed-rate mortgage. fixed_payment: hold the dollar payment given in fixedPayment; it does not mean a fixed interest rate."
},
"fixedPayment": {
"description": "Dollar payment per payment period in CAD. Needed only when paymentMode is fixed_payment.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"assumptionAcknowledged": {
"type": "boolean",
"const": true
}
},
"required": [
"durationMonths",
"annualRatePercent",
"convention",
"amortizationMonthsAtStart",
"paymentMode",
"assumptionAcknowledged"
],
"additionalProperties": false
}
}
},
"required": [
"label",
"annualRatePercent",
"convention",
"termMonths",
"amortizationMonths",
"frequency",
"paymentMode",
"costs",
"credits"
],
"additionalProperties": false
},
"debts": {
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"balance": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$",
"description": "Balance owing on this debt now, in CAD, digits only, for example \"8500\"."
},
"annualRatePercent": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Annual interest rate as a percent number in a string, without the % sign: 19.99% is \"19.99\", never \"0.1999\"."
},
"monthlyPayment": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Set monthly payment of a fixed_monthly debt, in CAD. For an interest_only debt use {state:\"unknown\"}: the payment modeled is each month's interest."
},
"type": {
"type": "string",
"enum": [
"fixed_monthly",
"interest_only"
],
"description": "fixed_monthly for a debt with a set monthly payment; interest_only for a balance such as a line of credit that pays interest only."
},
"convention": {
"type": "string",
"const": "nominal_monthly"
}
},
"required": [
"label",
"balance",
"annualRatePercent",
"monthlyPayment",
"type",
"convention"
],
"additionalProperties": false
}
},
"replacementOffer": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"annualRatePercent": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Annual interest rate as a percent number in a string, without the % sign: 4.89% is \"4.89\", never \"0.0489\". Wrapped as a fact."
},
"convention": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Compounding convention of the quoted rate: nominal_semiannual or nominal_monthly. The mortgage documents state it. Mark unknown if the user has not said; do not guess."
},
"termMonths": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Term length in months, never years: a 5-year term is 60."
},
"amortizationMonths": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Remaining amortization in months, never years: 25 years is 300. Never inferred from the payment."
},
"frequency": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"monthly",
"semi_monthly",
"biweekly",
"weekly",
"accelerated_biweekly",
"accelerated_weekly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"monthly",
"semi_monthly",
"biweekly",
"weekly",
"accelerated_biweekly",
"accelerated_weekly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Payment frequency. biweekly is 26 payments a year sized to the stated amortization. accelerated_biweekly is the monthly payment divided by 2, paid 26 times a year, so more is paid each year. weekly and accelerated_weekly are the same idea with 52 payments and division by 4. \"Every two weeks\" alone does not say which: mark unknown or ask."
},
"paymentMode": {
"type": "string",
"enum": [
"recalculate_payment",
"fixed_payment"
],
"description": "How the payment is set. recalculate_payment: the payment is calculated from the rate and amortization; use it for an ordinary mortgage, including a fixed-rate mortgage. fixed_payment: hold the dollar payment given in fixedPayment; it does not mean a fixed interest rate."
},
"fixedPayment": {
"description": "Dollar payment per payment period in CAD. Needed only when paymentMode is fixed_payment.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"costs": {
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"funding": {
"type": "string",
"enum": [
"cash",
"financed",
"lender_paid"
],
"description": "cash: paid out of pocket. financed: added to the mortgage balance, at the start only (atPeriod 0). lender_paid: paid by the lender and not counted."
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
}
},
"required": [
"label",
"amount",
"funding",
"atPeriod"
],
"additionalProperties": false
},
"description": "Fees for this offer (legal, discharge, appraisal). A cost the user cannot confirm must be listed with amount {state:\"unknown\"}; leaving it out means there is no such cost."
},
"credits": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"amount": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
},
"destination": {
"type": "string",
"enum": [
"cash",
"principal"
],
"description": "cash: paid to the borrower. principal: applied to reduce the balance."
},
"clawback": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000
}
},
"required": [
"amount",
"atPeriod"
],
"additionalProperties": false
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "object",
"properties": {
"amount": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000
}
},
"required": [
"amount",
"atPeriod"
],
"additionalProperties": false
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Cashback repayment condition from the lender's agreement. amount: how much of the cashback must be repaid if the mortgage ends early. atPeriod: the payment number that condition refers to (with monthly payments, the month). A known clawback is reported as a warning and is not counted as a cost: the figures assume the mortgage is kept. {state:\"unknown\"} adds a warning to ask the lender and changes no figure. No clawback: {state:\"known\",value:{amount:\"0\",atPeriod:0},origin:\"user\"}."
}
},
"required": [
"label",
"amount",
"atPeriod",
"destination",
"clawback"
],
"additionalProperties": false
},
"description": "Cashback or other credits, with any clawback."
},
"ratePath": {
"description": "Rate changes during the term. Each entry: after payment number atPeriod, the annual rate becomes annualRatePercent (a percent number in a string, for example \"5.25\").",
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"atPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000,
"description": "Payment number, not a month: 0 is the start. With biweekly payments, payment 26 is about month 12."
},
"annualRatePercent": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$",
"description": "Annual interest rate as a percent number in a string, without the % sign: 19.99% is \"19.99\", never \"0.1999\"."
}
},
"required": [
"atPeriod",
"annualRatePercent"
],
"additionalProperties": false
}
},
"continuationSegments": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"durationMonths": {
"type": "integer",
"minimum": 1,
"maximum": 120
},
"annualRatePercent": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Annual interest rate as a percent number in a string, without the % sign: 19.99% is \"19.99\", never \"0.1999\"."
},
"convention": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"nominal_semiannual",
"nominal_monthly"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"amortizationMonthsAtStart": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "integer",
"minimum": 1,
"maximum": 600
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "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."
},
"paymentMode": {
"type": "string",
"enum": [
"recalculate_payment",
"fixed_payment"
],
"description": "How the payment is set. recalculate_payment: the payment is calculated from the rate and amortization; use it for an ordinary mortgage, including a fixed-rate mortgage. fixed_payment: hold the dollar payment given in fixedPayment; it does not mean a fixed interest rate."
},
"fixedPayment": {
"description": "Dollar payment per payment period in CAD. Needed only when paymentMode is fixed_payment.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"assumptionAcknowledged": {
"type": "boolean",
"const": true
}
},
"required": [
"durationMonths",
"annualRatePercent",
"convention",
"amortizationMonthsAtStart",
"paymentMode",
"assumptionAcknowledged"
],
"additionalProperties": false
}
}
},
"required": [
"label",
"annualRatePercent",
"convention",
"termMonths",
"amortizationMonths",
"frequency",
"paymentMode",
"costs",
"credits"
],
"additionalProperties": false
},
"penalty": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "The penalty amount the lender quoted, in CAD. Never estimate it; use {state:\"unknown\"} if there is no quote."
},
"penaltyFunding": {
"type": "string",
"enum": [
"cash",
"financed"
],
"description": "cash if paid out of pocket; financed if added to the new mortgage."
},
"horizonMonths": {
"description": "Comparison horizon in months. Defaults to the shortest supplied term, at most 120.",
"type": "integer",
"minimum": 1,
"maximum": 120
},
"monthlyBudget": {
"description": "Total monthly amount the user wants to keep paying after consolidating. Defaults to the current mortgage payment plus the debt payments due in month one.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"propertyValue": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"contractCaps": {
"type": "object",
"properties": {
"perEventCap": {
"description": "Per-payment prepayment limit in CAD. Omitted means the contract has no per-payment limit; {state:\"unknown\"} means a limit may exist, so limits are not checked.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"annualCap": {
"description": "Annual prepayment limit in CAD. Omitted means the contract has no dollar annual limit; {state:\"unknown\"} means a limit may exist, so limits are not checked. With a percentage basis, a supplied amount is also checked and the stricter applies; an absolute basis requires this amount.",
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,7})(\\.\\d{1,2})?$"
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
]
},
"basis": {
"oneOf": [
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "known"
},
"value": {
"type": "string",
"enum": [
"absolute",
"original_principal",
"current_balance"
]
},
"origin": {
"type": "string",
"enum": [
"user",
"approved_reference"
]
}
},
"required": [
"state",
"value",
"origin"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "assumed"
},
"value": {
"type": "string",
"enum": [
"absolute",
"original_principal",
"current_balance"
]
},
"acknowledged": {
"type": "boolean",
"const": true
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 240
}
},
"required": [
"state",
"value",
"acknowledged",
"reason"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"state": {
"type": "string",
"const": "unknown"
}
},
"required": [
"state"
],
"additionalProperties": false
}
],
"description": "Basis of the annual limit: absolute uses annualCap; original_principal and current_balance use percentage."
},
"resetMonth": {
"description": "Month whose first day starts each prepayment year.",
"type": "integer",
"minimum": 1,
"maximum": 12
},
"percentage": {
"description": "Annual prepayment limit as a percent number in a string: 15% is \"15\". Used with basis original_principal or current_balance.",
"type": "string",
"pattern": "^(0|[1-9]\\d?)(\\.\\d{1,8})?$|^100(\\.0{1,8})?$"
},
"startDate": {
"description": "Date of period 0; due dates follow the illustrative calendar.",
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"basis"
],
"additionalProperties": false
},
"scheduleWindow": {
"type": "object",
"properties": {
"startPeriod": {
"type": "integer",
"minimum": 0,
"maximum": 3000
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 600
}
},
"required": [
"startPeriod",
"count"
],
"additionalProperties": false
}
},
"required": [
"startingBalance",
"mortgage",
"debts",
"replacementOffer",
"penalty",
"penaltyFunding"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}