@planning-inspectorate/data-model 2.41.0 → 2.42.0

package/docs/nsip-invoice.md

@@ -7,16 +7,16 @@
 | 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")                     |
+| [caseReference](#casereference)                   | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-casereference.md "nsip-invoice.schema.json#/properties/caseReference")                   |
+| [invoiceStage](#invoicestage)                     | `string`  | Required | cannot 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")               |
+| [amountDue](#amountdue)                           | `number`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")                           |
+| [paymentDueDate](#paymentduedate)                 | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentduedate.md "nsip-invoice.schema.json#/properties/paymentDueDate")                 |
+| [invoicedDate](#invoiceddate)                     | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-invoiceddate.md "nsip-invoice.schema.json#/properties/invoicedDate")                     |
+| [paymentDate](#paymentdate)                       | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-paymentdate.md "nsip-invoice.schema.json#/properties/paymentDate")                       |
+| [refundCreditNoteNumber](#refundcreditnotenumber) | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundcreditnotenumber.md "nsip-invoice.schema.json#/properties/refundCreditNoteNumber") |
+| [refundAmount](#refundamount)                     | `number`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundamount.md "nsip-invoice.schema.json#/properties/refundAmount")                     |
+| [refundIssueDate](#refundissuedate)               | `string`  | Optional | can be null    | [NSIP Invoice](nsip-invoice-properties-refundissuedate.md "nsip-invoice.schema.json#/properties/refundIssueDate")               |
 | Additional Properties                             | Any       | Optional | can be null    |                                                                                                                                 |
 
 ## caseId
@@ -49,7 +49,7 @@ The unique identifier within the Back Office. This is not the same as the case r
 
 `caseReference`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -77,7 +77,7 @@ Invoice stage
 
 * Type: `string`
 
-* can be null
+* cannot be null
 
 * defined in: [NSIP Invoice](nsip-invoice-properties-invoicestage.md "nsip-invoice.schema.json#/properties/invoiceStage")
 
@@ -96,7 +96,6 @@ Invoice stage
 | `"pre_examination"`     |             |
 | `"initial_examination"` |             |
 | `"final_examination"`   |             |
-| `null`                  |             |
 
 ### invoiceStage Examples
 
@@ -134,11 +133,11 @@ Amount due
 
 `amountDue`
 
-* is required
+* is optional
 
 * Type: `number`
 
-* cannot be null
+* can be null
 
 * defined in: [NSIP Invoice](nsip-invoice-properties-amountdue.md "nsip-invoice.schema.json#/properties/amountDue")
 
@@ -158,7 +157,7 @@ Payment due date
 
 `paymentDueDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -186,7 +185,7 @@ Invoiced date
 
 `invoicedDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -214,7 +213,7 @@ Date of payment
 
 `paymentDate`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -242,7 +241,7 @@ Refund credit note number
 
 `refundCreditNoteNumber`
 
-* is required
+* is optional
 
 * Type: `string`
 
@@ -266,7 +265,7 @@ Amount refunded
 
 `refundAmount`
 
-* is required
+* is optional
 
 * Type: `number`
 
@@ -290,7 +289,7 @@ Refund issue date
 
 `refundIssueDate`
 
-* is required
+* is optional
 
 * Type: `string`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planning-inspectorate/data-model",
-  "version": "2.41.0",
+  "version": "2.42.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

@@ -18,7 +18,6 @@ class InvoiceStage(Enum):
     pre_examination = "pre_examination"
     initial_examination = "initial_examination"
     final_examination = "final_examination"
-    NoneType_None = None
 
 
 class NsipInvoice(BaseModel):
@@ -33,7 +32,7 @@ class NsipInvoice(BaseModel):
     """
     The unique identifier within the Back Office. This is not the same as the case reference
     """
-    caseReference: str | None = Field(..., examples=["BC0510001"])
+    caseReference: str | None = Field(None, examples=["BC0510001"])
     invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
     """
     Invoice stage
@@ -42,38 +41,38 @@ class NsipInvoice(BaseModel):
     """
     Invoice number
     """
-    amountDue: float = Field(..., examples=[500])
+    amountDue: float | None = Field(None, examples=[500])
     """
     Amount due
     """
     paymentDueDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Payment due date
     """
     invoicedDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Invoiced date
     """
     paymentDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Date of payment
     """
-    refundCreditNoteNumber: str | None = Field(..., examples=["1800004419"])
+    refundCreditNoteNumber: str | None = Field(None, examples=["1800004419"])
     """
     Refund credit note number
     """
-    refundAmount: float | None = Field(..., examples=[200])
+    refundAmount: float | None = Field(None, examples=[200])
     """
     Amount refunded
     """
     refundIssueDate: AwareDatetime | None = Field(
-        ..., examples=["2023-07-27T20:30:00.000Z"]
+        None, examples=["2023-07-27T20:30:00.000Z"]
     )
     """
     Refund issue date

package/schemas/nsip-invoice.schema.json

@@ -5,19 +5,7 @@
   "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"
-  ],
+  "required": ["caseId", "invoiceStage", "invoiceNumber"],
   "properties": {
     "caseId": {
       "type": "integer",
@@ -29,9 +17,9 @@
       "examples": ["BC0510001"]
     },
     "invoiceStage": {
-      "type": ["string", "null"],
+      "type": "string",
       "description": "Invoice stage",
-      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination", null],
+      "enum": ["pre_acceptance", "acceptance", "pre_examination", "initial_examination", "final_examination"],
       "examples": ["pre_acceptance"]
     },
     "invoiceNumber": {
@@ -40,7 +28,7 @@
       "examples": ["1800004419"]
     },
     "amountDue": {
-      "type": "number",
+      "type": ["number", "null"],
       "description": "Amount due",
       "examples": [500]
     },

package/src/schemas.d.ts

@@ -2411,17 +2411,11 @@ export interface NSIPInvoice {
    * The unique identifier within the Back Office. This is not the same as the case reference
    */
   caseId: number;
-  caseReference: string | null;
+  caseReference?: string | null;
   /**
    * Invoice stage
    */
-  invoiceStage:
-    | 'pre_acceptance'
-    | 'acceptance'
-    | 'pre_examination'
-    | 'initial_examination'
-    | 'final_examination'
-    | null;
+  invoiceStage: 'pre_acceptance' | 'acceptance' | 'pre_examination' | 'initial_examination' | 'final_examination';
   /**
    * Invoice number
    */
@@ -2429,31 +2423,31 @@ export interface NSIPInvoice {
   /**
    * Amount due
    */
-  amountDue: number;
+  amountDue?: number | null;
   /**
    * Payment due date
    */
-  paymentDueDate: string | null;
+  paymentDueDate?: string | null;
   /**
    * Invoiced date
    */
-  invoicedDate: string | null;
+  invoicedDate?: string | null;
   /**
    * Date of payment
    */
-  paymentDate: string | null;
+  paymentDate?: string | null;
   /**
    * Refund credit note number
    */
-  refundCreditNoteNumber: string | null;
+  refundCreditNoteNumber?: string | null;
   /**
    * Amount refunded
    */
-  refundAmount: number | null;
+  refundAmount?: number | null;
   /**
    * Refund issue date
    */
-  refundIssueDate: string | null;
+  refundIssueDate?: string | null;
   [k: string]: unknown;
 }