@pdtf/schemas 3.6.0-9 → 3.6.0-dev.1

package/src/schemas/v3/skeleton.json

@@ -1,7 +1,9 @@
 {
   "transactionId": "string",
   "externalIds": {
-    "*": {}
+    "*": {
+      "*": {}
+    }
   },
   "status": "string",
   "participants": [
@@ -33,7 +35,9 @@
       "organisationReference": "string",
       "role": "variant",
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "participantStatus": "string",
       "verification": {
@@ -75,8 +79,12 @@
       "sellersCapacity": {
         "capacity": "variant",
         "sellersCapacityDetails": "string",
-        "attachments": "string"
-      }
+        "attachments": "string",
+        "companyName": "string",
+        "companyNumber": "string",
+        "countryOfIncorporation": "string"
+      },
+      "dateBecameOwnerOrAuthority": "string"
     }
   ],
   "propertyPack": {
@@ -266,6 +274,8 @@
     "ownership": {
       "numberOfSellers": "integer",
       "numberOfNonUkResidentSellers": "integer",
+      "outstandingMortgage": "string",
+      "existingLender": "string",
       "hasHelpToBuyEquityLoan": "string",
       "isFirstRegistration": "string",
       "isLimitedCompanySale": "string",
@@ -279,6 +289,10 @@
             "details": "string",
             "amount": "number"
           },
+          "titleRestrictions": {
+            "yesNo": "variant",
+            "details": "string"
+          },
           "wholeFreeholdForSale": {
             "yesNo": "variant",
             "details": "string"
@@ -388,7 +402,20 @@
                 "other": {
                   "isApplicableParty": "variant",
                   "feeIncludingVAT": "number",
-                  "noticeViaEmail": "string"
+                  "noticeViaEmail": "string",
+                  "contact": {
+                    "nameOrOrganisation": "string",
+                    "address": {
+                      "line1": "string",
+                      "line2": "string",
+                      "line3": "string",
+                      "town": "string",
+                      "postcode": "string"
+                    },
+                    "telephone": "string",
+                    "emailAddress": "string"
+                  },
+                  "capacity": "string"
                 },
                 "otherDetailsRequired": {
                   "areOtherDetailsRequired": "variant",
@@ -550,13 +577,14 @@
               "feesForAdminServices": "string"
             },
             "confirmation": {
-              "response": {},
+              "response": "boolean",
               "capacity": "string"
             }
           },
           "leaseholdInformation": {
             "typeOfLeasehold": {
-              "leaseholdType": "string"
+              "leaseholdType": "variant",
+              "otherLeaseholdType": "string"
             },
             "sharedOwnership": {
               "isSharedOwnership": "variant",
@@ -633,6 +661,48 @@
                     "feeType": "string"
                   }
                 },
+                "rightToManageCompany": {
+                  "contact": {
+                    "nameOrOrganisation": "string",
+                    "address": {
+                      "line1": "string",
+                      "line2": "string",
+                      "line3": "string",
+                      "town": "string",
+                      "postcode": "string"
+                    },
+                    "emailAddress": "string",
+                    "telephone": "string"
+                  }
+                },
+                "freeholder": {
+                  "contact": {
+                    "nameOrOrganisation": "string",
+                    "address": {
+                      "line1": "string",
+                      "line2": "string",
+                      "line3": "string",
+                      "town": "string",
+                      "postcode": "string"
+                    },
+                    "emailAddress": "string",
+                    "telephone": "string"
+                  }
+                },
+                "headLeaseHolder": {
+                  "contact": {
+                    "nameOrOrganisation": "string",
+                    "address": {
+                      "line1": "string",
+                      "line2": "string",
+                      "line3": "string",
+                      "town": "string",
+                      "postcode": "string"
+                    },
+                    "emailAddress": "string",
+                    "telephone": "string"
+                  }
+                },
                 "managingAgent": {
                   "contact": {
                     "nameOrOrganisation": "string",
@@ -712,7 +782,20 @@
                   "other": {
                     "isApplicableParty": "variant",
                     "feeIncludingVAT": "number",
-                    "noticeViaEmail": "string"
+                    "noticeViaEmail": "string",
+                    "contact": {
+                      "nameOrOrganisation": "string",
+                      "address": {
+                        "line1": "string",
+                        "line2": "string",
+                        "line3": "string",
+                        "town": "string",
+                        "postcode": "string"
+                      },
+                      "telephone": "string",
+                      "emailAddress": "string"
+                    },
+                    "capacity": "string"
                   }
                 },
                 "noticeOfTransferAndCharge": {
@@ -739,16 +822,35 @@
                   "other": {
                     "isApplicableParty": "variant",
                     "feeIncludingVAT": "number",
-                    "noticeViaEmail": "string"
+                    "noticeViaEmail": "string",
+                    "contact": {
+                      "nameOrOrganisation": "string",
+                      "address": {
+                        "line1": "string",
+                        "line2": "string",
+                        "line3": "string",
+                        "town": "string",
+                        "postcode": "string"
+                      },
+                      "telephone": "string",
+                      "emailAddress": "string"
+                    },
+                    "capacity": "string"
                   },
                   "otherDetailsRequired": {
                     "areOtherDetailsRequired": "variant",
                     "details": "string"
                   }
                 },
-                "collectsGroundRent": "string",
+                "collectsGroundRent": {
+                  "collector": "variant",
+                  "otherCollector": "string"
+                },
                 "collectsServiceCharges": "string",
-                "collectsbuildingInsurancePremiums": "string",
+                "collectsbuildingInsurancePremiums": {
+                  "collector": "variant",
+                  "otherCollector": "string"
+                },
                 "dealsWithDayToDayMaintenanceOfManagedArea": "string",
                 "organisesBuildingInsurance": "string",
                 "dealsWithDayToDayMaintenanceOfBuilding": {
@@ -773,6 +875,11 @@
                 "isSellerAwareOfChanges": "variant",
                 "details": "string",
                 "attachments": "string"
+              },
+              "landlordConsents": {
+                "isSellerAwareOfLandlordConsents": "variant",
+                "details": "string",
+                "attachments": "string"
               }
             },
             "transferAndRegistration": {
@@ -799,6 +906,7 @@
               "isGroundRentPayable": "variant",
               "annualGroundRent": "number",
               "groundRentFrequency": "string",
+              "mostRecentGroundRentDemandStatus": "string",
               "rentSubjectToIncrease": {
                 "yesNo": "variant",
                 "rentReviewFrequency": "string",
@@ -823,12 +931,18 @@
                 "buildingManagerType": "variant",
                 "details": "string"
               },
-              "hasTenantCompanyDissolved": "string",
-              "isManagingAgentEmployed": "string"
+              "isManagingAgentEmployed": "string",
+              "sellerOwnership": {
+                "yesNo": "variant",
+                "attachments": "string"
+              },
+              "hasTenantCompanyDissolved": "variant",
+              "hasTenantCompanyDissolvedDetails": "string"
             },
             "serviceCharge": {
               "sellerContributesToServiceCharge": "variant",
               "annualServiceCharge": "number",
+              "mostRecentServiceChargeDemandStatus": "string",
               "largeAdditionalExpense": {
                 "yesNo": "variant",
                 "details": "string"
@@ -926,6 +1040,7 @@
                 "yesNo": "variant",
                 "details": "string"
               },
+              "mostRecentBuildingsInsuranceDemandStatus": "string",
               "lastDemandPeriod": {
                 "from": "string",
                 "to": "string"
@@ -946,7 +1061,10 @@
                 "yesNo": "variant",
                 "riskAssessments": {
                   "assessmentsCarriedOut": "variant",
-                  "urgentWorksRecommended": "string"
+                  "urgentWorksRecommended": "variant",
+                  "urgentWorksCarriedOut": "string",
+                  "outstandingEnforcementAction": "variant",
+                  "dateRemedialActionRequired": "string"
                 }
               },
               "standardTermsAvailable": {
@@ -1086,6 +1204,10 @@
               "managementCompanyAGMMinutes": "string",
               "enforcementNotices": "string"
             },
+            "additionalInformation": {
+              "details": "string",
+              "attachments": "string"
+            },
             "confirmationOfAccuracy": {
               "confirmation": "boolean",
               "capacity": "string"
@@ -1104,15 +1226,25 @@
       },
       "controlledParking": {
         "yesNo": "variant",
-        "annualCostOfPermit": "number"
+        "costOfPermit": "number",
+        "costOfPermitFrequency": "string"
       },
       "vehicleTypeRestriction": {
         "yesNo": "variant",
         "details": "string"
       },
-      "electricVehicleChargingPoint": {
+      "droppedKerbAccess": {
         "yesNo": "string"
       },
+      "electricVehicleChargingPoint": {
+        "yesNo": "variant",
+        "chargerDetails": "string",
+        "chargerDetailsAttachments": "string",
+        "cableCrossesPavement": {
+          "yesNo": "variant",
+          "details": "string"
+        }
+      },
       "locatedInUlez": {
         "yesNo": "string"
       }
@@ -1132,6 +1264,7 @@
         "yesNo": "variant",
         "workCarriedOut": {
           "yesNo": "variant",
+          "details": "string",
           "consentsObtained": "string",
           "attachments": "string"
         }
@@ -1352,6 +1485,11 @@
           "details": "string"
         }
       },
+      "nonResidentialPurposes": {
+        "yesNo": "variant",
+        "details": "string",
+        "attachments": "string"
+      },
       "windowReplacementsSince2002": {
         "yesNo": "variant",
         "details": "string",
@@ -1375,6 +1513,30 @@
           "yesNo": "variant",
           "attachments": "string",
           "details": "string"
+        },
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string"
+      },
+      "extension": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
         }
       },
       "hasAddedConservatory": {
@@ -1400,6 +1562,125 @@
           "yesNo": "variant",
           "attachments": "string",
           "details": "string"
+        },
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string"
+      },
+      "loftConversion": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        }
+      },
+      "garageConversion": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        }
+      },
+      "removalOfInternalWalls": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        }
+      },
+      "removalOfChimneyBreast": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        }
+      },
+      "insulation": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        }
+      },
+      "otherBuildingWorksOrChangesToTheProperty": {
+        "yesNo": "variant",
+        "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "planningPermission": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "buildingRegApproval": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
         }
       },
       "worksUnfinished": {
@@ -1469,8 +1750,12 @@
         "attachments": "string"
       },
       "japaneseKnotweed": {
+        "knotweedSurveyCarriedOut": {
+          "yesNo": "variant",
+          "attachments": "string"
+        },
         "yesNo": "variant",
-        "managementPlanInPlace": "string",
+        "managementPlanInPlace": "variant",
         "attachments": "string"
       },
       "subsidenceOrStructuralFault": {
@@ -1482,6 +1767,22 @@
         "yesNo": "variant",
         "details": "string",
         "attachments": "string"
+      },
+      "wellsDitchesShaft": {
+        "yesNo": "variant",
+        "details": "string"
+      },
+      "damagedOrExposedElectrics": {
+        "yesNo": "variant",
+        "details": "string"
+      },
+      "damageToFlooringOrStaircases": {
+        "yesNo": "variant",
+        "details": "string"
+      },
+      "knownAreasInPoorCondition": {
+        "yesNo": "variant",
+        "details": "string"
       }
     },
     "fixturesAndFittings": {
@@ -2080,18 +2381,23 @@
         "electricityMeter": {
           "location": "string",
           "attachments": "string",
-          "mpan": "integer"
+          "mpan": "string"
         },
         "dateToBeConnected": "string"
       },
       "solarPanels": {
         "yesNo": "variant",
         "supplier": "string",
+        "hotWaterOnly": "string",
         "yearInstalled": "integer",
         "panelsOwnedOutright": {
           "yesNo": "variant",
           "details": "string",
-          "attachments": "string"
+          "attachments": "string",
+          "associatedCost": {
+            "frequency": "variant",
+            "amount": "number"
+          }
         },
         "panelProviderLease": {
           "yesNo": "variant",
@@ -2103,13 +2409,28 @@
           "yesNo": "variant",
           "details": "string"
         },
-        "isConnectedToNationalGrid": "string",
         "photovoltaicMeterPanelLocation": {
           "attachments": "string"
         },
-        "photovoltaicBatteriesLocation": {
+        "maintenanceAgreement": {
+          "yesNo": "variant",
           "attachments": "string"
         },
+        "photovoltaicBatteries": {
+          "yesNo": "variant",
+          "attachments": "string",
+          "details": "string"
+        },
+        "nationalGrid": {
+          "yesNo": "variant",
+          "fitOrSegInPlace": {
+            "yesNo": "variant",
+            "fitSegAgreementCopy": "string",
+            "attachments": "string",
+            "fitSegAssignmentProcedure": "string"
+          }
+        },
+        "installationCertificates": "string",
         "dateToBeConnected": "string"
       },
       "heatPump": {
@@ -2118,6 +2439,8 @@
         "supplier": "string",
         "dateInstalled": "string",
         "attachments": "string",
+        "makeModel": "string",
+        "serviceProviderName": "string",
         "dateToBeConnected": "string"
       },
       "otherSources": {
@@ -2136,6 +2459,10 @@
         "mainsWater": {
           "yesNo": "variant",
           "details": "string",
+          "associatedCost": {
+            "frequency": "variant",
+            "amount": "number"
+          },
           "supplier": "string",
           "stopcock": {
             "location": "string",
@@ -2190,14 +2517,25 @@
             },
             "plantDrainsIntoWaterway": {
               "yesNo": "variant",
+              "hasInfiltrationSystem": {
+                "yesNo": "string"
+              },
               "dischargeCompliesWithGBR": "string"
             },
+            "dateDischargeCommenced": {},
+            "dateInstalled": "string",
             "dateReplaced": "string",
             "dateLastEmptied": "string",
-            "dateInstalled": "string",
+            "supplier": "string",
+            "makeModel": "string",
+            "serviceProviderName": "string",
             "dateLastServiced": "string",
             "attachments": "string",
             "details": "string"
+          },
+          "associatedCost": {
+            "frequency": "variant",
+            "amount": "number"
           }
         },
         "surfaceDrainageCharge": {
@@ -2258,12 +2596,17 @@
             "gasMeter": {
               "location": "string",
               "attachments": "string",
-              "mprn": "integer"
+              "mprn": "string"
             },
             "otherCentralHeatingFuelType": "string"
           },
           "centralHeatingInstalled": {},
           "boilerInstallationCertificate": {
+            "yesNo": "variant",
+            "boilerInstallationDate": {},
+            "attachments": "string"
+          },
+          "replacementOtherThanBoiler": {
             "yesNo": "variant",
             "attachments": "string"
           },
@@ -2278,7 +2621,8 @@
       },
       "otherHeatingFeatures": [
         "string"
-      ]
+      ],
+      "multipleHeatingSystems": "string"
     },
     "connectivity": {
       "telephone": {
@@ -2292,7 +2636,7 @@
         "dateToBeConnected": "string"
       },
       "broadband": {
-        "typeOfConnection": "string",
+        "typeOfConnection": "variant",
         "predictedSpeed": {
           "maxBbPredictedDown": "number",
           "maxBbPredictedUp": "number",
@@ -2302,7 +2646,8 @@
           "maxUfbbPredictedUp": "number",
           "maxPredictedDown": "number",
           "maxPredictedUp": "number"
-        }
+        },
+        "providerName": "string"
       },
       "mobilePhone": {
         "knownSignalIssues": {
@@ -2343,7 +2688,8 @@
           "voDataIndoor": "integer",
           "voDataIndoorNo4g": "integer"
         }
-      }
+      },
+      "otherServices": "string"
     },
     "insurance": {
       "difficultiesObtainingInsurance": {
@@ -2367,6 +2713,7 @@
       "isInsured": "variant",
       "details": "string",
       "landlordInsuresIfFlat": "string",
+      "whoInsures": "string",
       "insuranceClaims": {
         "yesNo": "variant",
         "details": "string"
@@ -2375,11 +2722,19 @@
     "rightsAndInformalArrangements": {
       "sharedContributions": {
         "yesNo": "variant",
-        "details": "string"
+        "details": "string",
+        "disagreementOrComplaint": {
+          "yesNo": "variant",
+          "details": "string"
+        }
       },
       "neighbouringLandRights": {
         "yesNo": "variant",
         "details": "string",
+        "disagreementOrComplaint": {
+          "yesNo": "variant",
+          "details": "string"
+        },
         "attachments": "string"
       },
       "accessRestrictionAttempts": {
@@ -2392,6 +2747,10 @@
           "details": "string",
           "attachments": "string"
         },
+        "privateRightOfWay": {
+          "yesNo": "variant",
+          "details": "string"
+        },
         "rightsOfLight": {
           "yesNo": "variant",
           "details": "string"
@@ -2419,6 +2778,18 @@
         "otherRights": {
           "yesNo": "variant",
           "details": "string"
+        },
+        "disagreementOrComplaint": {
+          "yesNo": "variant",
+          "details": "string"
+        }
+      },
+      "askedOthersToContribute": {
+        "yesNo": "variant",
+        "details": "string",
+        "disagreementOrComplaint": {
+          "yesNo": "variant",
+          "details": "string"
         }
       }
     },
@@ -2459,6 +2830,10 @@
           "details": "string"
         }
       },
+      "stormFireFloodDamage": {
+        "yesNo": "variant",
+        "details": "string"
+      },
       "radon": {
         "radonRisk": {
           "riskIndicator": "string",
@@ -2720,6 +3095,16 @@
       }
     },
     "additionalInformation": {
+      "consents": {
+        "attachments": {},
+        "consentsAttached": "string",
+        "consentsToFollow": "string",
+        "consentsNotAvailable": "string"
+      },
+      "furtherInformation": {
+        "details": "string",
+        "attachments": {}
+      },
       "restrictionsOnUseNotCompliedWith": {
         "yesNo": "variant",
         "details": "string",
@@ -2889,6 +3274,10 @@
         "yesNo": "variant",
         "attachments": "string"
       },
+      "insulation": {
+        "yesNo": "variant",
+        "attachments": "string"
+      },
       "solarPanels": {
         "yesNo": "variant",
         "attachments": "string"
@@ -2903,6 +3292,10 @@
         "details": "string",
         "attachments": "string"
       },
+      "breachOfTermsOrConditions": {
+        "yesNo": "variant",
+        "details": "string"
+      },
       "titleDefectInsurance": {
         "yesNo": "variant",
         "details": "string",
@@ -2977,7 +3370,9 @@
           "name": "string",
           "signedOn": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           }
         }
       ]
@@ -4286,7 +4681,9 @@
         "mimeType": "string",
         "documentType": "string",
         "externalIds": {
-          "*": {}
+          "*": {
+            "*": {}
+          }
         },
         "isDeleted": "boolean",
         "summary": {}
@@ -5148,7 +5545,9 @@
           "name": "string",
           "url": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           },
           "requiredSignatories": [
             {
@@ -5164,7 +5563,9 @@
           "name": "string",
           "signedOn": "string",
           "externalIds": {
-            "*": {}
+            "*": {
+              "*": {}
+            }
           }
         }
       ]
@@ -5175,7 +5576,9 @@
       {
         "transactionId": "string",
         "externalIds": {
-          "*": {}
+          "*": {
+            "*": {}
+          }
         },
         "address": {
           "buildingNumber": "string",
@@ -5240,7 +5643,9 @@
         "string"
       ],
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "buyerCircumstances": {
         "intendedUse": "string",
@@ -5287,7 +5692,9 @@
         }
       },
       "externalIds": {
-        "*": {}
+        "*": {
+          "*": {}
+        }
       },
       "resolutionCondition": "string"
     }