@pdtf/schemas 3.6.0-dev.3 → 3.6.0-dev.30

package/src/schemas/v3/skeleton.json

@@ -5,6 +5,13 @@
       "*": {}
     }
   },
+  "metadata": {
+    "*": {
+      "*": {
+        "*": {}
+      }
+    }
+  },
   "status": "string",
   "participants": [
     {
@@ -33,6 +40,11 @@
       },
       "organisation": "string",
       "organisationReference": "string",
+      "did": "string",
+      "participantId": "string",
+      "actingFor": [
+        "string"
+      ],
       "role": "variant",
       "externalIds": {
         "*": {
@@ -82,9 +94,19 @@
         "attachments": "string",
         "companyName": "string",
         "companyNumber": "string",
+        "directorOrAuthorisedPerson": "string",
         "countryOfIncorporation": "string"
       },
-      "dateBecameOwnerOrAuthority": "string"
+      "dateBecameOwnerOrAuthority": "string",
+      "giftDetails": {
+        "amount": "number",
+        "currency": "string",
+        "relationshipToBuyer": "string",
+        "fundsTransferred": "string",
+        "repayable": "boolean",
+        "confersBeneficialInterest": "boolean",
+        "willOccupyProperty": "boolean"
+      }
     }
   ],
   "propertyPack": {
@@ -147,12 +169,61 @@
     "marketingTenure": "string",
     "media": [
       {
+        "mediaId": "string",
         "mediaType": "string",
         "mediaUrl": "string",
         "caption": "string"
       }
     ],
     "buildInformation": {
+      "attributes": {
+        "storeyCount": "integer",
+        "heightMetres": "number",
+        "heightToRoofBaseMetres": "number",
+        "heightToHighestPointMetres": "number",
+        "heightMeasurementDate": "string",
+        "footprintAreaSquareMetres": "number",
+        "residentialUnitCount": "integer",
+        "constructionMaterial": "string",
+        "roofMaterial": "string",
+        "basementPresent": "string",
+        "solarPanelsPresent": "string",
+        "constructionPeriod": "string",
+        "constructionYear": "integer"
+      },
+      "higherRiskBuildingRegistration": {
+        "registrationStatus": "string",
+        "registrationNumber": "string",
+        "candidateCount": "integer",
+        "building": {
+          "name": "string",
+          "address": "string",
+          "postcode": "string",
+          "storeyCount": "integer",
+          "heightMetres": "number",
+          "residentialUnitCount": "integer",
+          "yearOfCompletion": "integer",
+          "occupied": "string"
+        },
+        "completionCertificate": {
+          "date": "string",
+          "issuer": "string",
+          "reference": "string"
+        },
+        "accountablePersons": [
+          {
+            "role": "string",
+            "personType": "string",
+            "name": "string",
+            "accountability": [
+              {
+                "section": "string",
+                "area": "string"
+              }
+            ]
+          }
+        ]
+      },
       "building": {
         "builtForm": "string",
         "propertyType": "variant",
@@ -162,7 +233,6 @@
         "hasLift": "string",
         "overCommercialPremises": {
           "isLocatedOverCommercialPremises": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         }
       },
@@ -981,7 +1051,6 @@
               },
               "excessPaymentAnticipated": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "lastDemandPeriod": {
@@ -994,7 +1063,6 @@
               },
               "reserveFund": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string",
                 "contributionIncludedInServiceCharge": "string",
                 "sufficentToCoverSection20Expenditure": {
@@ -1004,24 +1072,22 @@
               },
               "lastDecoratedPeriod": {
                 "externally": {
-                  "year": "integer",
+                  "year": "string",
                   "from": "string",
                   "to": "string"
                 },
                 "internally": {
-                  "year": "integer",
+                  "year": "string",
                   "from": "string",
                   "to": "string"
                 }
               },
               "section20WorksProposed": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "increaseInServiceChargeAnticipated": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "outstandingServiceChargeConsultation": {
@@ -1105,12 +1171,10 @@
               },
               "unresolvedDisputes": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               },
               "breachOfTermsOfLease": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string"
               }
             },
@@ -1130,7 +1194,6 @@
             "alterations": {
               "sellerAwareOfAlterations": {
                 "yesNo": "variant",
-                "detailsAnalysis": {},
                 "details": "string",
                 "landlordConsentObtained": {
                   "yesNo": "variant",
@@ -1265,7 +1328,6 @@
     "listingAndConservation": {
       "isListed": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1278,7 +1340,6 @@
         "yesNo": "variant",
         "workCarriedOut": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "consentsObtained": "string",
           "attachments": "string"
@@ -1288,13 +1349,11 @@
     "typeOfConstruction": {
       "isStandardForm": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "constructionType": "string",
         "details": "string"
       },
       "buildingSafety": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "workAlreadyDone": "string",
         "workToBeDone": "string",
@@ -1304,14 +1363,12 @@
       },
       "loft": {
         "loftAccess": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "loftBoarded": "string",
         "loftInsulated": "string"
       },
       "sprayFoamInsulation": {
         "hasSprayFoamInstalled": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1447,29 +1504,34 @@
     "disputesAndComplaints": {
       "hasDisputesAndComplaints": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "leadingToDisputesAndComplaints": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
     "alterationsAndChanges": {
       "hasStructuralAlterations": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
+        "alterationTypes": [
+          "string"
+        ],
         "details": "string",
+        "workCompleted": {
+          "yesNo": "variant",
+          "details": "string"
+        },
+        "documents": "string",
+        "approvalsObtained": "string",
+        "approvalsNotRequiredReason": "string",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
         "planningPermission": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1486,12 +1548,10 @@
       },
       "changeOfUse": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1518,12 +1578,10 @@
       },
       "windowReplacementsSince2002": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1569,12 +1627,10 @@
       },
       "hasAddedConservatory": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "yearCompleted": "integer",
         "buildingRegApproval": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "attachments": "string",
           "details": "string"
         },
@@ -1715,20 +1771,17 @@
       },
       "worksUnfinished": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
       "planningPermissionBreaches": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "willingToInsure": "string",
         "attachments": "string"
       },
       "unresolvedPlanningIssues": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "willingToInsure": "string",
         "attachments": "string"
@@ -1762,7 +1815,6 @@
       },
       "partyWallAct": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -1794,7 +1846,6 @@
       },
       "subsidenceOrStructuralFault": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -2427,7 +2478,6 @@
         "yearInstalled": "integer",
         "panelsOwnedOutright": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string",
           "associatedCost": {
@@ -2437,7 +2487,6 @@
         },
         "panelProviderLease": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string",
           "attachments": "string"
         },
@@ -2563,6 +2612,7 @@
             "dateInstalled": "string",
             "dateReplaced": "string",
             "dateLastEmptied": "string",
+            "permitDocuments": "string",
             "supplier": "string",
             "makeModel": "string",
             "serviceProviderName": "string",
@@ -2626,7 +2676,6 @@
     "heating": {
       "heatingSystem": {
         "heatingType": "variant",
-        "detailsAnalysis": {},
         "centralHeatingDetails": {
           "centralHeatingFuel": {
             "centralHeatingFuelType": "variant",
@@ -2657,10 +2706,30 @@
         },
         "details": "string"
       },
+      "mainHeatingTypes": [
+        "string"
+      ],
+      "mainHeatingTypesOtherDetails": "string",
+      "heatingInstalledDate": {},
+      "boilerInstalledDate": {},
+      "heatingSystemReplaced": "string",
+      "complianceCertificates": "string",
+      "inspectionReport": "string",
+      "inGoodWorkingOrder": "string",
+      "lastServicedYear": "string",
+      "lastServicedReport": "string",
       "otherHeatingFeatures": [
         "string"
       ],
-      "multipleHeatingSystems": "string"
+      "multipleHeatingSystems": "string",
+      "mainsGas": {
+        "yesNo": "string",
+        "supplier": "string",
+        "gasMeter": {
+          "location": "string",
+          "mprn": "string"
+        }
+      }
     },
     "connectivity": {
       "telephone": {
@@ -2733,22 +2802,18 @@
       "difficultiesObtainingInsurance": {
         "abnormalRiseInPremiums": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "subjectToHighExcesses": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "subjectToUnusualConditions": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         },
         "refused": {
           "yesNo": "variant",
-          "detailsAnalysis": {},
           "details": "string"
         }
       },
@@ -2758,7 +2823,6 @@
       "whoInsures": "string",
       "insuranceClaims": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -2773,11 +2837,11 @@
       },
       "neighbouringLandRights": {
         "yesNo": "variant",
-        "details": "string",
         "disagreementOrComplaint": {
           "yesNo": "variant",
           "details": "string"
         },
+        "details": "string",
         "attachments": "string"
       },
       "accessRestrictionAttempts": {
@@ -3183,28 +3247,23 @@
     "legalBoundaries": {
       "partOutsideLegalOwnership": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "partOnSeparateSiteOrDeed": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "boundariesDifferFromTitlePlan": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
       "boundaryAlterationProposal": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "ownership": {
-        "areBoundariesUniform": "variant",
-        "detailsAnalysis": {},
+        "areBoundariesUniform": "string",
         "uniformBoundaries": {
           "left": "string",
           "right": "string",
@@ -3216,17 +3275,14 @@
       },
       "haveBoundaryFeaturesMoved": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "adjacentLandIncluded": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       },
       "flyingFreehold": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string"
       }
     },
@@ -3255,10 +3311,10 @@
       },
       "electricalWorkSince2005": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "yearWorkCarriedOut": "integer",
         "details": "string",
         "suppliedCertificate": {
+          "yesNo": "string",
           "certificateType": "string",
           "attachments": "string"
         }
@@ -3284,7 +3340,6 @@
       "hasValidGuaranteesOrWarranties": "variant",
       "newHomeWarranty": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3342,7 +3397,6 @@
       },
       "outstandingClaimsOrApplications": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       },
@@ -3352,7 +3406,6 @@
       },
       "titleDefectInsurance": {
         "yesNo": "variant",
-        "detailsAnalysis": {},
         "details": "string",
         "attachments": "string"
       }
@@ -3422,6 +3475,7 @@
       "authorisationToShare": "boolean",
       "sellerSignatures": [
         {
+          "signatureId": "string",
           "name": "string",
           "signedOn": "string",
           "externalIds": {
@@ -4725,6 +4779,7 @@
     ],
     "searches": [
       {
+        "searchId": "string",
         "displayName": "string",
         "productCode": "string",
         "providerName": "string",
@@ -4740,6 +4795,7 @@
     ],
     "documents": [
       {
+        "documentId": "string",
         "displayName": "string",
         "fileName": "string",
         "mimeType": "string",
@@ -4755,6 +4811,7 @@
     ],
     "surveys": [
       {
+        "surveyId": "string",
         "outside": {
           "chimneyStacks": {
             "condition": "string",
@@ -5604,6 +5661,7 @@
   },
   "contracts": [
     {
+      "contractId": "string",
       "contract": {
         "template": {
           "name": "string",
@@ -5624,6 +5682,7 @@
       },
       "signatures": [
         {
+          "signatureId": "string",
           "name": "string",
           "signedOn": "string",
           "externalIds": {
@@ -5659,6 +5718,30 @@
         "uprn": "integer",
         "sellingAgent": "string"
       }
+    ],
+    "buyersSale": [
+      {
+        "transactionId": "string",
+        "externalIds": {
+          "*": {
+            "*": {}
+          }
+        },
+        "address": {
+          "buildingNumber": "string",
+          "buildingName": "string",
+          "subBuilding": "string",
+          "street": "string",
+          "line1": "string",
+          "line2": "string",
+          "line 3": "string",
+          "town": "string",
+          "postcode": "string",
+          "homeNation": "string"
+        },
+        "uprn": "integer",
+        "sellingAgent": "string"
+      }
     ]
   },
   "milestones": {
@@ -5711,6 +5794,13 @@
           "*": {}
         }
       },
+      "metadata": {
+        "*": {
+          "*": {
+            "*": {}
+          }
+        }
+      },
       "buyerCircumstances": {
         "intendedUse": "string",
         "firstTimeBuyer": "boolean",
@@ -5721,6 +5811,21 @@
         "giftedEquity": "boolean",
         "numberOfGiftedDeposits": "integer",
         "requiresMortgage": "variant",
+        "isAdditionalProperty": "boolean",
+        "dependentOnSale": "boolean",
+        "hasPets": "boolean",
+        "petDetails": "string",
+        "occupiedByFamilyMember": "boolean",
+        "intendsSublet": "boolean",
+        "subletType": "string",
+        "intendsBusiness": "boolean",
+        "businessType": "string",
+        "businessUseType": "string",
+        "intendsAlterations": "boolean",
+        "alterationDescription": "string",
+        "intendsResale": "boolean",
+        "vehicleRequirements": "string",
+        "financingMethod": "string",
         "helpToBuyEquityLoan": "boolean",
         "armedForcesHelpToBuy": "boolean",
         "numberOfHelpToBuyIsas": "integer",
@@ -5739,7 +5844,8 @@
         "existingMortgagedProperties": "integer",
         "annualIncome": "number",
         "residencyStatus": "string",
-        "nominatedLender": "string"
+        "nominatedLender": "string",
+        "nominatedLenderHandbookId": "string"
       }
     }
   },