@pdtf/schemas 3.6.0-dev.18 → 3.6.0-dev.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
},
|
|
48
48
|
"metadata": {
|
|
49
49
|
"title": "Metadata",
|
|
50
|
-
"description": "Flexible container for vendor-specific metadata items relating to the transaction. Keys are vendor-defined; values may be strings, numbers, booleans or nested objects.",
|
|
50
|
+
"description": "Flexible container for vendor-specific metadata items relating to the transaction. Keys are vendor-defined; values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below /metadata (e.g. /metadata/vendor/item/field).",
|
|
51
51
|
"type": "object",
|
|
52
52
|
"patternProperties": {
|
|
53
53
|
".*": {
|
|
@@ -64,7 +64,31 @@
|
|
|
64
64
|
{
|
|
65
65
|
"type": "object",
|
|
66
66
|
"patternProperties": {
|
|
67
|
-
".*": {
|
|
67
|
+
".*": {
|
|
68
|
+
"oneOf": [
|
|
69
|
+
{
|
|
70
|
+
"type": "string"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"type": "number"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"type": "boolean"
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
"type": "array"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"type": "null"
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"type": "object",
|
|
86
|
+
"patternProperties": {
|
|
87
|
+
".*": {}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
]
|
|
91
|
+
}
|
|
68
92
|
}
|
|
69
93
|
}
|
|
70
94
|
]
|
|
@@ -49471,6 +49495,56 @@
|
|
|
49471
49495
|
}
|
|
49472
49496
|
}
|
|
49473
49497
|
},
|
|
49498
|
+
"metadata": {
|
|
49499
|
+
"title": "Offer metadata",
|
|
49500
|
+
"description": "Flexible container for vendor-specific metadata items relating to this offer, keyed by vendor namespace (e.g. /offers/{id}/metadata/Moverly/lenderCompatibilityAnalysis). Values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below metadata (e.g. /offers/{id}/metadata/vendor/item/field).",
|
|
49501
|
+
"type": "object",
|
|
49502
|
+
"patternProperties": {
|
|
49503
|
+
".*": {
|
|
49504
|
+
"oneOf": [
|
|
49505
|
+
{
|
|
49506
|
+
"type": "string"
|
|
49507
|
+
},
|
|
49508
|
+
{
|
|
49509
|
+
"type": "number"
|
|
49510
|
+
},
|
|
49511
|
+
{
|
|
49512
|
+
"type": "boolean"
|
|
49513
|
+
},
|
|
49514
|
+
{
|
|
49515
|
+
"type": "object",
|
|
49516
|
+
"patternProperties": {
|
|
49517
|
+
".*": {
|
|
49518
|
+
"oneOf": [
|
|
49519
|
+
{
|
|
49520
|
+
"type": "string"
|
|
49521
|
+
},
|
|
49522
|
+
{
|
|
49523
|
+
"type": "number"
|
|
49524
|
+
},
|
|
49525
|
+
{
|
|
49526
|
+
"type": "boolean"
|
|
49527
|
+
},
|
|
49528
|
+
{
|
|
49529
|
+
"type": "array"
|
|
49530
|
+
},
|
|
49531
|
+
{
|
|
49532
|
+
"type": "null"
|
|
49533
|
+
},
|
|
49534
|
+
{
|
|
49535
|
+
"type": "object",
|
|
49536
|
+
"patternProperties": {
|
|
49537
|
+
".*": {}
|
|
49538
|
+
}
|
|
49539
|
+
}
|
|
49540
|
+
]
|
|
49541
|
+
}
|
|
49542
|
+
}
|
|
49543
|
+
}
|
|
49544
|
+
]
|
|
49545
|
+
}
|
|
49546
|
+
}
|
|
49547
|
+
},
|
|
49474
49548
|
"buyerCircumstances": {
|
|
49475
49549
|
"title": "Buyer circumstances",
|
|
49476
49550
|
"description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
|
|
@@ -49521,6 +49595,52 @@
|
|
|
49521
49595
|
"type": "string",
|
|
49522
49596
|
"title": "Requires mortgage",
|
|
49523
49597
|
"enum": ["Yes", "No"]
|
|
49598
|
+
},
|
|
49599
|
+
"isAdditionalProperty": {
|
|
49600
|
+
"type": "boolean",
|
|
49601
|
+
"title": "Additional property purchase",
|
|
49602
|
+
"description": "Whether the buyer already owns residential property (SDLT higher rates apply)"
|
|
49603
|
+
},
|
|
49604
|
+
"hasPets": {
|
|
49605
|
+
"type": "boolean",
|
|
49606
|
+
"title": "Buyer has pets",
|
|
49607
|
+
"description": "Relevant to lease and covenant pet restriction assessment"
|
|
49608
|
+
},
|
|
49609
|
+
"intendsSublet": {
|
|
49610
|
+
"type": "boolean",
|
|
49611
|
+
"title": "Buyer intends to sublet",
|
|
49612
|
+
"description": "Relevant to lease and covenant subletting restriction assessment"
|
|
49613
|
+
},
|
|
49614
|
+
"subletType": {
|
|
49615
|
+
"type": "string",
|
|
49616
|
+
"title": "Type of subletting intended",
|
|
49617
|
+
"enum": ["AST", "Lodger", "Airbnb", "HMO", "Company let", "Other"]
|
|
49618
|
+
},
|
|
49619
|
+
"intendsBusiness": {
|
|
49620
|
+
"type": "boolean",
|
|
49621
|
+
"title": "Buyer intends business use",
|
|
49622
|
+
"description": "Relevant to covenant and lease business-use restriction assessment"
|
|
49623
|
+
},
|
|
49624
|
+
"businessType": {
|
|
49625
|
+
"type": "string",
|
|
49626
|
+
"title": "Type of business intended"
|
|
49627
|
+
},
|
|
49628
|
+
"intendsAlterations": {
|
|
49629
|
+
"type": "boolean",
|
|
49630
|
+
"title": "Buyer intends significant alterations",
|
|
49631
|
+
"description": "Relevant to covenant, planning and building regulations assessment"
|
|
49632
|
+
},
|
|
49633
|
+
"financingMethod": {
|
|
49634
|
+
"type": "string",
|
|
49635
|
+
"title": "Primary financing method",
|
|
49636
|
+
"description": "How the purchase is funded, distinct from intendedUse (how the property will be used)",
|
|
49637
|
+
"enum": [
|
|
49638
|
+
"Mortgage",
|
|
49639
|
+
"Cash",
|
|
49640
|
+
"Shared ownership",
|
|
49641
|
+
"Help to Buy",
|
|
49642
|
+
"Right to Buy"
|
|
49643
|
+
]
|
|
49524
49644
|
}
|
|
49525
49645
|
},
|
|
49526
49646
|
"discriminator": {
|
|
@@ -49644,7 +49764,13 @@
|
|
|
49644
49764
|
},
|
|
49645
49765
|
"nominatedLender": {
|
|
49646
49766
|
"type": "string",
|
|
49647
|
-
"title": "Nominated lender"
|
|
49767
|
+
"title": "Nominated lender",
|
|
49768
|
+
"description": "The nominated lender's name as entered or selected"
|
|
49769
|
+
},
|
|
49770
|
+
"nominatedLenderHandbookId": {
|
|
49771
|
+
"type": "string",
|
|
49772
|
+
"title": "Nominated lender (UK Finance Handbook id)",
|
|
49773
|
+
"description": "The nominated lender's identifier in the UK Finance Mortgage Lenders' Handbook, e.g. nationwide-building-society, so lender requirements can be looked up without matching on name"
|
|
49648
49774
|
}
|
|
49649
49775
|
}
|
|
49650
49776
|
}
|
|
@@ -4495,6 +4495,7 @@
|
|
|
4495
4495
|
exclusions[]
|
|
4496
4496
|
conditions[]
|
|
4497
4497
|
externalIds{*}
|
|
4498
|
+
metadata{*}
|
|
4498
4499
|
buyerCircumstances
|
|
4499
4500
|
intendedUse
|
|
4500
4501
|
firstTimeBuyer
|
|
@@ -4505,6 +4506,14 @@
|
|
|
4505
4506
|
giftedEquity
|
|
4506
4507
|
numberOfGiftedDeposits
|
|
4507
4508
|
requiresMortgage
|
|
4509
|
+
isAdditionalProperty
|
|
4510
|
+
hasPets
|
|
4511
|
+
intendsSublet
|
|
4512
|
+
subletType
|
|
4513
|
+
intendsBusiness
|
|
4514
|
+
businessType
|
|
4515
|
+
intendsAlterations
|
|
4516
|
+
financingMethod
|
|
4508
4517
|
helpToBuyEquityLoan
|
|
4509
4518
|
armedForcesHelpToBuy
|
|
4510
4519
|
numberOfHelpToBuyIsas
|
|
@@ -4524,6 +4533,7 @@
|
|
|
4524
4533
|
annualIncome
|
|
4525
4534
|
residencyStatus
|
|
4526
4535
|
nominatedLender
|
|
4536
|
+
nominatedLenderHandbookId
|
|
4527
4537
|
enquiries{*}
|
|
4528
4538
|
subject
|
|
4529
4539
|
status
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
},
|
|
39
39
|
"metadata": {
|
|
40
40
|
"title": "Metadata",
|
|
41
|
-
"description": "Flexible container for vendor-specific metadata items relating to the transaction. Keys are vendor-defined; values may be strings, numbers, booleans or nested objects.",
|
|
41
|
+
"description": "Flexible container for vendor-specific metadata items relating to the transaction. Keys are vendor-defined; values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below /metadata (e.g. /metadata/vendor/item/field).",
|
|
42
42
|
"type": "object",
|
|
43
43
|
"patternProperties": {
|
|
44
44
|
".*": {
|
|
@@ -55,7 +55,31 @@
|
|
|
55
55
|
{
|
|
56
56
|
"type": "object",
|
|
57
57
|
"patternProperties": {
|
|
58
|
-
".*": {
|
|
58
|
+
".*": {
|
|
59
|
+
"oneOf": [
|
|
60
|
+
{
|
|
61
|
+
"type": "string"
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
"type": "number"
|
|
65
|
+
},
|
|
66
|
+
{
|
|
67
|
+
"type": "boolean"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"type": "array"
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"type": "null"
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
"type": "object",
|
|
77
|
+
"patternProperties": {
|
|
78
|
+
".*": {}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
}
|
|
59
83
|
}
|
|
60
84
|
}
|
|
61
85
|
]
|
|
@@ -41498,6 +41522,56 @@
|
|
|
41498
41522
|
}
|
|
41499
41523
|
}
|
|
41500
41524
|
},
|
|
41525
|
+
"metadata": {
|
|
41526
|
+
"title": "Offer metadata",
|
|
41527
|
+
"description": "Flexible container for vendor-specific metadata items relating to this offer, keyed by vendor namespace (e.g. /offers/{id}/metadata/Moverly/lenderCompatibilityAnalysis). Values may be strings, numbers, booleans or nested objects. Paths are addressable up to three levels below metadata (e.g. /offers/{id}/metadata/vendor/item/field).",
|
|
41528
|
+
"type": "object",
|
|
41529
|
+
"patternProperties": {
|
|
41530
|
+
".*": {
|
|
41531
|
+
"oneOf": [
|
|
41532
|
+
{
|
|
41533
|
+
"type": "string"
|
|
41534
|
+
},
|
|
41535
|
+
{
|
|
41536
|
+
"type": "number"
|
|
41537
|
+
},
|
|
41538
|
+
{
|
|
41539
|
+
"type": "boolean"
|
|
41540
|
+
},
|
|
41541
|
+
{
|
|
41542
|
+
"type": "object",
|
|
41543
|
+
"patternProperties": {
|
|
41544
|
+
".*": {
|
|
41545
|
+
"oneOf": [
|
|
41546
|
+
{
|
|
41547
|
+
"type": "string"
|
|
41548
|
+
},
|
|
41549
|
+
{
|
|
41550
|
+
"type": "number"
|
|
41551
|
+
},
|
|
41552
|
+
{
|
|
41553
|
+
"type": "boolean"
|
|
41554
|
+
},
|
|
41555
|
+
{
|
|
41556
|
+
"type": "array"
|
|
41557
|
+
},
|
|
41558
|
+
{
|
|
41559
|
+
"type": "null"
|
|
41560
|
+
},
|
|
41561
|
+
{
|
|
41562
|
+
"type": "object",
|
|
41563
|
+
"patternProperties": {
|
|
41564
|
+
".*": {}
|
|
41565
|
+
}
|
|
41566
|
+
}
|
|
41567
|
+
]
|
|
41568
|
+
}
|
|
41569
|
+
}
|
|
41570
|
+
}
|
|
41571
|
+
]
|
|
41572
|
+
}
|
|
41573
|
+
}
|
|
41574
|
+
},
|
|
41501
41575
|
"buyerCircumstances": {
|
|
41502
41576
|
"title": "Buyer circumstances",
|
|
41503
41577
|
"description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
|
|
@@ -41551,6 +41625,59 @@
|
|
|
41551
41625
|
"Yes",
|
|
41552
41626
|
"No"
|
|
41553
41627
|
]
|
|
41628
|
+
},
|
|
41629
|
+
"isAdditionalProperty": {
|
|
41630
|
+
"type": "boolean",
|
|
41631
|
+
"title": "Additional property purchase",
|
|
41632
|
+
"description": "Whether the buyer already owns residential property (SDLT higher rates apply)"
|
|
41633
|
+
},
|
|
41634
|
+
"hasPets": {
|
|
41635
|
+
"type": "boolean",
|
|
41636
|
+
"title": "Buyer has pets",
|
|
41637
|
+
"description": "Relevant to lease and covenant pet restriction assessment"
|
|
41638
|
+
},
|
|
41639
|
+
"intendsSublet": {
|
|
41640
|
+
"type": "boolean",
|
|
41641
|
+
"title": "Buyer intends to sublet",
|
|
41642
|
+
"description": "Relevant to lease and covenant subletting restriction assessment"
|
|
41643
|
+
},
|
|
41644
|
+
"subletType": {
|
|
41645
|
+
"type": "string",
|
|
41646
|
+
"title": "Type of subletting intended",
|
|
41647
|
+
"enum": [
|
|
41648
|
+
"AST",
|
|
41649
|
+
"Lodger",
|
|
41650
|
+
"Airbnb",
|
|
41651
|
+
"HMO",
|
|
41652
|
+
"Company let",
|
|
41653
|
+
"Other"
|
|
41654
|
+
]
|
|
41655
|
+
},
|
|
41656
|
+
"intendsBusiness": {
|
|
41657
|
+
"type": "boolean",
|
|
41658
|
+
"title": "Buyer intends business use",
|
|
41659
|
+
"description": "Relevant to covenant and lease business-use restriction assessment"
|
|
41660
|
+
},
|
|
41661
|
+
"businessType": {
|
|
41662
|
+
"type": "string",
|
|
41663
|
+
"title": "Type of business intended"
|
|
41664
|
+
},
|
|
41665
|
+
"intendsAlterations": {
|
|
41666
|
+
"type": "boolean",
|
|
41667
|
+
"title": "Buyer intends significant alterations",
|
|
41668
|
+
"description": "Relevant to covenant, planning and building regulations assessment"
|
|
41669
|
+
},
|
|
41670
|
+
"financingMethod": {
|
|
41671
|
+
"type": "string",
|
|
41672
|
+
"title": "Primary financing method",
|
|
41673
|
+
"description": "How the purchase is funded, distinct from intendedUse (how the property will be used)",
|
|
41674
|
+
"enum": [
|
|
41675
|
+
"Mortgage",
|
|
41676
|
+
"Cash",
|
|
41677
|
+
"Shared ownership",
|
|
41678
|
+
"Help to Buy",
|
|
41679
|
+
"Right to Buy"
|
|
41680
|
+
]
|
|
41554
41681
|
}
|
|
41555
41682
|
},
|
|
41556
41683
|
"required": [
|
|
@@ -41684,7 +41811,13 @@
|
|
|
41684
41811
|
},
|
|
41685
41812
|
"nominatedLender": {
|
|
41686
41813
|
"type": "string",
|
|
41687
|
-
"title": "Nominated lender"
|
|
41814
|
+
"title": "Nominated lender",
|
|
41815
|
+
"description": "The nominated lender's name as entered or selected"
|
|
41816
|
+
},
|
|
41817
|
+
"nominatedLenderHandbookId": {
|
|
41818
|
+
"type": "string",
|
|
41819
|
+
"title": "Nominated lender (UK Finance Handbook id)",
|
|
41820
|
+
"description": "The nominated lender's identifier in the UK Finance Mortgage Lenders' Handbook, e.g. nationwide-building-society, so lender requirements can be looked up without matching on name"
|
|
41688
41821
|
}
|
|
41689
41822
|
}
|
|
41690
41823
|
}
|
|
@@ -7,7 +7,9 @@
|
|
|
7
7
|
},
|
|
8
8
|
"metadata": {
|
|
9
9
|
"*": {
|
|
10
|
-
"*": {
|
|
10
|
+
"*": {
|
|
11
|
+
"*": {}
|
|
12
|
+
}
|
|
11
13
|
}
|
|
12
14
|
},
|
|
13
15
|
"status": "string",
|
|
@@ -5747,6 +5749,13 @@
|
|
|
5747
5749
|
"*": {}
|
|
5748
5750
|
}
|
|
5749
5751
|
},
|
|
5752
|
+
"metadata": {
|
|
5753
|
+
"*": {
|
|
5754
|
+
"*": {
|
|
5755
|
+
"*": {}
|
|
5756
|
+
}
|
|
5757
|
+
}
|
|
5758
|
+
},
|
|
5750
5759
|
"buyerCircumstances": {
|
|
5751
5760
|
"intendedUse": "string",
|
|
5752
5761
|
"firstTimeBuyer": "boolean",
|
|
@@ -5757,6 +5766,14 @@
|
|
|
5757
5766
|
"giftedEquity": "boolean",
|
|
5758
5767
|
"numberOfGiftedDeposits": "integer",
|
|
5759
5768
|
"requiresMortgage": "variant",
|
|
5769
|
+
"isAdditionalProperty": "boolean",
|
|
5770
|
+
"hasPets": "boolean",
|
|
5771
|
+
"intendsSublet": "boolean",
|
|
5772
|
+
"subletType": "string",
|
|
5773
|
+
"intendsBusiness": "boolean",
|
|
5774
|
+
"businessType": "string",
|
|
5775
|
+
"intendsAlterations": "boolean",
|
|
5776
|
+
"financingMethod": "string",
|
|
5760
5777
|
"helpToBuyEquityLoan": "boolean",
|
|
5761
5778
|
"armedForcesHelpToBuy": "boolean",
|
|
5762
5779
|
"numberOfHelpToBuyIsas": "integer",
|
|
@@ -5775,7 +5792,8 @@
|
|
|
5775
5792
|
"existingMortgagedProperties": "integer",
|
|
5776
5793
|
"annualIncome": "number",
|
|
5777
5794
|
"residencyStatus": "string",
|
|
5778
|
-
"nominatedLender": "string"
|
|
5795
|
+
"nominatedLender": "string",
|
|
5796
|
+
"nominatedLenderHandbookId": "string"
|
|
5779
5797
|
}
|
|
5780
5798
|
}
|
|
5781
5799
|
},
|