@planning-inspectorate/data-model 1.19.0 → 1.20.0

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.
Files changed (35) hide show
  1. package/docs/README.md +20 -0
  2. package/docs/nsip-project-defs-invoice.md +267 -0
  3. package/docs/nsip-project-defs-meeting.md +122 -0
  4. package/docs/nsip-project-defs.md +3 -0
  5. package/docs/nsip-project.md +1889 -7
  6. package/package.json +2 -2
  7. package/pins_data_model/models/model_appeal_document.py +1 -1
  8. package/pins_data_model/models/model_appeal_event.py +1 -1
  9. package/pins_data_model/models/model_appeal_event_estimate.py +1 -1
  10. package/pins_data_model/models/model_appeal_has.py +1 -1
  11. package/pins_data_model/models/model_appeal_representation.py +1 -1
  12. package/pins_data_model/models/model_appeal_s78.py +1 -1
  13. package/pins_data_model/models/model_dart_response.py +1 -1
  14. package/pins_data_model/models/model_entraid.py +1 -1
  15. package/pins_data_model/models/model_folder.py +1 -1
  16. package/pins_data_model/models/model_gettimesheets_response.py +1 -1
  17. package/pins_data_model/models/model_listed_building.py +1 -1
  18. package/pins_data_model/models/model_listed_buildings.py +1 -1
  19. package/pins_data_model/models/model_nsip_document.py +1 -1
  20. package/pins_data_model/models/model_nsip_exam_timetable.py +1 -1
  21. package/pins_data_model/models/model_nsip_project.py +535 -3
  22. package/pins_data_model/models/model_nsip_project_update.py +1 -1
  23. package/pins_data_model/models/model_nsip_representation.py +1 -1
  24. package/pins_data_model/models/model_nsip_subscription.py +1 -1
  25. package/pins_data_model/models/model_pins_inspector.py +1 -1
  26. package/pins_data_model/models/model_pins_lpa.py +1 -1
  27. package/pins_data_model/models/model_s51_advice.py +1 -1
  28. package/pins_data_model/models/model_service_user.py +1 -1
  29. package/schemas/nsip-project.schema.json +420 -2
  30. package/src/enums.cjs +678 -581
  31. package/src/enums.d.ts +668 -583
  32. package/src/enums.js +668 -583
  33. package/src/index.cjs +678 -581
  34. package/src/lib/gen-enums.js +1 -1
  35. package/src/schemas.d.ts +290 -3
@@ -86,6 +86,56 @@
86
86
  | [dateOfReOpenRelevantRepresentationStart](#dateofreopenrelevantrepresentationstart) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-dateofreopenrelevantrepresentationstart.md "nsip-project.schema.json#/properties/dateOfReOpenRelevantRepresentationStart") |
87
87
  | [dateOfReOpenRelevantRepresentationClose](#dateofreopenrelevantrepresentationclose) | `string` | Required | can be null | [NSIP Project](nsip-project-properties-dateofreopenrelevantrepresentationclose.md "nsip-project.schema.json#/properties/dateOfReOpenRelevantRepresentationClose") |
88
88
  | [isMaterialChange](#ismaterialchange) | `boolean` | Optional | can be null | [NSIP Project](nsip-project-properties-ismaterialchange.md "nsip-project.schema.json#/properties/isMaterialChange") |
89
+ | [courtDecisionDate](#courtdecisiondate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-courtdecisiondate.md "nsip-project.schema.json#/properties/courtDecisionDate") |
90
+ | [courtDecisionOutcomeText](#courtdecisionoutcometext) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-courtdecisionoutcometext.md "nsip-project.schema.json#/properties/courtDecisionOutcomeText") |
91
+ | [decisionChallengeSubmissionDate](#decisionchallengesubmissiondate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-decisionchallengesubmissiondate.md "nsip-project.schema.json#/properties/decisionChallengeSubmissionDate") |
92
+ | [recommendation](#recommendation) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-recommendation.md "nsip-project.schema.json#/properties/recommendation") |
93
+ | [inceptionMeetingDate](#inceptionmeetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-inceptionmeetingdate.md "nsip-project.schema.json#/properties/inceptionMeetingDate") |
94
+ | [draftDocumentSubmissionDate](#draftdocumentsubmissiondate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-draftdocumentsubmissiondate.md "nsip-project.schema.json#/properties/draftDocumentSubmissionDate") |
95
+ | [programmeDocumentSubmissionDate](#programmedocumentsubmissiondate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-programmedocumentsubmissiondate.md "nsip-project.schema.json#/properties/programmeDocumentSubmissionDate") |
96
+ | [tier](#tier) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-tier.md "nsip-project.schema.json#/properties/tier") |
97
+ | [s61SummaryURI](#s61summaryuri) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-s61summaryuri.md "nsip-project.schema.json#/properties/s61SummaryURI") |
98
+ | [estimatedScopingSubmissionDate](#estimatedscopingsubmissiondate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-estimatedscopingsubmissiondate.md "nsip-project.schema.json#/properties/estimatedScopingSubmissionDate") |
99
+ | [consultationMilestoneAdequacyDate](#consultationmilestoneadequacydate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-consultationmilestoneadequacydate.md "nsip-project.schema.json#/properties/consultationMilestoneAdequacyDate") |
100
+ | [planProcessEvidence](#planprocessevidence) | `boolean` | Optional | can be null | [NSIP Project](nsip-project-properties-planprocessevidence.md "nsip-project.schema.json#/properties/planProcessEvidence") |
101
+ | [issuesTracker](#issuestracker) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-issuestracker.md "nsip-project.schema.json#/properties/issuesTracker") |
102
+ | [essentialFastTrackComponents](#essentialfasttrackcomponents) | `boolean` | Optional | can be null | [NSIP Project](nsip-project-properties-essentialfasttrackcomponents.md "nsip-project.schema.json#/properties/essentialFastTrackComponents") |
103
+ | [principalAreaDisagreementSummaryStmt](#principalareadisagreementsummarystmt) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-principalareadisagreementsummarystmt.md "nsip-project.schema.json#/properties/principalAreaDisagreementSummaryStmt") |
104
+ | [principalAreaDisagreementSummaryStmtSubmittedDate](#principalareadisagreementsummarystmtsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-principalareadisagreementsummarystmtsubmitteddate.md "nsip-project.schema.json#/properties/principalAreaDisagreementSummaryStmtSubmittedDate") |
105
+ | [policyComplianceDocument](#policycompliancedocument) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-policycompliancedocument.md "nsip-project.schema.json#/properties/policyComplianceDocument") |
106
+ | [policyComplianceDocumentSubmittedDate](#policycompliancedocumentsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-policycompliancedocumentsubmitteddate.md "nsip-project.schema.json#/properties/policyComplianceDocumentSubmittedDate") |
107
+ | [designApproachDocument](#designapproachdocument) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-designapproachdocument.md "nsip-project.schema.json#/properties/designApproachDocument") |
108
+ | [designApproachDocumentSubmittedDate](#designapproachdocumentsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-designapproachdocumentsubmitteddate.md "nsip-project.schema.json#/properties/designApproachDocumentSubmittedDate") |
109
+ | [matureOutlineControlDocument](#matureoutlinecontroldocument) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-matureoutlinecontroldocument.md "nsip-project.schema.json#/properties/matureOutlineControlDocument") |
110
+ | [matureOutlineControlDocumentSubmittedDate](#matureoutlinecontroldocumentsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-matureoutlinecontroldocumentsubmitteddate.md "nsip-project.schema.json#/properties/matureOutlineControlDocumentSubmittedDate") |
111
+ | [caAndTpEvidence](#caandtpevidence) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-caandtpevidence.md "nsip-project.schema.json#/properties/caAndTpEvidence") |
112
+ | [caAndTpEvidenceSubmittedDate](#caandtpevidencesubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-caandtpevidencesubmitteddate.md "nsip-project.schema.json#/properties/caAndTpEvidenceSubmittedDate") |
113
+ | [publicSectorEqualityDuty](#publicsectorequalityduty) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-publicsectorequalityduty.md "nsip-project.schema.json#/properties/publicSectorEqualityDuty") |
114
+ | [publicSectorEqualityDutySubmittedDate](#publicsectorequalitydutysubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-publicsectorequalitydutysubmitteddate.md "nsip-project.schema.json#/properties/publicSectorEqualityDutySubmittedDate") |
115
+ | [fastTrackAdmissionDocument](#fasttrackadmissiondocument) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-fasttrackadmissiondocument.md "nsip-project.schema.json#/properties/fastTrackAdmissionDocument") |
116
+ | [fastTrackAdmissionDocumentSubmittedDate](#fasttrackadmissiondocumentsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-fasttrackadmissiondocumentsubmitteddate.md "nsip-project.schema.json#/properties/fastTrackAdmissionDocumentSubmittedDate") |
117
+ | [multipartyApplicationCheckDocument](#multipartyapplicationcheckdocument) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-multipartyapplicationcheckdocument.md "nsip-project.schema.json#/properties/multipartyApplicationCheckDocument") |
118
+ | [multipartyApplicationCheckDocumentSubmittedDate](#multipartyapplicationcheckdocumentsubmitteddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-multipartyapplicationcheckdocumentsubmitteddate.md "nsip-project.schema.json#/properties/multipartyApplicationCheckDocumentSubmittedDate") |
119
+ | [programmeDocumentURI](#programmedocumenturi) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-programmedocumenturi.md "nsip-project.schema.json#/properties/programmeDocumentURI") |
120
+ | [updatedProgrammeDocumentReceivedDate](#updatedprogrammedocumentreceiveddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-updatedprogrammedocumentreceiveddate.md "nsip-project.schema.json#/properties/updatedProgrammeDocumentReceivedDate") |
121
+ | [programmeDocumentReviewedByEstDate](#programmedocumentreviewedbyestdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-programmedocumentreviewedbyestdate.md "nsip-project.schema.json#/properties/programmeDocumentReviewedByEstDate") |
122
+ | [caseTeamIssuedCommentsDate](#caseteamissuedcommentsdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-caseteamissuedcommentsdate.md "nsip-project.schema.json#/properties/caseTeamIssuedCommentsDate") |
123
+ | [subProjectType](#subprojecttype) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-subprojecttype.md "nsip-project.schema.json#/properties/subProjectType") |
124
+ | [newMaturity](#newmaturity) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-newmaturity.md "nsip-project.schema.json#/properties/newMaturity") |
125
+ | [statutoryConsultationPeriodEndDate](#statutoryconsultationperiodenddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-statutoryconsultationperiodenddate.md "nsip-project.schema.json#/properties/statutoryConsultationPeriodEndDate") |
126
+ | [submissionOfDraftDocumentsDate](#submissionofdraftdocumentsdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-submissionofdraftdocumentsdate.md "nsip-project.schema.json#/properties/submissionOfDraftDocumentsDate") |
127
+ | [numberBand2Inspectors](#numberband2inspectors) | `number` | Optional | can be null | [NSIP Project](nsip-project-properties-numberband2inspectors.md "nsip-project.schema.json#/properties/numberBand2Inspectors") |
128
+ | [numberBand3Inspectors](#numberband3inspectors) | `number` | Optional | can be null | [NSIP Project](nsip-project-properties-numberband3inspectors.md "nsip-project.schema.json#/properties/numberBand3Inspectors") |
129
+ | [memLastUpdated](#memlastupdated) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-memlastupdated.md "nsip-project.schema.json#/properties/memLastUpdated") |
130
+ | [additionalComments](#additionalcomments) | `string` | Optional | can be null | [NSIP Project](nsip-project-properties-additionalcomments.md "nsip-project.schema.json#/properties/additionalComments") |
131
+ | [operationsLeadIds](#operationsleadids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-operationsleadids.md "nsip-project.schema.json#/properties/operationsLeadIds") |
132
+ | [operationsManagerIds](#operationsmanagerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-operationsmanagerids.md "nsip-project.schema.json#/properties/operationsManagerIds") |
133
+ | [caseManagerIds](#casemanagerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-casemanagerids.md "nsip-project.schema.json#/properties/caseManagerIds") |
134
+ | [leadInspectorIds](#leadinspectorids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-leadinspectorids.md "nsip-project.schema.json#/properties/leadInspectorIds") |
135
+ | [environmentalServicesOfficerIds](#environmentalservicesofficerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-environmentalservicesofficerids.md "nsip-project.schema.json#/properties/environmentalServicesOfficerIds") |
136
+ | [legalOfficerIds](#legalofficerids) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-legalofficerids.md "nsip-project.schema.json#/properties/legalOfficerIds") |
137
+ | [meetings](#meetings) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-meetings.md "nsip-project.schema.json#/properties/meetings") |
138
+ | [invoices](#invoices) | `array` | Optional | cannot be null | [NSIP Project](nsip-project-properties-invoices.md "nsip-project.schema.json#/properties/invoices") |
89
139
  | Additional Properties | Any | Optional | can be null | |
90
140
 
91
141
  ## caseId
@@ -222,7 +272,7 @@ Name of project in Welsh
222
272
 
223
273
  ## decision
224
274
 
225
- Decision: approved/refused/split-decision
275
+ Decision outcome: approved/refused/split-decision/granted/partially\_consented/quashed/redetermination/withdrawn
226
276
 
227
277
  `decision`
228
278
 
@@ -242,12 +292,17 @@ Decision: approved/refused/split-decision
242
292
 
243
293
  **enum**: the value of this property must be equal to one of the following values:
244
294
 
245
- | Value | Explanation |
246
- | :----------------- | :---------- |
247
- | `"approved"` | |
248
- | `"refused"` | |
249
- | `"split-decision"` | |
250
- | `null` | |
295
+ | Value | Explanation |
296
+ | :---------------------- | :---------- |
297
+ | `"approved"` | |
298
+ | `"refused"` | |
299
+ | `"split-decision"` | |
300
+ | `"granted"` | |
301
+ | `"partially_consented"` | |
302
+ | `"quashed"` | |
303
+ | `"redetermination"` | |
304
+ | `"withdrawn"` | |
305
+ | `null` | |
251
306
 
252
307
  ## publishStatus
253
308
 
@@ -2093,6 +2148,1833 @@ true
2093
2148
  false
2094
2149
  ```
2095
2150
 
2151
+ ## courtDecisionDate
2152
+
2153
+ Date of court decision
2154
+
2155
+ `courtDecisionDate`
2156
+
2157
+ * is optional
2158
+
2159
+ * Type: `string`
2160
+
2161
+ * can be null
2162
+
2163
+ * defined in: [NSIP Project](nsip-project-properties-courtdecisiondate.md "nsip-project.schema.json#/properties/courtDecisionDate")
2164
+
2165
+ ### courtDecisionDate Type
2166
+
2167
+ `string`
2168
+
2169
+ ### courtDecisionDate Constraints
2170
+
2171
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2172
+
2173
+ ### courtDecisionDate Examples
2174
+
2175
+ ```json
2176
+ "2023-07-27T20:30:00.000Z"
2177
+ ```
2178
+
2179
+ ## courtDecisionOutcomeText
2180
+
2181
+ Court decision outcome text; values include 'upheld','partially\_upheld','quashed','other:<Text>'
2182
+
2183
+ `courtDecisionOutcomeText`
2184
+
2185
+ * is optional
2186
+
2187
+ * Type: `string`
2188
+
2189
+ * can be null
2190
+
2191
+ * defined in: [NSIP Project](nsip-project-properties-courtdecisionoutcometext.md "nsip-project.schema.json#/properties/courtDecisionOutcomeText")
2192
+
2193
+ ### courtDecisionOutcomeText Type
2194
+
2195
+ `string`
2196
+
2197
+ ### courtDecisionOutcomeText Examples
2198
+
2199
+ ```json
2200
+ "upheld"
2201
+ ```
2202
+
2203
+ ## decisionChallengeSubmissionDate
2204
+
2205
+ Date of decision challenge submission
2206
+
2207
+ `decisionChallengeSubmissionDate`
2208
+
2209
+ * is optional
2210
+
2211
+ * Type: `string`
2212
+
2213
+ * can be null
2214
+
2215
+ * defined in: [NSIP Project](nsip-project-properties-decisionchallengesubmissiondate.md "nsip-project.schema.json#/properties/decisionChallengeSubmissionDate")
2216
+
2217
+ ### decisionChallengeSubmissionDate Type
2218
+
2219
+ `string`
2220
+
2221
+ ### decisionChallengeSubmissionDate Constraints
2222
+
2223
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2224
+
2225
+ ### decisionChallengeSubmissionDate Examples
2226
+
2227
+ ```json
2228
+ "2023-07-27T20:30:00.000Z"
2229
+ ```
2230
+
2231
+ ## recommendation
2232
+
2233
+ Recommendation
2234
+
2235
+ `recommendation`
2236
+
2237
+ * is optional
2238
+
2239
+ * Type: `string`
2240
+
2241
+ * can be null
2242
+
2243
+ * defined in: [NSIP Project](nsip-project-properties-recommendation.md "nsip-project.schema.json#/properties/recommendation")
2244
+
2245
+ ### recommendation Type
2246
+
2247
+ `string`
2248
+
2249
+ ### recommendation Constraints
2250
+
2251
+ **enum**: the value of this property must be equal to one of the following values:
2252
+
2253
+ | Value | Explanation |
2254
+ | :---------------------------- | :---------- |
2255
+ | `"recommend_consent"` | |
2256
+ | `"recommend_partial_consent"` | |
2257
+ | `"recommend_refusal"` | |
2258
+ | `null` | |
2259
+
2260
+ ### recommendation Examples
2261
+
2262
+ ```json
2263
+ "recommend_consent"
2264
+ ```
2265
+
2266
+ ## inceptionMeetingDate
2267
+
2268
+ Date of inception meeting
2269
+
2270
+ `inceptionMeetingDate`
2271
+
2272
+ * is optional
2273
+
2274
+ * Type: `string`
2275
+
2276
+ * can be null
2277
+
2278
+ * defined in: [NSIP Project](nsip-project-properties-inceptionmeetingdate.md "nsip-project.schema.json#/properties/inceptionMeetingDate")
2279
+
2280
+ ### inceptionMeetingDate Type
2281
+
2282
+ `string`
2283
+
2284
+ ### inceptionMeetingDate Constraints
2285
+
2286
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2287
+
2288
+ ### inceptionMeetingDate Examples
2289
+
2290
+ ```json
2291
+ "2023-07-27T20:30:00.000Z"
2292
+ ```
2293
+
2294
+ ## draftDocumentSubmissionDate
2295
+
2296
+ Date for submission of draft documents
2297
+
2298
+ `draftDocumentSubmissionDate`
2299
+
2300
+ * is optional
2301
+
2302
+ * Type: `string`
2303
+
2304
+ * can be null
2305
+
2306
+ * defined in: [NSIP Project](nsip-project-properties-draftdocumentsubmissiondate.md "nsip-project.schema.json#/properties/draftDocumentSubmissionDate")
2307
+
2308
+ ### draftDocumentSubmissionDate Type
2309
+
2310
+ `string`
2311
+
2312
+ ### draftDocumentSubmissionDate Constraints
2313
+
2314
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2315
+
2316
+ ### draftDocumentSubmissionDate Examples
2317
+
2318
+ ```json
2319
+ "2023-07-27T20:30:00.000Z"
2320
+ ```
2321
+
2322
+ ## programmeDocumentSubmissionDate
2323
+
2324
+ Programme document submission date
2325
+
2326
+ `programmeDocumentSubmissionDate`
2327
+
2328
+ * is optional
2329
+
2330
+ * Type: `string`
2331
+
2332
+ * can be null
2333
+
2334
+ * defined in: [NSIP Project](nsip-project-properties-programmedocumentsubmissiondate.md "nsip-project.schema.json#/properties/programmeDocumentSubmissionDate")
2335
+
2336
+ ### programmeDocumentSubmissionDate Type
2337
+
2338
+ `string`
2339
+
2340
+ ### programmeDocumentSubmissionDate Constraints
2341
+
2342
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2343
+
2344
+ ### programmeDocumentSubmissionDate Examples
2345
+
2346
+ ```json
2347
+ "2023-07-27T20:30:00.000Z"
2348
+ ```
2349
+
2350
+ ## tier
2351
+
2352
+ Tier
2353
+
2354
+ `tier`
2355
+
2356
+ * is optional
2357
+
2358
+ * Type: `string`
2359
+
2360
+ * can be null
2361
+
2362
+ * defined in: [NSIP Project](nsip-project-properties-tier.md "nsip-project.schema.json#/properties/tier")
2363
+
2364
+ ### tier Type
2365
+
2366
+ `string`
2367
+
2368
+ ### tier Constraints
2369
+
2370
+ **enum**: the value of this property must be equal to one of the following values:
2371
+
2372
+ | Value | Explanation |
2373
+ | :----------- | :---------- |
2374
+ | `"basic"` | |
2375
+ | `"standard"` | |
2376
+ | `"enhanced"` | |
2377
+ | `null` | |
2378
+
2379
+ ### tier Examples
2380
+
2381
+ ```json
2382
+ "basic"
2383
+ ```
2384
+
2385
+ ## s61SummaryURI
2386
+
2387
+ Link to s61 summary
2388
+
2389
+ `s61SummaryURI`
2390
+
2391
+ * is optional
2392
+
2393
+ * Type: `string`
2394
+
2395
+ * can be null
2396
+
2397
+ * defined in: [NSIP Project](nsip-project-properties-s61summaryuri.md "nsip-project.schema.json#/properties/s61SummaryURI")
2398
+
2399
+ ### s61SummaryURI Type
2400
+
2401
+ `string`
2402
+
2403
+ ### s61SummaryURI Examples
2404
+
2405
+ ```json
2406
+ "s61.sharepoint.com/"
2407
+ ```
2408
+
2409
+ ## estimatedScopingSubmissionDate
2410
+
2411
+ Estimated scoping submission date
2412
+
2413
+ `estimatedScopingSubmissionDate`
2414
+
2415
+ * is optional
2416
+
2417
+ * Type: `string`
2418
+
2419
+ * can be null
2420
+
2421
+ * defined in: [NSIP Project](nsip-project-properties-estimatedscopingsubmissiondate.md "nsip-project.schema.json#/properties/estimatedScopingSubmissionDate")
2422
+
2423
+ ### estimatedScopingSubmissionDate Type
2424
+
2425
+ `string`
2426
+
2427
+ ### estimatedScopingSubmissionDate Constraints
2428
+
2429
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2430
+
2431
+ ### estimatedScopingSubmissionDate Examples
2432
+
2433
+ ```json
2434
+ "2023-07-27T20:30:00.000Z"
2435
+ ```
2436
+
2437
+ ## consultationMilestoneAdequacyDate
2438
+
2439
+ Adequacy of Consultation Milestone
2440
+
2441
+ `consultationMilestoneAdequacyDate`
2442
+
2443
+ * is optional
2444
+
2445
+ * Type: `string`
2446
+
2447
+ * can be null
2448
+
2449
+ * defined in: [NSIP Project](nsip-project-properties-consultationmilestoneadequacydate.md "nsip-project.schema.json#/properties/consultationMilestoneAdequacyDate")
2450
+
2451
+ ### consultationMilestoneAdequacyDate Type
2452
+
2453
+ `string`
2454
+
2455
+ ### consultationMilestoneAdequacyDate Constraints
2456
+
2457
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2458
+
2459
+ ### consultationMilestoneAdequacyDate Examples
2460
+
2461
+ ```json
2462
+ "2023-07-27T20:30:00.000Z"
2463
+ ```
2464
+
2465
+ ## planProcessEvidence
2466
+
2467
+ Evidence plan process
2468
+
2469
+ `planProcessEvidence`
2470
+
2471
+ * is optional
2472
+
2473
+ * Type: `boolean`
2474
+
2475
+ * can be null
2476
+
2477
+ * defined in: [NSIP Project](nsip-project-properties-planprocessevidence.md "nsip-project.schema.json#/properties/planProcessEvidence")
2478
+
2479
+ ### planProcessEvidence Type
2480
+
2481
+ `boolean`
2482
+
2483
+ ### planProcessEvidence Examples
2484
+
2485
+ ```json
2486
+ true
2487
+ ```
2488
+
2489
+ ## issuesTracker
2490
+
2491
+ Issues tracker
2492
+
2493
+ `issuesTracker`
2494
+
2495
+ * is optional
2496
+
2497
+ * Type: `string`
2498
+
2499
+ * can be null
2500
+
2501
+ * defined in: [NSIP Project](nsip-project-properties-issuestracker.md "nsip-project.schema.json#/properties/issuesTracker")
2502
+
2503
+ ### issuesTracker Type
2504
+
2505
+ `string`
2506
+
2507
+ ### issuesTracker Examples
2508
+
2509
+ ```json
2510
+ "tracker.sharepoint.com/"
2511
+ ```
2512
+
2513
+ ## essentialFastTrackComponents
2514
+
2515
+ Essential fast track components
2516
+
2517
+ `essentialFastTrackComponents`
2518
+
2519
+ * is optional
2520
+
2521
+ * Type: `boolean`
2522
+
2523
+ * can be null
2524
+
2525
+ * defined in: [NSIP Project](nsip-project-properties-essentialfasttrackcomponents.md "nsip-project.schema.json#/properties/essentialFastTrackComponents")
2526
+
2527
+ ### essentialFastTrackComponents Type
2528
+
2529
+ `boolean`
2530
+
2531
+ ### essentialFastTrackComponents Examples
2532
+
2533
+ ```json
2534
+ true
2535
+ ```
2536
+
2537
+ ## principalAreaDisagreementSummaryStmt
2538
+
2539
+ Principal area disagreement summary statement (PADSS)
2540
+
2541
+ `principalAreaDisagreementSummaryStmt`
2542
+
2543
+ * is optional
2544
+
2545
+ * Type: `string`
2546
+
2547
+ * can be null
2548
+
2549
+ * defined in: [NSIP Project](nsip-project-properties-principalareadisagreementsummarystmt.md "nsip-project.schema.json#/properties/principalAreaDisagreementSummaryStmt")
2550
+
2551
+ ### principalAreaDisagreementSummaryStmt Type
2552
+
2553
+ `string`
2554
+
2555
+ ### principalAreaDisagreementSummaryStmt Constraints
2556
+
2557
+ **enum**: the value of this property must be equal to one of the following values:
2558
+
2559
+ | Value | Explanation |
2560
+ | :------------------------- | :---------- |
2561
+ | `"submitted_by_applicant"` | |
2562
+ | `"awaiting_submission"` | |
2563
+ | `"not_applicable"` | |
2564
+ | `null` | |
2565
+
2566
+ ### principalAreaDisagreementSummaryStmt Examples
2567
+
2568
+ ```json
2569
+ "submitted_by_applicant"
2570
+ ```
2571
+
2572
+ ## principalAreaDisagreementSummaryStmtSubmittedDate
2573
+
2574
+ Principal area disagreement summary statement (PADSS) Submitted date
2575
+
2576
+ `principalAreaDisagreementSummaryStmtSubmittedDate`
2577
+
2578
+ * is optional
2579
+
2580
+ * Type: `string`
2581
+
2582
+ * can be null
2583
+
2584
+ * defined in: [NSIP Project](nsip-project-properties-principalareadisagreementsummarystmtsubmitteddate.md "nsip-project.schema.json#/properties/principalAreaDisagreementSummaryStmtSubmittedDate")
2585
+
2586
+ ### principalAreaDisagreementSummaryStmtSubmittedDate Type
2587
+
2588
+ `string`
2589
+
2590
+ ### principalAreaDisagreementSummaryStmtSubmittedDate Constraints
2591
+
2592
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2593
+
2594
+ ### principalAreaDisagreementSummaryStmtSubmittedDate Examples
2595
+
2596
+ ```json
2597
+ "2023-07-27T20:30:00.000Z"
2598
+ ```
2599
+
2600
+ ## policyComplianceDocument
2601
+
2602
+ Policy compliance document (PCD)
2603
+
2604
+ `policyComplianceDocument`
2605
+
2606
+ * is optional
2607
+
2608
+ * Type: `string`
2609
+
2610
+ * can be null
2611
+
2612
+ * defined in: [NSIP Project](nsip-project-properties-policycompliancedocument.md "nsip-project.schema.json#/properties/policyComplianceDocument")
2613
+
2614
+ ### policyComplianceDocument Type
2615
+
2616
+ `string`
2617
+
2618
+ ### policyComplianceDocument Constraints
2619
+
2620
+ **enum**: the value of this property must be equal to one of the following values:
2621
+
2622
+ | Value | Explanation |
2623
+ | :------------------------- | :---------- |
2624
+ | `"submitted_by_applicant"` | |
2625
+ | `"awaiting_submission"` | |
2626
+ | `"not_applicable"` | |
2627
+ | `null` | |
2628
+
2629
+ ### policyComplianceDocument Examples
2630
+
2631
+ ```json
2632
+ "submitted_by_applicant"
2633
+ ```
2634
+
2635
+ ## policyComplianceDocumentSubmittedDate
2636
+
2637
+ Policy compliance document (PCD) Submitted Date
2638
+
2639
+ `policyComplianceDocumentSubmittedDate`
2640
+
2641
+ * is optional
2642
+
2643
+ * Type: `string`
2644
+
2645
+ * can be null
2646
+
2647
+ * defined in: [NSIP Project](nsip-project-properties-policycompliancedocumentsubmitteddate.md "nsip-project.schema.json#/properties/policyComplianceDocumentSubmittedDate")
2648
+
2649
+ ### policyComplianceDocumentSubmittedDate Type
2650
+
2651
+ `string`
2652
+
2653
+ ### policyComplianceDocumentSubmittedDate Constraints
2654
+
2655
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2656
+
2657
+ ### policyComplianceDocumentSubmittedDate Examples
2658
+
2659
+ ```json
2660
+ "2023-07-27T20:30:00.000Z"
2661
+ ```
2662
+
2663
+ ## designApproachDocument
2664
+
2665
+ Design approach document (DAD)
2666
+
2667
+ `designApproachDocument`
2668
+
2669
+ * is optional
2670
+
2671
+ * Type: `string`
2672
+
2673
+ * can be null
2674
+
2675
+ * defined in: [NSIP Project](nsip-project-properties-designapproachdocument.md "nsip-project.schema.json#/properties/designApproachDocument")
2676
+
2677
+ ### designApproachDocument Type
2678
+
2679
+ `string`
2680
+
2681
+ ### designApproachDocument Constraints
2682
+
2683
+ **enum**: the value of this property must be equal to one of the following values:
2684
+
2685
+ | Value | Explanation |
2686
+ | :------------------------- | :---------- |
2687
+ | `"submitted_by_applicant"` | |
2688
+ | `"awaiting_submission"` | |
2689
+ | `"not_applicable"` | |
2690
+ | `null` | |
2691
+
2692
+ ### designApproachDocument Examples
2693
+
2694
+ ```json
2695
+ "submitted_by_applicant"
2696
+ ```
2697
+
2698
+ ## designApproachDocumentSubmittedDate
2699
+
2700
+ Design approach document (DAD) Submitted Date
2701
+
2702
+ `designApproachDocumentSubmittedDate`
2703
+
2704
+ * is optional
2705
+
2706
+ * Type: `string`
2707
+
2708
+ * can be null
2709
+
2710
+ * defined in: [NSIP Project](nsip-project-properties-designapproachdocumentsubmitteddate.md "nsip-project.schema.json#/properties/designApproachDocumentSubmittedDate")
2711
+
2712
+ ### designApproachDocumentSubmittedDate Type
2713
+
2714
+ `string`
2715
+
2716
+ ### designApproachDocumentSubmittedDate Constraints
2717
+
2718
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2719
+
2720
+ ### designApproachDocumentSubmittedDate Examples
2721
+
2722
+ ```json
2723
+ "2023-07-27T20:30:00.000Z"
2724
+ ```
2725
+
2726
+ ## matureOutlineControlDocument
2727
+
2728
+ Mature outline control documents
2729
+
2730
+ `matureOutlineControlDocument`
2731
+
2732
+ * is optional
2733
+
2734
+ * Type: `string`
2735
+
2736
+ * can be null
2737
+
2738
+ * defined in: [NSIP Project](nsip-project-properties-matureoutlinecontroldocument.md "nsip-project.schema.json#/properties/matureOutlineControlDocument")
2739
+
2740
+ ### matureOutlineControlDocument Type
2741
+
2742
+ `string`
2743
+
2744
+ ### matureOutlineControlDocument Constraints
2745
+
2746
+ **enum**: the value of this property must be equal to one of the following values:
2747
+
2748
+ | Value | Explanation |
2749
+ | :------------------------- | :---------- |
2750
+ | `"submitted_by_applicant"` | |
2751
+ | `"awaiting_submission"` | |
2752
+ | `"not_applicable"` | |
2753
+ | `null` | |
2754
+
2755
+ ### matureOutlineControlDocument Examples
2756
+
2757
+ ```json
2758
+ "submitted_by_applicant"
2759
+ ```
2760
+
2761
+ ## matureOutlineControlDocumentSubmittedDate
2762
+
2763
+ Mature outline control documents Submitted Date
2764
+
2765
+ `matureOutlineControlDocumentSubmittedDate`
2766
+
2767
+ * is optional
2768
+
2769
+ * Type: `string`
2770
+
2771
+ * can be null
2772
+
2773
+ * defined in: [NSIP Project](nsip-project-properties-matureoutlinecontroldocumentsubmitteddate.md "nsip-project.schema.json#/properties/matureOutlineControlDocumentSubmittedDate")
2774
+
2775
+ ### matureOutlineControlDocumentSubmittedDate Type
2776
+
2777
+ `string`
2778
+
2779
+ ### matureOutlineControlDocumentSubmittedDate Constraints
2780
+
2781
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2782
+
2783
+ ### matureOutlineControlDocumentSubmittedDate Examples
2784
+
2785
+ ```json
2786
+ "2023-07-27T20:30:00.000Z"
2787
+ ```
2788
+
2789
+ ## caAndTpEvidence
2790
+
2791
+ CA and TP evidence
2792
+
2793
+ `caAndTpEvidence`
2794
+
2795
+ * is optional
2796
+
2797
+ * Type: `string`
2798
+
2799
+ * can be null
2800
+
2801
+ * defined in: [NSIP Project](nsip-project-properties-caandtpevidence.md "nsip-project.schema.json#/properties/caAndTpEvidence")
2802
+
2803
+ ### caAndTpEvidence Type
2804
+
2805
+ `string`
2806
+
2807
+ ### caAndTpEvidence Constraints
2808
+
2809
+ **enum**: the value of this property must be equal to one of the following values:
2810
+
2811
+ | Value | Explanation |
2812
+ | :------------------------- | :---------- |
2813
+ | `"submitted_by_applicant"` | |
2814
+ | `"awaiting_submission"` | |
2815
+ | `"not_applicable"` | |
2816
+ | `null` | |
2817
+
2818
+ ### caAndTpEvidence Examples
2819
+
2820
+ ```json
2821
+ "submitted_by_applicant"
2822
+ ```
2823
+
2824
+ ## caAndTpEvidenceSubmittedDate
2825
+
2826
+ CA and TP evidence Submitted Date
2827
+
2828
+ `caAndTpEvidenceSubmittedDate`
2829
+
2830
+ * is optional
2831
+
2832
+ * Type: `string`
2833
+
2834
+ * can be null
2835
+
2836
+ * defined in: [NSIP Project](nsip-project-properties-caandtpevidencesubmitteddate.md "nsip-project.schema.json#/properties/caAndTpEvidenceSubmittedDate")
2837
+
2838
+ ### caAndTpEvidenceSubmittedDate Type
2839
+
2840
+ `string`
2841
+
2842
+ ### caAndTpEvidenceSubmittedDate Constraints
2843
+
2844
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2845
+
2846
+ ### caAndTpEvidenceSubmittedDate Examples
2847
+
2848
+ ```json
2849
+ "2023-07-27T20:30:00.000Z"
2850
+ ```
2851
+
2852
+ ## publicSectorEqualityDuty
2853
+
2854
+ Public sector equality duty (PSED)
2855
+
2856
+ `publicSectorEqualityDuty`
2857
+
2858
+ * is optional
2859
+
2860
+ * Type: `string`
2861
+
2862
+ * can be null
2863
+
2864
+ * defined in: [NSIP Project](nsip-project-properties-publicsectorequalityduty.md "nsip-project.schema.json#/properties/publicSectorEqualityDuty")
2865
+
2866
+ ### publicSectorEqualityDuty Type
2867
+
2868
+ `string`
2869
+
2870
+ ### publicSectorEqualityDuty Constraints
2871
+
2872
+ **enum**: the value of this property must be equal to one of the following values:
2873
+
2874
+ | Value | Explanation |
2875
+ | :------------------------- | :---------- |
2876
+ | `"submitted_by_applicant"` | |
2877
+ | `"awaiting_submission"` | |
2878
+ | `"not_applicable"` | |
2879
+ | `null` | |
2880
+
2881
+ ### publicSectorEqualityDuty Examples
2882
+
2883
+ ```json
2884
+ "submitted_by_applicant"
2885
+ ```
2886
+
2887
+ ## publicSectorEqualityDutySubmittedDate
2888
+
2889
+ Public sector equality duty (PSED) Submitted Date
2890
+
2891
+ `publicSectorEqualityDutySubmittedDate`
2892
+
2893
+ * is optional
2894
+
2895
+ * Type: `string`
2896
+
2897
+ * can be null
2898
+
2899
+ * defined in: [NSIP Project](nsip-project-properties-publicsectorequalitydutysubmitteddate.md "nsip-project.schema.json#/properties/publicSectorEqualityDutySubmittedDate")
2900
+
2901
+ ### publicSectorEqualityDutySubmittedDate Type
2902
+
2903
+ `string`
2904
+
2905
+ ### publicSectorEqualityDutySubmittedDate Constraints
2906
+
2907
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2908
+
2909
+ ### publicSectorEqualityDutySubmittedDate Examples
2910
+
2911
+ ```json
2912
+ "2023-07-27T20:30:00.000Z"
2913
+ ```
2914
+
2915
+ ## fastTrackAdmissionDocument
2916
+
2917
+ Fast track admission document
2918
+
2919
+ `fastTrackAdmissionDocument`
2920
+
2921
+ * is optional
2922
+
2923
+ * Type: `string`
2924
+
2925
+ * can be null
2926
+
2927
+ * defined in: [NSIP Project](nsip-project-properties-fasttrackadmissiondocument.md "nsip-project.schema.json#/properties/fastTrackAdmissionDocument")
2928
+
2929
+ ### fastTrackAdmissionDocument Type
2930
+
2931
+ `string`
2932
+
2933
+ ### fastTrackAdmissionDocument Constraints
2934
+
2935
+ **enum**: the value of this property must be equal to one of the following values:
2936
+
2937
+ | Value | Explanation |
2938
+ | :------------------------- | :---------- |
2939
+ | `"submitted_by_applicant"` | |
2940
+ | `"awaiting_submission"` | |
2941
+ | `"not_applicable"` | |
2942
+ | `null` | |
2943
+
2944
+ ### fastTrackAdmissionDocument Examples
2945
+
2946
+ ```json
2947
+ "submitted_by_applicant"
2948
+ ```
2949
+
2950
+ ## fastTrackAdmissionDocumentSubmittedDate
2951
+
2952
+ Fast track admission document Submitted Date
2953
+
2954
+ `fastTrackAdmissionDocumentSubmittedDate`
2955
+
2956
+ * is optional
2957
+
2958
+ * Type: `string`
2959
+
2960
+ * can be null
2961
+
2962
+ * defined in: [NSIP Project](nsip-project-properties-fasttrackadmissiondocumentsubmitteddate.md "nsip-project.schema.json#/properties/fastTrackAdmissionDocumentSubmittedDate")
2963
+
2964
+ ### fastTrackAdmissionDocumentSubmittedDate Type
2965
+
2966
+ `string`
2967
+
2968
+ ### fastTrackAdmissionDocumentSubmittedDate Constraints
2969
+
2970
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
2971
+
2972
+ ### fastTrackAdmissionDocumentSubmittedDate Examples
2973
+
2974
+ ```json
2975
+ "2023-07-27T20:30:00.000Z"
2976
+ ```
2977
+
2978
+ ## multipartyApplicationCheckDocument
2979
+
2980
+ Multiparty application readiness gate-check (trial)
2981
+
2982
+ `multipartyApplicationCheckDocument`
2983
+
2984
+ * is optional
2985
+
2986
+ * Type: `string`
2987
+
2988
+ * can be null
2989
+
2990
+ * defined in: [NSIP Project](nsip-project-properties-multipartyapplicationcheckdocument.md "nsip-project.schema.json#/properties/multipartyApplicationCheckDocument")
2991
+
2992
+ ### multipartyApplicationCheckDocument Type
2993
+
2994
+ `string`
2995
+
2996
+ ### multipartyApplicationCheckDocument Constraints
2997
+
2998
+ **enum**: the value of this property must be equal to one of the following values:
2999
+
3000
+ | Value | Explanation |
3001
+ | :------------------------- | :---------- |
3002
+ | `"submitted_by_applicant"` | |
3003
+ | `"awaiting_submission"` | |
3004
+ | `"not_applicable"` | |
3005
+ | `null` | |
3006
+
3007
+ ### multipartyApplicationCheckDocument Examples
3008
+
3009
+ ```json
3010
+ "submitted_by_applicant"
3011
+ ```
3012
+
3013
+ ## multipartyApplicationCheckDocumentSubmittedDate
3014
+
3015
+ Multiparty application readiness gate-check Submitted Date (trial)
3016
+
3017
+ `multipartyApplicationCheckDocumentSubmittedDate`
3018
+
3019
+ * is optional
3020
+
3021
+ * Type: `string`
3022
+
3023
+ * can be null
3024
+
3025
+ * defined in: [NSIP Project](nsip-project-properties-multipartyapplicationcheckdocumentsubmitteddate.md "nsip-project.schema.json#/properties/multipartyApplicationCheckDocumentSubmittedDate")
3026
+
3027
+ ### multipartyApplicationCheckDocumentSubmittedDate Type
3028
+
3029
+ `string`
3030
+
3031
+ ### multipartyApplicationCheckDocumentSubmittedDate Constraints
3032
+
3033
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3034
+
3035
+ ### multipartyApplicationCheckDocumentSubmittedDate Examples
3036
+
3037
+ ```json
3038
+ "2023-07-27T20:30:00.000Z"
3039
+ ```
3040
+
3041
+ ## programmeDocumentURI
3042
+
3043
+ Link to programme document
3044
+
3045
+ `programmeDocumentURI`
3046
+
3047
+ * is optional
3048
+
3049
+ * Type: `string`
3050
+
3051
+ * can be null
3052
+
3053
+ * defined in: [NSIP Project](nsip-project-properties-programmedocumenturi.md "nsip-project.schema.json#/properties/programmeDocumentURI")
3054
+
3055
+ ### programmeDocumentURI Type
3056
+
3057
+ `string`
3058
+
3059
+ ### programmeDocumentURI Examples
3060
+
3061
+ ```json
3062
+ "progdoc.sharepoint.com/"
3063
+ ```
3064
+
3065
+ ## updatedProgrammeDocumentReceivedDate
3066
+
3067
+ Date updated programme document is received
3068
+
3069
+ `updatedProgrammeDocumentReceivedDate`
3070
+
3071
+ * is optional
3072
+
3073
+ * Type: `string`
3074
+
3075
+ * can be null
3076
+
3077
+ * defined in: [NSIP Project](nsip-project-properties-updatedprogrammedocumentreceiveddate.md "nsip-project.schema.json#/properties/updatedProgrammeDocumentReceivedDate")
3078
+
3079
+ ### updatedProgrammeDocumentReceivedDate Type
3080
+
3081
+ `string`
3082
+
3083
+ ### updatedProgrammeDocumentReceivedDate Constraints
3084
+
3085
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3086
+
3087
+ ### updatedProgrammeDocumentReceivedDate Examples
3088
+
3089
+ ```json
3090
+ "2023-07-27T20:30:00.000Z"
3091
+ ```
3092
+
3093
+ ## programmeDocumentReviewedByEstDate
3094
+
3095
+ Date programme document reviewed by EST
3096
+
3097
+ `programmeDocumentReviewedByEstDate`
3098
+
3099
+ * is optional
3100
+
3101
+ * Type: `string`
3102
+
3103
+ * can be null
3104
+
3105
+ * defined in: [NSIP Project](nsip-project-properties-programmedocumentreviewedbyestdate.md "nsip-project.schema.json#/properties/programmeDocumentReviewedByEstDate")
3106
+
3107
+ ### programmeDocumentReviewedByEstDate Type
3108
+
3109
+ `string`
3110
+
3111
+ ### programmeDocumentReviewedByEstDate Constraints
3112
+
3113
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3114
+
3115
+ ### programmeDocumentReviewedByEstDate Examples
3116
+
3117
+ ```json
3118
+ "2023-07-27T20:30:00.000Z"
3119
+ ```
3120
+
3121
+ ## caseTeamIssuedCommentsDate
3122
+
3123
+ Date case team issued comments on programme document
3124
+
3125
+ `caseTeamIssuedCommentsDate`
3126
+
3127
+ * is optional
3128
+
3129
+ * Type: `string`
3130
+
3131
+ * can be null
3132
+
3133
+ * defined in: [NSIP Project](nsip-project-properties-caseteamissuedcommentsdate.md "nsip-project.schema.json#/properties/caseTeamIssuedCommentsDate")
3134
+
3135
+ ### caseTeamIssuedCommentsDate Type
3136
+
3137
+ `string`
3138
+
3139
+ ### caseTeamIssuedCommentsDate Constraints
3140
+
3141
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3142
+
3143
+ ### caseTeamIssuedCommentsDate Examples
3144
+
3145
+ ```json
3146
+ "2023-07-27T20:30:00.000Z"
3147
+ ```
3148
+
3149
+ ## subProjectType
3150
+
3151
+ Project type
3152
+
3153
+ `subProjectType`
3154
+
3155
+ * is optional
3156
+
3157
+ * Type: `string`
3158
+
3159
+ * can be null
3160
+
3161
+ * defined in: [NSIP Project](nsip-project-properties-subprojecttype.md "nsip-project.schema.json#/properties/subProjectType")
3162
+
3163
+ ### subProjectType Type
3164
+
3165
+ `string`
3166
+
3167
+ ### subProjectType Constraints
3168
+
3169
+ **enum**: the value of this property must be equal to one of the following values:
3170
+
3171
+ | Value | Explanation |
3172
+ | :------------------------- | :---------- |
3173
+ | `"energy_from_waste"` | |
3174
+ | `"gas_power_station"` | |
3175
+ | `"hydrogen_power_station"` | |
3176
+ | `"nuclear"` | |
3177
+ | `"offshore_wind"` | |
3178
+ | `"onshore_wind"` | |
3179
+ | `"solar"` | |
3180
+ | `null` | |
3181
+
3182
+ ### subProjectType Examples
3183
+
3184
+ ```json
3185
+ "solar"
3186
+ ```
3187
+
3188
+ ## newMaturity
3189
+
3190
+ New maturity
3191
+
3192
+ `newMaturity`
3193
+
3194
+ * is optional
3195
+
3196
+ * Type: `string`
3197
+
3198
+ * can be null
3199
+
3200
+ * defined in: [NSIP Project](nsip-project-properties-newmaturity.md "nsip-project.schema.json#/properties/newMaturity")
3201
+
3202
+ ### newMaturity Type
3203
+
3204
+ `string`
3205
+
3206
+ ### newMaturity Constraints
3207
+
3208
+ **enum**: the value of this property must be equal to one of the following values:
3209
+
3210
+ | Value | Explanation |
3211
+ | :----- | :---------- |
3212
+ | `"a"` | |
3213
+ | `"b"` | |
3214
+ | `"c"` | |
3215
+ | `"d"` | |
3216
+ | `"e"` | |
3217
+ | `"f"` | |
3218
+ | `"g"` | |
3219
+ | `null` | |
3220
+
3221
+ ### newMaturity Examples
3222
+
3223
+ ```json
3224
+ "a"
3225
+ ```
3226
+
3227
+ ## statutoryConsultationPeriodEndDate
3228
+
3229
+ Statutory consultation period end date
3230
+
3231
+ `statutoryConsultationPeriodEndDate`
3232
+
3233
+ * is optional
3234
+
3235
+ * Type: `string`
3236
+
3237
+ * can be null
3238
+
3239
+ * defined in: [NSIP Project](nsip-project-properties-statutoryconsultationperiodenddate.md "nsip-project.schema.json#/properties/statutoryConsultationPeriodEndDate")
3240
+
3241
+ ### statutoryConsultationPeriodEndDate Type
3242
+
3243
+ `string`
3244
+
3245
+ ### statutoryConsultationPeriodEndDate Constraints
3246
+
3247
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3248
+
3249
+ ### statutoryConsultationPeriodEndDate Examples
3250
+
3251
+ ```json
3252
+ "2023-07-27T20:30:00.000Z"
3253
+ ```
3254
+
3255
+ ## submissionOfDraftDocumentsDate
3256
+
3257
+ Date for submission of draft documents
3258
+
3259
+ `submissionOfDraftDocumentsDate`
3260
+
3261
+ * is optional
3262
+
3263
+ * Type: `string`
3264
+
3265
+ * can be null
3266
+
3267
+ * defined in: [NSIP Project](nsip-project-properties-submissionofdraftdocumentsdate.md "nsip-project.schema.json#/properties/submissionOfDraftDocumentsDate")
3268
+
3269
+ ### submissionOfDraftDocumentsDate Type
3270
+
3271
+ `string`
3272
+
3273
+ ### submissionOfDraftDocumentsDate Constraints
3274
+
3275
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3276
+
3277
+ ### submissionOfDraftDocumentsDate Examples
3278
+
3279
+ ```json
3280
+ "2023-07-27T20:30:00.000Z"
3281
+ ```
3282
+
3283
+ ## numberBand2Inspectors
3284
+
3285
+ Number of band 2 inspectors
3286
+
3287
+ `numberBand2Inspectors`
3288
+
3289
+ * is optional
3290
+
3291
+ * Type: `number`
3292
+
3293
+ * can be null
3294
+
3295
+ * defined in: [NSIP Project](nsip-project-properties-numberband2inspectors.md "nsip-project.schema.json#/properties/numberBand2Inspectors")
3296
+
3297
+ ### numberBand2Inspectors Type
3298
+
3299
+ `number`
3300
+
3301
+ ### numberBand2Inspectors Examples
3302
+
3303
+ ```json
3304
+ 1
3305
+ ```
3306
+
3307
+ ## numberBand3Inspectors
3308
+
3309
+ Number of band 3 inspectors
3310
+
3311
+ `numberBand3Inspectors`
3312
+
3313
+ * is optional
3314
+
3315
+ * Type: `number`
3316
+
3317
+ * can be null
3318
+
3319
+ * defined in: [NSIP Project](nsip-project-properties-numberband3inspectors.md "nsip-project.schema.json#/properties/numberBand3Inspectors")
3320
+
3321
+ ### numberBand3Inspectors Type
3322
+
3323
+ `number`
3324
+
3325
+ ### numberBand3Inspectors Examples
3326
+
3327
+ ```json
3328
+ 2
3329
+ ```
3330
+
3331
+ ## memLastUpdated
3332
+
3333
+ MEM (last updated)
3334
+
3335
+ `memLastUpdated`
3336
+
3337
+ * is optional
3338
+
3339
+ * Type: `string`
3340
+
3341
+ * can be null
3342
+
3343
+ * defined in: [NSIP Project](nsip-project-properties-memlastupdated.md "nsip-project.schema.json#/properties/memLastUpdated")
3344
+
3345
+ ### memLastUpdated Type
3346
+
3347
+ `string`
3348
+
3349
+ ### memLastUpdated Constraints
3350
+
3351
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3352
+
3353
+ ### memLastUpdated Examples
3354
+
3355
+ ```json
3356
+ "2023-07-27T20:30:00.000Z"
3357
+ ```
3358
+
3359
+ ## additionalComments
3360
+
3361
+ Additional comments
3362
+
3363
+ `additionalComments`
3364
+
3365
+ * is optional
3366
+
3367
+ * Type: `string`
3368
+
3369
+ * can be null
3370
+
3371
+ * defined in: [NSIP Project](nsip-project-properties-additionalcomments.md "nsip-project.schema.json#/properties/additionalComments")
3372
+
3373
+ ### additionalComments Type
3374
+
3375
+ `string`
3376
+
3377
+ ### additionalComments Examples
3378
+
3379
+ ```json
3380
+ "Very likely to change tier from standard to basic after April 2025"
3381
+ ```
3382
+
3383
+ ## operationsLeadIds
3384
+
3385
+ Maps to \[Employee].\[EmployeeID].
3386
+
3387
+ `operationsLeadIds`
3388
+
3389
+ * is optional
3390
+
3391
+ * Type: `string[]`
3392
+
3393
+ * cannot be null
3394
+
3395
+ * defined in: [NSIP Project](nsip-project-properties-operationsleadids.md "nsip-project.schema.json#/properties/operationsLeadIds")
3396
+
3397
+ ### operationsLeadIds Type
3398
+
3399
+ `string[]`
3400
+
3401
+ ### operationsLeadIds Examples
3402
+
3403
+ ```json
3404
+ [
3405
+ "9bee96d2-00fe-4269-9d01-8c66",
3406
+ "9bee96d2-00fe-4269-9d01-8c22"
3407
+ ]
3408
+ ```
3409
+
3410
+ ## operationsManagerIds
3411
+
3412
+ New NSIP role, Maps to \[Employee].\[EmployeeID]
3413
+
3414
+ `operationsManagerIds`
3415
+
3416
+ * is optional
3417
+
3418
+ * Type: `string[]`
3419
+
3420
+ * cannot be null
3421
+
3422
+ * defined in: [NSIP Project](nsip-project-properties-operationsmanagerids.md "nsip-project.schema.json#/properties/operationsManagerIds")
3423
+
3424
+ ### operationsManagerIds Type
3425
+
3426
+ `string[]`
3427
+
3428
+ ### operationsManagerIds Examples
3429
+
3430
+ ```json
3431
+ [
3432
+ "9bee96d2-00fe-4269-9d01-8c66",
3433
+ "9bee96d2-00fe-4269-9d01-8c22"
3434
+ ]
3435
+ ```
3436
+
3437
+ ## caseManagerIds
3438
+
3439
+ Maps to \[Employee].\[EmployeeID].
3440
+
3441
+ `caseManagerIds`
3442
+
3443
+ * is optional
3444
+
3445
+ * Type: `string[]`
3446
+
3447
+ * cannot be null
3448
+
3449
+ * defined in: [NSIP Project](nsip-project-properties-casemanagerids.md "nsip-project.schema.json#/properties/caseManagerIds")
3450
+
3451
+ ### caseManagerIds Type
3452
+
3453
+ `string[]`
3454
+
3455
+ ### caseManagerIds Examples
3456
+
3457
+ ```json
3458
+ [
3459
+ "9bee96d2-00fe-4269-9d01-8c66",
3460
+ "9bee96d2-00fe-4269-9d01-8c22"
3461
+ ]
3462
+ ```
3463
+
3464
+ ## leadInspectorIds
3465
+
3466
+ Maps to \[Employee].\[EmployeeID].
3467
+
3468
+ `leadInspectorIds`
3469
+
3470
+ * is optional
3471
+
3472
+ * Type: `string[]`
3473
+
3474
+ * cannot be null
3475
+
3476
+ * defined in: [NSIP Project](nsip-project-properties-leadinspectorids.md "nsip-project.schema.json#/properties/leadInspectorIds")
3477
+
3478
+ ### leadInspectorIds Type
3479
+
3480
+ `string[]`
3481
+
3482
+ ### leadInspectorIds Examples
3483
+
3484
+ ```json
3485
+ [
3486
+ "9bee96d2-00fe-4269-9d01-8c66",
3487
+ "9bee96d2-00fe-4269-9d01-8c22"
3488
+ ]
3489
+ ```
3490
+
3491
+ ## environmentalServicesOfficerIds
3492
+
3493
+ Maps to \[Employee].\[EmployeeID].
3494
+
3495
+ `environmentalServicesOfficerIds`
3496
+
3497
+ * is optional
3498
+
3499
+ * Type: `string[]`
3500
+
3501
+ * cannot be null
3502
+
3503
+ * defined in: [NSIP Project](nsip-project-properties-environmentalservicesofficerids.md "nsip-project.schema.json#/properties/environmentalServicesOfficerIds")
3504
+
3505
+ ### environmentalServicesOfficerIds Type
3506
+
3507
+ `string[]`
3508
+
3509
+ ### environmentalServicesOfficerIds Examples
3510
+
3511
+ ```json
3512
+ [
3513
+ "9bee96d2-00fe-4269-9d01-8c66",
3514
+ "9bee96d2-00fe-4269-9d01-8c22"
3515
+ ]
3516
+ ```
3517
+
3518
+ ## legalOfficerIds
3519
+
3520
+ Maps to \[Employee].\[EmployeeID].
3521
+
3522
+ `legalOfficerIds`
3523
+
3524
+ * is optional
3525
+
3526
+ * Type: `string[]`
3527
+
3528
+ * cannot be null
3529
+
3530
+ * defined in: [NSIP Project](nsip-project-properties-legalofficerids.md "nsip-project.schema.json#/properties/legalOfficerIds")
3531
+
3532
+ ### legalOfficerIds Type
3533
+
3534
+ `string[]`
3535
+
3536
+ ### legalOfficerIds Examples
3537
+
3538
+ ```json
3539
+ [
3540
+ "9bee96d2-00fe-4269-9d01-8c66",
3541
+ "9bee96d2-00fe-4269-9d01-8c22"
3542
+ ]
3543
+ ```
3544
+
3545
+ ## meetings
3546
+
3547
+ Collection of meetings associated with this project
3548
+
3549
+ `meetings`
3550
+
3551
+ * is optional
3552
+
3553
+ * Type: `object[]` ([Details](nsip-project-defs-meeting.md))
3554
+
3555
+ * cannot be null
3556
+
3557
+ * defined in: [NSIP Project](nsip-project-properties-meetings.md "nsip-project.schema.json#/properties/meetings")
3558
+
3559
+ ### meetings Type
3560
+
3561
+ `object[]` ([Details](nsip-project-defs-meeting.md))
3562
+
3563
+ ## invoices
3564
+
3565
+ Collection of invoices associated with this project
3566
+
3567
+ `invoices`
3568
+
3569
+ * is optional
3570
+
3571
+ * Type: `object[]` ([Details](nsip-project-defs-invoice.md))
3572
+
3573
+ * cannot be null
3574
+
3575
+ * defined in: [NSIP Project](nsip-project-properties-invoices.md "nsip-project.schema.json#/properties/invoices")
3576
+
3577
+ ### invoices Type
3578
+
3579
+ `object[]` ([Details](nsip-project-defs-invoice.md))
3580
+
2096
3581
  ## Additional Properties
2097
3582
 
2098
3583
  Additional properties are allowed and do not have to follow a specific schema
3584
+
3585
+ # NSIP Project Definitions
3586
+
3587
+ ## Definitions group meeting
3588
+
3589
+ Reference this group by using
3590
+
3591
+ ```json
3592
+ {"$ref":"nsip-project.schema.json#/$defs/meeting"}
3593
+ ```
3594
+
3595
+ | Property | Type | Required | Nullable | Defined by |
3596
+ | :---------------------------------------------------- | :------- | :------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3597
+ | [meetingAgenda](#meetingagenda) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda") |
3598
+ | [planningInspectorateRole](#planninginspectoraterole) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole") |
3599
+ | [meetingDate](#meetingdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate") |
3600
+ | [meetingType](#meetingtype) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType") |
3601
+ | Additional Properties | Any | Optional | can be null | |
3602
+
3603
+ ### meetingAgenda
3604
+
3605
+ Meeting agenda
3606
+
3607
+ `meetingAgenda`
3608
+
3609
+ * is optional
3610
+
3611
+ * Type: `string`
3612
+
3613
+ * can be null
3614
+
3615
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingagenda.md "nsip-project.schema.json#/$defs/meeting/properties/meetingAgenda")
3616
+
3617
+ #### meetingAgenda Type
3618
+
3619
+ `string`
3620
+
3621
+ #### meetingAgenda Examples
3622
+
3623
+ ```json
3624
+ "Flood Risk Assessment (FRA)"
3625
+ ```
3626
+
3627
+ ### planningInspectorateRole
3628
+
3629
+ Planning Inspectorate role
3630
+
3631
+ `planningInspectorateRole`
3632
+
3633
+ * is optional
3634
+
3635
+ * Type: `string`
3636
+
3637
+ * can be null
3638
+
3639
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-planninginspectoraterole.md "nsip-project.schema.json#/$defs/meeting/properties/planningInspectorateRole")
3640
+
3641
+ #### planningInspectorateRole Type
3642
+
3643
+ `string`
3644
+
3645
+ #### planningInspectorateRole Constraints
3646
+
3647
+ **enum**: the value of this property must be equal to one of the following values:
3648
+
3649
+ | Value | Explanation |
3650
+ | :-------------- | :---------- |
3651
+ | `"facilitator"` | |
3652
+ | `"advisor"` | |
3653
+ | `"observer"` | |
3654
+ | `null` | |
3655
+
3656
+ #### planningInspectorateRole Examples
3657
+
3658
+ ```json
3659
+ "facilitator"
3660
+ ```
3661
+
3662
+ ### meetingDate
3663
+
3664
+ Meeting date
3665
+
3666
+ `meetingDate`
3667
+
3668
+ * is optional
3669
+
3670
+ * Type: `string`
3671
+
3672
+ * can be null
3673
+
3674
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingdate.md "nsip-project.schema.json#/$defs/meeting/properties/meetingDate")
3675
+
3676
+ #### meetingDate Type
3677
+
3678
+ `string`
3679
+
3680
+ #### meetingDate Constraints
3681
+
3682
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3683
+
3684
+ #### meetingDate Examples
3685
+
3686
+ ```json
3687
+ "2023-07-27T20:30:00.000Z"
3688
+ ```
3689
+
3690
+ ### meetingType
3691
+
3692
+ Type of Meeting
3693
+
3694
+ `meetingType`
3695
+
3696
+ * is optional
3697
+
3698
+ * Type: `string`
3699
+
3700
+ * can be null
3701
+
3702
+ * defined in: [NSIP Project](nsip-project-defs-meeting-properties-meetingtype.md "nsip-project.schema.json#/$defs/meeting/properties/meetingType")
3703
+
3704
+ #### meetingType Type
3705
+
3706
+ `string`
3707
+
3708
+ ### Additional Properties
3709
+
3710
+ Additional properties are allowed and do not have to follow a specific schema
3711
+
3712
+ ## Definitions group invoice
3713
+
3714
+ Reference this group by using
3715
+
3716
+ ```json
3717
+ {"$ref":"nsip-project.schema.json#/$defs/invoice"}
3718
+ ```
3719
+
3720
+ | Property | Type | Required | Nullable | Defined by |
3721
+ | :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
3722
+ | [invoiceStage](#invoicestage) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
3723
+ | [invoiceNumber](#invoicenumber) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber") |
3724
+ | [amountDue](#amountdue) | `number` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
3725
+ | [paymentDueDate](#paymentduedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate") |
3726
+ | [invoicedDate](#invoiceddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate") |
3727
+ | [paymentDate](#paymentdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate") |
3728
+ | [refundCreditNoteNumber](#refundcreditnotenumber) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-refundcreditnotenumber.md "nsip-project.schema.json#/$defs/invoice/properties/refundCreditNoteNumber") |
3729
+ | [refundAmount](#refundamount) | `number` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-refundamount.md "nsip-project.schema.json#/$defs/invoice/properties/refundAmount") |
3730
+ | [refundIssueDate](#refundissuedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-refundissuedate.md "nsip-project.schema.json#/$defs/invoice/properties/refundIssueDate") |
3731
+ | Additional Properties | Any | Optional | can be null | |
3732
+
3733
+ ### invoiceStage
3734
+
3735
+ Invoice stage
3736
+
3737
+ `invoiceStage`
3738
+
3739
+ * is optional
3740
+
3741
+ * Type: `string`
3742
+
3743
+ * can be null
3744
+
3745
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")
3746
+
3747
+ #### invoiceStage Type
3748
+
3749
+ `string`
3750
+
3751
+ #### invoiceStage Constraints
3752
+
3753
+ **enum**: the value of this property must be equal to one of the following values:
3754
+
3755
+ | Value | Explanation |
3756
+ | :---------------------- | :---------- |
3757
+ | `"pre_acceptance"` | |
3758
+ | `"acceptance"` | |
3759
+ | `"pre_examination"` | |
3760
+ | `"initial_examination"` | |
3761
+ | `"final_examination"` | |
3762
+ | `null` | |
3763
+
3764
+ #### invoiceStage Examples
3765
+
3766
+ ```json
3767
+ "pre_acceptance"
3768
+ ```
3769
+
3770
+ ### invoiceNumber
3771
+
3772
+ Invoice number
3773
+
3774
+ `invoiceNumber`
3775
+
3776
+ * is required
3777
+
3778
+ * Type: `string`
3779
+
3780
+ * cannot be null
3781
+
3782
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber")
3783
+
3784
+ #### invoiceNumber Type
3785
+
3786
+ `string`
3787
+
3788
+ #### invoiceNumber Examples
3789
+
3790
+ ```json
3791
+ "1800004419"
3792
+ ```
3793
+
3794
+ ### amountDue
3795
+
3796
+ Amount due
3797
+
3798
+ `amountDue`
3799
+
3800
+ * is required
3801
+
3802
+ * Type: `number`
3803
+
3804
+ * cannot be null
3805
+
3806
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")
3807
+
3808
+ #### amountDue Type
3809
+
3810
+ `number`
3811
+
3812
+ #### amountDue Examples
3813
+
3814
+ ```json
3815
+ 500
3816
+ ```
3817
+
3818
+ ### paymentDueDate
3819
+
3820
+ Payment due date
3821
+
3822
+ `paymentDueDate`
3823
+
3824
+ * is optional
3825
+
3826
+ * Type: `string`
3827
+
3828
+ * can be null
3829
+
3830
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate")
3831
+
3832
+ #### paymentDueDate Type
3833
+
3834
+ `string`
3835
+
3836
+ #### paymentDueDate Constraints
3837
+
3838
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3839
+
3840
+ #### paymentDueDate Examples
3841
+
3842
+ ```json
3843
+ "2023-07-27T20:30:00.000Z"
3844
+ ```
3845
+
3846
+ ### invoicedDate
3847
+
3848
+ Invoiced date
3849
+
3850
+ `invoicedDate`
3851
+
3852
+ * is optional
3853
+
3854
+ * Type: `string`
3855
+
3856
+ * can be null
3857
+
3858
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate")
3859
+
3860
+ #### invoicedDate Type
3861
+
3862
+ `string`
3863
+
3864
+ #### invoicedDate Constraints
3865
+
3866
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3867
+
3868
+ #### invoicedDate Examples
3869
+
3870
+ ```json
3871
+ "2023-07-27T20:30:00.000Z"
3872
+ ```
3873
+
3874
+ ### paymentDate
3875
+
3876
+ Date of payment
3877
+
3878
+ `paymentDate`
3879
+
3880
+ * is optional
3881
+
3882
+ * Type: `string`
3883
+
3884
+ * can be null
3885
+
3886
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate")
3887
+
3888
+ #### paymentDate Type
3889
+
3890
+ `string`
3891
+
3892
+ #### paymentDate Constraints
3893
+
3894
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3895
+
3896
+ #### paymentDate Examples
3897
+
3898
+ ```json
3899
+ "2023-07-27T20:30:00.000Z"
3900
+ ```
3901
+
3902
+ ### refundCreditNoteNumber
3903
+
3904
+ Refund credit note number
3905
+
3906
+ `refundCreditNoteNumber`
3907
+
3908
+ * is optional
3909
+
3910
+ * Type: `string`
3911
+
3912
+ * can be null
3913
+
3914
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundcreditnotenumber.md "nsip-project.schema.json#/$defs/invoice/properties/refundCreditNoteNumber")
3915
+
3916
+ #### refundCreditNoteNumber Type
3917
+
3918
+ `string`
3919
+
3920
+ #### refundCreditNoteNumber Examples
3921
+
3922
+ ```json
3923
+ "1800004419"
3924
+ ```
3925
+
3926
+ ### refundAmount
3927
+
3928
+ Amount refunded
3929
+
3930
+ `refundAmount`
3931
+
3932
+ * is optional
3933
+
3934
+ * Type: `number`
3935
+
3936
+ * can be null
3937
+
3938
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundamount.md "nsip-project.schema.json#/$defs/invoice/properties/refundAmount")
3939
+
3940
+ #### refundAmount Type
3941
+
3942
+ `number`
3943
+
3944
+ #### refundAmount Examples
3945
+
3946
+ ```json
3947
+ 200
3948
+ ```
3949
+
3950
+ ### refundIssueDate
3951
+
3952
+ Refund issue date
3953
+
3954
+ `refundIssueDate`
3955
+
3956
+ * is optional
3957
+
3958
+ * Type: `string`
3959
+
3960
+ * can be null
3961
+
3962
+ * defined in: [NSIP Project](nsip-project-defs-invoice-properties-refundissuedate.md "nsip-project.schema.json#/$defs/invoice/properties/refundIssueDate")
3963
+
3964
+ #### refundIssueDate Type
3965
+
3966
+ `string`
3967
+
3968
+ #### refundIssueDate Constraints
3969
+
3970
+ **date time**: the string must be a date time string, according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339 "check the specification")
3971
+
3972
+ #### refundIssueDate Examples
3973
+
3974
+ ```json
3975
+ "2023-07-27T20:30:00.000Z"
3976
+ ```
3977
+
3978
+ ### Additional Properties
3979
+
3980
+ Additional properties are allowed and do not have to follow a specific schema