changedInput schema / properties / break_fee_months / description
Previous value: -"Early-termination fee in months' rent"New value: +"Early-termination (break) fee stated in the lease, in months' rent, e.g. 2. Default 0 = no break clause"
changedInput schema / properties / currency / description
Previous value: -"Currency code in ISO 4217 format"New value: +"ISO 4217 currency code used only to label amounts, e.g. USD, GBP, EUR. Default USD"
changedInput schema / properties / deposit / description
Previous value: -"Initial deposit amount as a number"New value: +"Security deposit held by the landlord, non-negative amount, e.g. 2200. Default 0"
changedInput schema / properties / expected_relet_months / description
Previous value: -"Expected months to relett the property as a number"New value: +"Expected months until a replacement tenant moves in, e.g. 0.5 for about two weeks. Default 1"
changedInput schema / properties / landlord_mitigates / description
Previous value: -"True if landlord mitigates damages, false otherwise"New value: +"Whether the landlord must try to re-let and offset rent (duty to mitigate). Default true; false = liable for all remaining rent"
changedInput schema / properties / monthly_rent / description
Previous value: -"Monthly rent"New value: +"Current monthly rent as a positive number in the lease currency, e.g. 2200"
changedInput schema / properties / months_remaining / description
Previous value: -"Months left on the lease (including the current one)"New value: +"Months left on the lease including the current month, positive number, e.g. 7"
changedInput schema / properties / notice_months / description
Previous value: -"Number of months' notice required to terminate the lease"New value: +"Notice period required by the lease, in months, e.g. 2; cannot exceed months_remaining. Default 2 if no break fee, else 0"
changedInput schema / properties / reletting_fee / description
Previous value: -"Fee for reletting the property as a number"New value: +"Fixed re-letting/advertising/cleaning fee stated in the lease, non-negative amount, e.g. 300. Default 0"
addedOutput schema / properties / assumptions
Added value: +{
+ "description": "Assumptions applied in the estimate (fee, notice, mitigation, deposit)",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
removedOutput schema / properties / break_fee
Removed value: -{
- "description": "The early-termination fee.",
- "type": "number"
-}
addedOutput schema / properties / breakdown
Added value: +{
+ "description": "Itemised cost components of breaking the lease",
+ "properties": {
+ "break_fee": {
+ "description": "Break fee amount (monthly_rent x break_fee_months)",
+ "type": "number"
+ },
+ "deposit_credit": {
+ "description": "Deposit amount credited against the cost",
+ "type": "number"
+ },
+ "reletting_fee": {
+ "description": "Fixed re-letting fee from the lease",
+ "type": "number"
+ },
+ "rent_during_notice": {
+ "description": "Rent owed for the notice period (monthly_rent x notice_months)",
+ "type": "number"
+ },
+ "rent_until_relet_if_liable": {
+ "description": "Rent owed until a replacement tenant is found (or to lease end if the landlord does not mitigate)",
+ "type": "number"
+ }
+ },
+ "required": [
+ "rent_during_notice",
+ "break_fee",
+ "reletting_fee",
+ "rent_until_relet_if_liable",
+ "deposit_credit"
+ ],
+ "type": "object"
+}
removedOutput schema / properties / cost_breakdown
Removed value: -{
- "description": "A detailed breakdown of the costs.",
- "items": {
- "properties": {
- "amount": {
- "description": "The amount of the cost item.",
- "type": "number"
- },
- "description": {
- "description": "A description of the cost item.",
- "type": "string"
- }
- },
- "required": [
- "description",
- "amount"
- ],
- "type": "object"
- },
- "type": "array"
-}
changedOutput schema / properties / currency / description
Previous value: -"The currency in which the costs are calculated."New value: +"Currency code the amounts are labelled in"
removedOutput schema / properties / deposit_credit
Removed value: -{
- "description": "The amount of deposit that will be returned.",
- "type": "number"
-}
addedOutput schema / properties / disclaimer
Added value: +{
+ "description": "Informational, not-legal-advice disclaimer to show with the result",
+ "type": "string"
+}
addedOutput schema / properties / net_break_cost
Added value: +{
+ "description": "Estimated net cost to break the lease after deposit credit (cheaper of the break-clause and no-clause paths, floored at 0)",
+ "type": "number"
+}
addedOutput schema / properties / net_without_break_clause
Added value: +{
+ "description": "Net cost on the no-break-clause path (rent until relet + re-letting fee, less deposit)",
+ "type": "number"
+}
removedOutput schema / properties / notice_period_rent
Removed value: -{
- "description": "The cost of rent during the notice period.",
- "type": "number"
-}
removedOutput schema / properties / reletting_fee
Removed value: -{
- "description": "The fee charged by the landlord or agent for re-letting the property.",
- "type": "number"
-}
removedOutput schema / properties / rent_until_relet
Removed value: -{
- "description": "The estimated rent cost until the property is re-let.",
- "type": "number"
-}
addedOutput schema / properties / stay_cost
Added value: +{
+ "description": "Total rent if the lease is kept to term, for comparison",
+ "type": "number"
+}
removedOutput schema / properties / total_cost
Removed value: -{
- "description": "The total cost of breaking the lease.",
- "type": "number"
-}
changedOutput schema / required
Previous value: -[
- "total_cost",
- "notice_period_rent",
- "break_fee",
- "reletting_fee",
- "rent_until_relet",
- "deposit_credit",
- "currency",
- "cost_breakdown"
-]New value: +[
+ "currency",
+ "breakdown",
+ "net_break_cost",
+ "net_without_break_clause",
+ "stay_cost",
+ "assumptions",
+ "disclaimer"
+]