Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/nsip-project-defs-invoice.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

| Property | Type | Required | Nullable | Defined by |
| :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [invoiceStage](#invoicestage) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
| [invoiceStage](#invoicestage) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
| [invoiceNumber](#invoicenumber) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber") |
| [amountDue](#amountdue) | `number` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
| [amountDue](#amountdue) | `number` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
| [paymentDueDate](#paymentduedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate") |
| [invoicedDate](#invoiceddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate") |
| [paymentDate](#paymentdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate") |
Expand All @@ -23,11 +23,11 @@ Invoice stage

`invoiceStage`

* is optional
* is required

* Type: `string`

* can be null
* cannot be null

* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")

Expand All @@ -46,7 +46,6 @@ Invoice stage
| `"pre_examination"` | |
| `"initial_examination"` | |
| `"final_examination"` | |
| `null` | |

### invoiceStage Examples

Expand Down Expand Up @@ -84,11 +83,11 @@ Amount due

`amountDue`

* is required
* is optional

* Type: `number`

* cannot be null
* can be null

* defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")

Expand Down
13 changes: 6 additions & 7 deletions docs/nsip-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3783,9 +3783,9 @@ Reference this group by using

| Property | Type | Required | Nullable | Defined by |
| :------------------------------------------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [invoiceStage](#invoicestage) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
| [invoiceStage](#invoicestage) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage") |
| [invoiceNumber](#invoicenumber) | `string` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-invoicenumber.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceNumber") |
| [amountDue](#amountdue) | `number` | Required | cannot be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
| [amountDue](#amountdue) | `number` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue") |
| [paymentDueDate](#paymentduedate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentduedate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDueDate") |
| [invoicedDate](#invoiceddate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-invoiceddate.md "nsip-project.schema.json#/$defs/invoice/properties/invoicedDate") |
| [paymentDate](#paymentdate) | `string` | Optional | can be null | [NSIP Project](nsip-project-defs-invoice-properties-paymentdate.md "nsip-project.schema.json#/$defs/invoice/properties/paymentDate") |
Expand All @@ -3800,11 +3800,11 @@ Invoice stage

`invoiceStage`

* is optional
* is required

* Type: `string`

* can be null
* cannot be null

* defined in: [NSIP Project](nsip-project-defs-invoice-properties-invoicestage.md "nsip-project.schema.json#/$defs/invoice/properties/invoiceStage")

Expand All @@ -3823,7 +3823,6 @@ Invoice stage
| `"pre_examination"` | |
| `"initial_examination"` | |
| `"final_examination"` | |
| `null` | |

#### invoiceStage Examples

Expand Down Expand Up @@ -3861,11 +3860,11 @@ Amount due

`amountDue`

* is required
* is optional

* Type: `number`

* cannot be null
* can be null

* defined in: [NSIP Project](nsip-project-defs-invoice-properties-amountdue.md "nsip-project.schema.json#/$defs/invoice/properties/amountDue")

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_document.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-document.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:55+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_event.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-event.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:55+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_event_estimate.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-event-estimate.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:55+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_has.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-has.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_representation.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-representation.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_appeal_s78.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: appeal-s78.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_dart_response.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: dart-response.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_entraid.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: entraid.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_folder.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: folder.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_gettimesheets_response.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: gettimesheets-response.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_listed_building.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: listed-building.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_listed_buildings.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: listed-buildings.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_document.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-document.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_exam_timetable.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-exam-timetable.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_invoice.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-invoice.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_meeting.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-meeting.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
7 changes: 3 additions & 4 deletions pins_data_model/models/model_nsip_project.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-project.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down Expand Up @@ -352,7 +352,6 @@ class InvoiceStage(Enum):
pre_examination = "pre_examination"
initial_examination = "initial_examination"
final_examination = "final_examination"
NoneType_None = None


class Invoice(BaseModel):
Expand All @@ -363,15 +362,15 @@ class Invoice(BaseModel):
model_config = ConfigDict(
extra="allow",
)
invoiceStage: InvoiceStage | None = Field(None, examples=["pre_acceptance"])
invoiceStage: InvoiceStage = Field(..., examples=["pre_acceptance"])
"""
Invoice stage
"""
invoiceNumber: str = Field(..., examples=["1800004419"])
"""
Invoice number
"""
amountDue: float = Field(..., examples=[500])
amountDue: float | None = Field(None, examples=[500])
"""
Amount due
"""
Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_project_update.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-project-update.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:56+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_representation.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-representation.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_nsip_subscription.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: nsip-subscription.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_pins_inspector.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: pins-inspector.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_pins_lpa.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: pins-lpa.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_s51_advice.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: s51-advice.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion pins_data_model/models/model_service_user.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# generated by datamodel-codegen:
# filename: service-user.schema.json
# timestamp: 2026-03-06T13:54:17+00:00
# timestamp: 2026-03-19T10:25:57+00:00

from __future__ import annotations

Expand Down
8 changes: 4 additions & 4 deletions schemas/nsip-project.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -912,12 +912,12 @@
"type": "object",
"additionalProperties": true,
"description": "An invoice related to the project",
"required": ["invoiceNumber", "amountDue"],
"required": ["invoiceNumber", "invoiceStage"],
"properties": {
"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": {
Expand All @@ -926,7 +926,7 @@
"examples": ["1800004419"]
},
"amountDue": {
"type": "number",
"type": ["number", "null"],
"description": "Amount due",
"examples": [500]
},
Expand Down
10 changes: 2 additions & 8 deletions src/schemas.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2986,21 +2986,15 @@ export interface Invoice {
/**
* 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
*/
invoiceNumber: string;
/**
* Amount due
*/
amountDue: number;
amountDue?: number | null;
/**
* Payment due date
*/
Expand Down
Loading