Domain Model
Work Package
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| projectId | string | Yes | — | ID of the associated project |
| name | string | Yes | — | Name |
| description | string,null | Yes | — | Description |
| status | enum(planned, in_progress, completed, canceled) | Yes | — | Status |
| assignedToType | enum(internal, external) | Yes | — | Assigned to type |
| vendorOrganizationId | unknown | Yes | — | ID of the associated vendor organization |
| purchaseOrderId | unknown | Yes | — | ID of the associated purchase order |
| nteAmount | number,null | Yes | — | Nte amount |
| retainagePercent | number,null | Yes | — | Retainage percent |
| insuranceVerifiedAt | unknown | Yes | — | Insurance verified at |
| customerVisible | boolean | Yes | — | Customer visible |
| sortOrder | integer | Yes | — | Sort order |
| workspaceId | string | Yes | — | ID of the associated workspace |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| projectId | string | Yes | — | ID of the associated project |
| name | string | Yes | — | Name |
| description | unknown | No | — | Description |
| status | enum(planned, in_progress, completed, canceled) | Yes | "planned" | Status |
| assignedToType | enum(internal, external) | Yes | "internal" | Assigned to type |
| customerVisible | boolean | Yes | false | Customer visible |
| sortOrder | integer | Yes | 0 | Sort order |
| vendorOrganizationId | unknown | No | — | ID of the associated vendor organization |
| nteAmount | unknown | No | — | Nte amount |
| retainagePercent | unknown | No | — | Retainage percent |
| insuranceVerifiedAt | unknown | No | — | Insurance verified at |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | No | — | Name |
| description | unknown | No | — | Description |
| status | enum(planned, in_progress, completed, canceled) | No | — | Status |
| assignedToType | enum(internal, external) | No | — | Assigned to type |
| customerVisible | boolean | No | — | Customer visible |
| sortOrder | integer | No | — | Sort order |
| vendorOrganizationId | unknown | No | — | ID of the associated vendor organization |
| nteAmount | unknown | No | — | Nte amount |
| retainagePercent | unknown | No | — | Retainage percent |
| insuranceVerifiedAt | unknown | No | — | Insurance verified at |