@planning-inspectorate/data-model 2.1.0 → 2.2.0

package/docs/README.md

@@ -30,6 +30,10 @@
 
 * [NSIP Document](./nsip-document.md "NSIP document schema") – `nsip-document.schema.json`
 
+* [NSIP Invoice](./nsip-invoice.md "NSIP Standalone Invoice Schema for ODW Curated layer") – `nsip-invoice.schema.json`
+
+* [NSIP Meeting](./nsip-meeting.md "NSIP Standalone Meeting Schema for ODW Curated layer") – `nsip-meeting.schema.json`
+
 * [NSIP Project](./nsip-project.md "Subset of Pins Data Model \[Case]") – `nsip-project.schema.json`
 
 * [NSIP Project Update](./nsip-project-update.md "NSIP Project Update (formerly known as Banners)") – `nsip-project-update.schema.json`

package/docs/nsip-invoice.md

@@ -0,0 +1,317 @@
+## NSIP Invoice Type
+
+`object` ([NSIP Invoice](nsip-invoice.md))
+
+# NSIP Invoice Properties
+
+| Property                                          | Type      | Required | Nullable       | Defined by                                                                                                                      |
+| :------------------------------------------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------ |
+| [caseId](#caseid)                                 | `integer` | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-caseid.md "nsip-invoice.schema.json#/properties/caseId")                                 |
+| [caseReference](#casereference)                   | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")                   |
+| [invoiceStage](#invoicestage)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")                     |
+| [invoiceNumber](#invoicenumber)                   | `string`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-invoicenumber.md "nsip-invoice.schema.json#/properties/invoiceNumber")                   |
+| [amountDue](#amountdue)                           | `number`  | Required | cannot be null | [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")                           |
+| [paymentDueDate](#paymentduedate)                 | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")                 |
+| [invoicedDate](#invoiceddate)                     | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")                     |
+| [paymentDate](#paymentdate)                       | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")                       |
+| [refundCreditNoteNumber](#refundcreditnotenumber) | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber") |
+| [refundAmount](#refundamount)                     | `number`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")                     |
+| [refundIssueDate](#refundissuedate)               | `string`  | Required | can be null    | [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")               |
+| Additional Properties                             | Any       | Optional | can be null    |                                                                                                                                 |
+
+## caseId
+
+The unique identifier within the Back Office. This is not the same as the case reference
+
+`caseId`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-caseid.md "nsip-invoice.schema.json#/properties/caseId")
+
+### caseId Type
+
+`integer`
+
+### caseId Examples
+
+```json
+1242
+```
+
+## caseReference
+
+
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+### caseReference Examples
+
+```json
+"BC0510001"
+```
+
+## invoiceStage
+
+Invoice stage
+
+`invoiceStage`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")
+
+### invoiceStage Type
+
+`string`
+
+### invoiceStage Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value                   | Explanation |
+| :---------------------- | :---------- |
+| `"pre_acceptance"`      |             |
+| `"acceptance"`          |             |
+| `"pre_examination"`     |             |
+| `"initial_examination"` |             |
+| `"final_examination"`   |             |
+| `null`                  |             |
+
+### invoiceStage Examples
+
+```json
+"pre_acceptance"
+```
+
+## invoiceNumber
+
+Invoice number
+
+`invoiceNumber`
+
+* is required
+
+* Type: `string`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoicenumber.md "nsip-invoice.schema.json#/properties/invoiceNumber")
+
+### invoiceNumber Type
+
+`string`
+
+### invoiceNumber Examples
+
+```json
+"1800004419"
+```
+
+## amountDue
+
+Amount due
+
+`amountDue`
+
+* is required
+
+* Type: `number`
+
+* cannot be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")
+
+### amountDue Type
+
+`number`
+
+### amountDue Examples
+
+```json
+500
+```
+
+## paymentDueDate
+
+Payment due date
+
+`paymentDueDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")
+
+### paymentDueDate Type
+
+`string`
+
+### paymentDueDate Constraints
+
+**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")
+
+### paymentDueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## invoicedDate
+
+Invoiced date
+
+`invoicedDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")
+
+### invoicedDate Type
+
+`string`
+
+### invoicedDate Constraints
+
+**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")
+
+### invoicedDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## paymentDate
+
+Date of payment
+
+`paymentDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")
+
+### paymentDate Type
+
+`string`
+
+### paymentDate Constraints
+
+**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")
+
+### paymentDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## refundCreditNoteNumber
+
+Refund credit note number
+
+`refundCreditNoteNumber`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber")
+
+### refundCreditNoteNumber Type
+
+`string`
+
+### refundCreditNoteNumber Examples
+
+```json
+"1800004419"
+```
+
+## refundAmount
+
+Amount refunded
+
+`refundAmount`
+
+* is required
+
+* Type: `number`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")
+
+### refundAmount Type
+
+`number`
+
+### refundAmount Examples
+
+```json
+200
+```
+
+## refundIssueDate
+
+Refund issue date
+
+`refundIssueDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")
+
+### refundIssueDate Type
+
+`string`
+
+### refundIssueDate Constraints
+
+**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")
+
+### refundIssueDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/docs/nsip-meeting.md

@@ -0,0 +1,197 @@
+## NSIP Meeting Type
+
+`object` ([NSIP Meeting](nsip-meeting.md))
+
+# NSIP Meeting Properties
+
+| Property                                              | Type      | Required | Nullable       | Defined by                                                                                                                          |
+| :---------------------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
+| [meetingID](#meetingid)                               | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-meetingid.md "nsip-meeting.schema.json#/properties/meetingID")                               |
+| [caseId](#caseid)                                     | `integer` | Required | cannot be null | [NSIP Meeting](nsip-meeting-properties-caseid.md "nsip-meeting.schema.json#/properties/caseId")                                     |
+| [caseReference](#casereference)                       | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-casereference.md "nsip-meeting.schema.json#/properties/caseReference")                       |
+| [meetingAgenda](#meetingagenda)                       | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingagenda.md "nsip-meeting.schema.json#/properties/meetingAgenda")                       |
+| [planningInspectorateRole](#planninginspectoraterole) | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-planninginspectoraterole.md "nsip-meeting.schema.json#/properties/planningInspectorateRole") |
+| [meetingDate](#meetingdate)                           | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingdate.md "nsip-meeting.schema.json#/properties/meetingDate")                           |
+| [meetingType](#meetingtype)                           | `string`  | Required | can be null    | [NSIP Meeting](nsip-meeting-properties-meetingtype.md "nsip-meeting.schema.json#/properties/meetingType")                           |
+| Additional Properties                                 | Any       | Optional | can be null    |                                                                                                                                     |
+
+## meetingID
+
+The unique identifier for an NSIP Meeting.
+
+`meetingID`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingid.md "nsip-meeting.schema.json#/properties/meetingID")
+
+### meetingID Type
+
+`integer`
+
+### meetingID Examples
+
+```json
+1234
+```
+
+## caseId
+
+The unique identifier for the case within the Back Office. This is not the same as the case reference
+
+`caseId`
+
+* is required
+
+* Type: `integer`
+
+* cannot be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-caseid.md "nsip-meeting.schema.json#/properties/caseId")
+
+### caseId Type
+
+`integer`
+
+### caseId Examples
+
+```json
+1242
+```
+
+## caseReference
+
+
+
+`caseReference`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-casereference.md "nsip-meeting.schema.json#/properties/caseReference")
+
+### caseReference Type
+
+`string`
+
+### caseReference Examples
+
+```json
+"BC0510001"
+```
+
+## meetingAgenda
+
+Meeting agenda
+
+`meetingAgenda`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingagenda.md "nsip-meeting.schema.json#/properties/meetingAgenda")
+
+### meetingAgenda Type
+
+`string`
+
+### meetingAgenda Examples
+
+```json
+"Flood Risk Assessment (FRA)"
+```
+
+## planningInspectorateRole
+
+Planning Inspectorate role
+
+`planningInspectorateRole`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-planninginspectoraterole.md "nsip-meeting.schema.json#/properties/planningInspectorateRole")
+
+### planningInspectorateRole Type
+
+`string`
+
+### planningInspectorateRole Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value           | Explanation |
+| :-------------- | :---------- |
+| `"facilitator"` |             |
+| `"advisor"`     |             |
+| `"observer"`    |             |
+| `null`          |             |
+
+### planningInspectorateRole Examples
+
+```json
+"facilitator"
+```
+
+## meetingDate
+
+Meeting date
+
+`meetingDate`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingdate.md "nsip-meeting.schema.json#/properties/meetingDate")
+
+### meetingDate Type
+
+`string`
+
+### meetingDate Constraints
+
+**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")
+
+### meetingDate Examples
+
+```json
+"2023-07-27T20:30:00.000Z"
+```
+
+## meetingType
+
+Type of Meeting
+
+`meetingType`
+
+* is required
+
+* Type: `string`
+
+* can be null
+
+* defined in: [NSIP Meeting](nsip-meeting-properties-meetingtype.md "nsip-meeting.schema.json#/properties/meetingType")
+
+### meetingType Type
+
+`string`
+
+## Additional Properties
+
+Additional properties are allowed and do not have to follow a specific schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "JSON Schemas for the Planning Inspectorate's Data Model",
   "main": "src/index.js",
   "type": "module",

package/pins_data_model/models/model_nsip_invoice.py

@@ -0,0 +1,81 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-invoice.schema.json
+#   timestamp: 2025-11-12T16:26:57+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class InvoiceStage(Enum):
+    """
+    Invoice stage
+    """
+
+    pre_acceptance = "pre_acceptance"
+    acceptance = "acceptance"
+    pre_examination = "pre_examination"
+    initial_examination = "initial_examination"
+    final_examination = "final_examination"
+    NoneType_None = None
+
+
+class NsipInvoice(BaseModel):
+    """
+    NSIP Standalone Invoice Schema for ODW Curated layer
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    caseId: int = Field(..., examples=[1242])
+    """
+    The unique identifier within the Back Office. This is not the same as the case reference
+    """
+    caseReference: str | None = Field(..., examples=["BC0510001"])
+    invoiceStage: InvoiceStage | None = Field(..., examples=["pre_acceptance"])
+    """
+    Invoice stage
+    """
+    invoiceNumber: str = Field(..., examples=["1800004419"])
+    """
+    Invoice number
+    """
+    amountDue: float = Field(..., examples=[500])
+    """
+    Amount due
+    """
+    paymentDueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Payment due date
+    """
+    invoicedDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Invoiced date
+    """
+    paymentDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Date of payment
+    """
+    refundCreditNoteNumber: str | None = Field(..., examples=["1800004419"])
+    """
+    Refund credit note number
+    """
+    refundAmount: float | None = Field(..., examples=[200])
+    """
+    Amount refunded
+    """
+    refundIssueDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Refund issue date
+    """

package/pins_data_model/models/model_nsip_meeting.py

@@ -0,0 +1,59 @@
+# generated by datamodel-codegen:
+#   filename:  nsip-meeting.schema.json
+#   timestamp: 2025-11-12T16:26:57+00:00
+
+from __future__ import annotations
+
+from enum import Enum
+
+from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
+
+
+class PlanningInspectorateRole(Enum):
+    """
+    Planning Inspectorate role
+    """
+
+    facilitator = "facilitator"
+    advisor = "advisor"
+    observer = "observer"
+    NoneType_None = None
+
+
+class NsipMeeting(BaseModel):
+    """
+    NSIP Standalone Meeting Schema for ODW Curated layer
+    """
+
+    model_config = ConfigDict(
+        extra="allow",
+    )
+    meetingID: int = Field(..., examples=[1234])
+    """
+    The unique identifier for an NSIP Meeting.
+    """
+    caseId: int = Field(..., examples=[1242])
+    """
+    The unique identifier for the case within the Back Office. This is not the same as the case reference
+    """
+    caseReference: str | None = Field(..., examples=["BC0510001"])
+    meetingAgenda: str | None = Field(..., examples=["Flood Risk Assessment (FRA)"])
+    """
+    Meeting agenda
+    """
+    planningInspectorateRole: PlanningInspectorateRole | None = Field(
+        ..., examples=["facilitator"]
+    )
+    """
+    Planning Inspectorate role
+    """
+    meetingDate: AwareDatetime | None = Field(
+        ..., examples=["2023-07-27T20:30:00.000Z"]
+    )
+    """
+    Meeting date
+    """
+    meetingType: str | None = None
+    """
+    Type of Meeting
+    """

package/schemas/nsip-invoice.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-invoice.schema.json",
+  "title": "NSIP Invoice",
+  "description": "NSIP Standalone Invoice Schema for ODW Curated layer",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "caseId",
+    "caseReference",
+    "invoiceStage",
+    "invoiceNumber",
+    "amountDue",
+    "paymentDueDate",
+    "invoicedDate",
+    "paymentDate",
+    "refundCreditNoteNumber",
+    "refundAmount",
+    "refundIssueDate"
+  ],
+  "properties": {
+    "caseId": {
+      "type": "integer",
+      "examples": [1242],
+      "description": "The unique identifier within the Back Office. This is not the same as the case reference"
+    },
+    "caseReference": {
+      "type": ["string", "null"],
+      "examples": ["BC0510001"]
+    },
+    "invoiceStage": {
+      "type": ["string", "null"],
+      "description": "Invoice stage",
+      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination", null],
+      "examples": ["pre_acceptance"]
+    },
+    "invoiceNumber": {
+      "type": "string",
+      "description": "Invoice number",
+      "examples": ["1800004419"]
+    },
+    "amountDue": {
+      "type": "number",
+      "description": "Amount due",
+      "examples": [500]
+    },
+    "paymentDueDate": {
+      "type": ["string", "null"],
+      "description": "Payment due date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "invoicedDate": {
+      "type": ["string", "null"],
+      "description": "Invoiced date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "paymentDate": {
+      "type": ["string", "null"],
+      "description": "Date of payment",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "refundCreditNoteNumber": {
+      "type": ["string", "null"],
+      "description": "Refund credit note number",
+      "examples": ["1800004419"]
+    },
+    "refundAmount": {
+      "type": ["number", "null"],
+      "description": "Amount refunded",
+      "examples": [200]
+    },
+    "refundIssueDate": {
+      "type": ["string", "null"],
+      "description": "Refund issue date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    }
+  }
+}

package/schemas/nsip-meeting.schema.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "nsip-meeting.schema.json",
+  "title": "NSIP Meeting",
+  "description": "NSIP Standalone Meeting Schema for ODW Curated layer",
+  "type": "object",
+  "additionalProperties": true,
+
+  "required": [
+    "meetingID",
+    "caseId",
+    "caseReference",
+    "meetingAgenda",
+    "planningInspectorateRole",
+    "meetingDate",
+    "meetingType"
+  ],
+  "properties": {
+    "meetingID": {
+      "type": "integer",
+      "examples": [1234],
+      "description": "The unique identifier for an NSIP Meeting."
+    },
+    "caseId": {
+      "type": "integer",
+      "examples": [1242],
+      "description": "The unique identifier for the case within the Back Office. This is not the same as the case reference"
+    },
+    "caseReference": {
+      "type": ["string", "null"],
+      "examples": ["BC0510001"]
+    },
+    "meetingAgenda": {
+      "type": ["string", "null"],
+      "description": "Meeting agenda",
+      "examples": ["Flood Risk Assessment (FRA)"]
+    },
+    "planningInspectorateRole": {
+      "type": ["string", "null"],
+      "description": "Planning Inspectorate role",
+      "enum": ["facilitator", "advisor", "observer", null],
+      "examples": ["facilitator"]
+    },
+    "meetingDate": {
+      "type": ["string", "null"],
+      "description": "Meeting date",
+      "format": "date-time",
+      "examples": ["2023-07-27T20:30:00.000Z"]
+    },
+    "meetingType": {
+      "type": ["string", "null"],
+      "description": "Type of Meeting"
+    }
+  }
+}

package/src/enums.cjs

@@ -406,6 +406,14 @@ const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -452,6 +460,12 @@ const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -707,12 +721,14 @@ exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
 exports.NSIP_FAST_TRACK_ADMISSION_DOCUMENT = NSIP_FAST_TRACK_ADMISSION_DOCUMENT;
+exports.NSIP_INVOICE_STAGE = NSIP_INVOICE_STAGE;
 exports.NSIP_LANGUAGE = NSIP_LANGUAGE;
 exports.NSIP_MAP_ZOOM_LEVEL = NSIP_MAP_ZOOM_LEVEL;
 exports.NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT = NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT;
 exports.NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT = NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT;
 exports.NSIP_NEW_MATURITY = NSIP_NEW_MATURITY;
 exports.NSIP_ORIGIN = NSIP_ORIGIN;
+exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;

package/src/enums.d.ts

@@ -404,6 +404,14 @@ export const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = {
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 } as const;
 
+export const NSIP_INVOICE_STAGE = {
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+} as const;
+
 export const NSIP_LANGUAGE = {
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -450,6 +458,12 @@ export const NSIP_ORIGIN = {
   PINS: 'pins',
 } as const;
 
+export const NSIP_PLANNING_INSPECTORATE_ROLE = {
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+} as const;
+
 export const NSIP_POLICY_COMPLIANCE_DOCUMENT = {
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',

package/src/enums.js

@@ -404,6 +404,14 @@ export const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+export const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 export const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -450,6 +458,12 @@ export const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+export const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 export const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',

package/src/index.cjs

@@ -487,6 +487,14 @@ const NSIP_FAST_TRACK_ADMISSION_DOCUMENT = Object.freeze({
   SUBMITTED_BY_APPLICANT: 'submitted_by_applicant',
 });
 
+const NSIP_INVOICE_STAGE = Object.freeze({
+  ACCEPTANCE: 'acceptance',
+  FINAL_EXAMINATION: 'final_examination',
+  INITIAL_EXAMINATION: 'initial_examination',
+  PRE_ACCEPTANCE: 'pre_acceptance',
+  PRE_EXAMINATION: 'pre_examination',
+});
+
 const NSIP_LANGUAGE = Object.freeze({
   ENGLISH: 'English',
   WELSH: 'Welsh',
@@ -533,6 +541,12 @@ const NSIP_ORIGIN = Object.freeze({
   PINS: 'pins',
 });
 
+const NSIP_PLANNING_INSPECTORATE_ROLE = Object.freeze({
+  ADVISOR: 'advisor',
+  FACILITATOR: 'facilitator',
+  OBSERVER: 'observer',
+});
+
 const NSIP_POLICY_COMPLIANCE_DOCUMENT = Object.freeze({
   AWAITING_SUBMISSION: 'awaiting_submission',
   NOT_APPLICABLE: 'not_applicable',
@@ -820,12 +834,14 @@ exports.NSIP_DECISION = NSIP_DECISION;
 exports.NSIP_DESIGN_APPROACH_DOCUMENT = NSIP_DESIGN_APPROACH_DOCUMENT;
 exports.NSIP_DOCUMENT_CASE_STAGE = NSIP_DOCUMENT_CASE_STAGE;
 exports.NSIP_FAST_TRACK_ADMISSION_DOCUMENT = NSIP_FAST_TRACK_ADMISSION_DOCUMENT;
+exports.NSIP_INVOICE_STAGE = NSIP_INVOICE_STAGE;
 exports.NSIP_LANGUAGE = NSIP_LANGUAGE;
 exports.NSIP_MAP_ZOOM_LEVEL = NSIP_MAP_ZOOM_LEVEL;
 exports.NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT = NSIP_MATURE_OUTLINE_CONTROL_DOCUMENT;
 exports.NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT = NSIP_MULTIPARTY_APPLICATION_CHECK_DOCUMENT;
 exports.NSIP_NEW_MATURITY = NSIP_NEW_MATURITY;
 exports.NSIP_ORIGIN = NSIP_ORIGIN;
+exports.NSIP_PLANNING_INSPECTORATE_ROLE = NSIP_PLANNING_INSPECTORATE_ROLE;
 exports.NSIP_POLICY_COMPLIANCE_DOCUMENT = NSIP_POLICY_COMPLIANCE_DOCUMENT;
 exports.NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT = NSIP_PRINCIPAL_AREA_DISAGREEMENT_SUMMARY_STMT;
 exports.NSIP_PROJECT_TYPE = NSIP_PROJECT_TYPE;

package/src/schemas.d.ts

@@ -2088,6 +2088,92 @@ export interface LineItem {
   [k: string]: unknown;
 }
 
+/**
+ * NSIP Standalone Invoice Schema for ODW Curated layer
+ */
+export interface NSIPInvoice {
+  /**
+   * The unique identifier within the Back Office. This is not the same as the case reference
+   */
+  caseId: number;
+  caseReference: string | null;
+  /**
+   * Invoice stage
+   */
+  invoiceStage:
+    | 'pre_acceptance'
+    | 'acceptance'
+    | 'pre_examination'
+    | 'initial_examination'
+    | 'final_examination'
+    | null;
+  /**
+   * Invoice number
+   */
+  invoiceNumber: string;
+  /**
+   * Amount due
+   */
+  amountDue: number;
+  /**
+   * Payment due date
+   */
+  paymentDueDate: string | null;
+  /**
+   * Invoiced date
+   */
+  invoicedDate: string | null;
+  /**
+   * Date of payment
+   */
+  paymentDate: string | null;
+  /**
+   * Refund credit note number
+   */
+  refundCreditNoteNumber: string | null;
+  /**
+   * Amount refunded
+   */
+  refundAmount: number | null;
+  /**
+   * Refund issue date
+   */
+  refundIssueDate: string | null;
+  [k: string]: unknown;
+}
+
+/**
+ * NSIP Standalone Meeting Schema for ODW Curated layer
+ */
+export interface NSIPMeeting {
+  /**
+   * The unique identifier for an NSIP Meeting.
+   */
+  meetingID: number;
+  /**
+   * The unique identifier for the case within the Back Office. This is not the same as the case reference
+   */
+  caseId: number;
+  caseReference: string | null;
+  /**
+   * Meeting agenda
+   */
+  meetingAgenda: string | null;
+  /**
+   * Planning Inspectorate role
+   */
+  planningInspectorateRole: 'facilitator' | 'advisor' | 'observer' | null;
+  /**
+   * Meeting date
+   */
+  meetingDate: string | null;
+  /**
+   * Type of Meeting
+   */
+  meetingType: string | null;
+  [k: string]: unknown;
+}
+
 /**
  * NSIP Project Update (formerly known as Banners)
  */