Domain Model
Project
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 |
| opportunityId | unknown | Yes | — | ID of the associated opportunity |
| number | integer | Yes | — | Number |
| acceptedQuoteId | unknown | Yes | — | ID of the associated accepted quote |
| customerId | string | Yes | — | ID of the associated customer |
| siteId | unknown | Yes | — | ID of the associated site |
| primaryContactId | unknown | Yes | — | ID of the associated primary contact |
| name | string | Yes | — | Name |
| description | string,null | Yes | — | Description |
| status | enum(planning, active, on_hold, completed, canceled) | Yes | — | Status |
| priority | unknown | Yes | — | Priority |
| projectType | unknown | Yes | — | Project type |
| startDate | unknown | Yes | — | Start date |
| targetEndDate | unknown | Yes | — | Target end date |
| actualEndDate | unknown | Yes | — | Actual end date |
| projectManagerUserId | unknown | Yes | — | ID of the associated project manager user |
| percentComplete | unknown | Yes | — | Percent complete |
| hasChangeOrders | boolean | Yes | — | Has change orders |
| materialBudget | number,null | Yes | — | Material budget |
| laborBudget | number,null | Yes | — | Labor budget |
| recurringBudget | number,null | Yes | — | Recurring budget |
| totalBudget | number,null | Yes | — | Total budget |
| discountTotal | number,null | Yes | — | Discount total |
| taxTotal | number,null | Yes | — | Tax total |
| scopeOfWork | string,null | Yes | — | Scope of work |
| assumptions | string,null | Yes | — | Assumptions |
| exclusions | string,null | Yes | — | Exclusions |
| warrantyTerms | string,null | Yes | — | Warranty terms |
| permitRequired | boolean,null | Yes | — | Permit required |
| permitNotes | string,null | Yes | — | Permit notes |
| insuranceRequirements | string,null | Yes | — | Insurance requirements |
| projectTimelineEstimate | string,null | Yes | — | Project timeline estimate |
| siteAccessInstructions | string,null | Yes | — | Site access instructions |
| aiSummary | string,null | Yes | — | Ai summary |
| actualMaterialCost | unknown | No | — | Actual material cost |
| actualLaborCost | unknown | No | — | Actual labor cost |
| actualSubcontractCost | unknown | No | — | Actual subcontract cost |
| actualTotalCost | unknown | No | — | Actual total cost |
| budgetVariance | number,null | No | — | Budget variance |
| budgetConsumedPercent | number,null | No | — | Budget consumed percent |
| riskLevel | unknown | No | — | Risk level |
| changeOrderCount | unknown | No | — | Change order count |
| changeOrderValue | unknown | No | — | Change order value |
| customerApprovalStatus | unknown | No | — | Customer approval status |
| billingMilestonesCompleted | unknown | No | — | Billing milestones completed |
| billingMilestonesTotal | unknown | No | — | Billing milestones total |
| lastActivityAt | unknown | No | — | Last activity at |
| engagementType | enum(direct_to_end_user, subcontracted_by_upstream, prime_with_subcontractors, upstream_and_downstream, service_only, warranty_only, internal, other) | No | — | Engagement type |
| communicationPolicy | enum(unrestricted, through_upstream_only, direct_after_closeout, emergency_direct_only, internal_review_required) | No | — | Communication policy |
| deliveryBrandingMode | enum(our_brand, upstream_white_label, co_branded, internal_only) | No | — | Delivery branding mode |
| postCloseoutServicePolicy | enum(transfers_to_end_user, remains_with_customer_of_record, remains_with_upstream, remains_with_property_manager, manual_review, no_service_relationship) | No | — | Post closeout service policy |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| opportunityId | unknown | No | — | ID of the associated opportunity |
| acceptedQuoteId | unknown | No | — | ID of the associated accepted quote |
| customerId | string | Yes | — | ID of the associated customer |
| siteId | unknown | No | — | ID of the associated site |
| primaryContactId | unknown | No | — | ID of the associated primary contact |
| name | string | Yes | — | Name |
| description | string | No | — | Description |
| status | enum(planning, active, on_hold, completed, canceled) | Yes | "planning" | Status |
| priority | unknown | Yes | "medium" | Priority |
| projectType | unknown | No | — | Project type |
| startDate | unknown | No | — | Start date |
| targetEndDate | unknown | No | — | Target end date |
| actualEndDate | unknown | No | — | Actual end date |
| projectManagerUserId | unknown | No | — | ID of the associated project manager user |
| percentComplete | unknown | No | — | Percent complete |
| materialBudget | unknown | No | — | Material budget |
| laborBudget | unknown | No | — | Labor budget |
| recurringBudget | unknown | No | — | Recurring budget |
| totalBudget | unknown | No | — | Total budget |
| discountTotal | unknown | No | — | Discount total |
| taxTotal | unknown | No | — | Tax total |
| scopeOfWork | string,null | No | — | Scope of work |
| assumptions | string,null | No | — | Assumptions |
| exclusions | string,null | No | — | Exclusions |
| warrantyTerms | string,null | No | — | Warranty terms |
| permitRequired | boolean | No | — | Permit required |
| permitNotes | string,null | No | — | Permit notes |
| insuranceRequirements | string,null | No | — | Insurance requirements |
| projectTimelineEstimate | string,null | No | — | Project timeline estimate |
| siteAccessInstructions | string,null | No | — | Site access instructions |
| aiSummary | string | No | — | Ai summary |
| riskLevel | unknown | No | — | Risk level |
| customerApprovalStatus | unknown | Yes | "not_required" | Customer approval status |
| changeOrderCount | unknown | No | — | Change order count |
| changeOrderValue | unknown | No | — | Change order value |
| engagementType | enum(direct_to_end_user, subcontracted_by_upstream, prime_with_subcontractors, upstream_and_downstream, service_only, warranty_only, internal, other) | No | "direct_to_end_user" | Engagement type |
| communicationPolicy | enum(unrestricted, through_upstream_only, direct_after_closeout, emergency_direct_only, internal_review_required) | No | "unrestricted" | Communication policy |
| deliveryBrandingMode | enum(our_brand, upstream_white_label, co_branded, internal_only) | No | "our_brand" | Delivery branding mode |
| postCloseoutServicePolicy | enum(transfers_to_end_user, remains_with_customer_of_record, remains_with_upstream, remains_with_property_manager, manual_review, no_service_relationship) | No | "transfers_to_end_user" | Post closeout service policy |
| endUserOrganizationId | unknown | No | — | ID of the associated end user organization |
| upstreamOrganizationId | unknown | No | — | ID of the associated upstream organization |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| opportunityId | unknown | No | — | ID of the associated opportunity |
| acceptedQuoteId | unknown | No | — | ID of the associated accepted quote |
| customerId | string | No | — | ID of the associated customer |
| siteId | unknown | No | — | ID of the associated site |
| primaryContactId | unknown | No | — | ID of the associated primary contact |
| name | string | No | — | Name |
| description | string | No | — | Description |
| status | enum(planning, active, on_hold, completed, canceled) | No | — | Status |
| priority | unknown | No | — | Priority |
| projectType | unknown | No | — | Project type |
| startDate | unknown | No | — | Start date |
| targetEndDate | unknown | No | — | Target end date |
| actualEndDate | unknown | No | — | Actual end date |
| projectManagerUserId | unknown | No | — | ID of the associated project manager user |
| percentComplete | unknown | No | — | Percent complete |
| materialBudget | unknown | No | — | Material budget |
| laborBudget | unknown | No | — | Labor budget |
| recurringBudget | unknown | No | — | Recurring budget |
| totalBudget | unknown | No | — | Total budget |
| discountTotal | unknown | No | — | Discount total |
| taxTotal | unknown | No | — | Tax total |
| scopeOfWork | string,null | No | — | Scope of work |
| assumptions | string,null | No | — | Assumptions |
| exclusions | string,null | No | — | Exclusions |
| warrantyTerms | string,null | No | — | Warranty terms |
| permitRequired | boolean | No | — | Permit required |
| permitNotes | string,null | No | — | Permit notes |
| insuranceRequirements | string,null | No | — | Insurance requirements |
| projectTimelineEstimate | string,null | No | — | Project timeline estimate |
| siteAccessInstructions | string,null | No | — | Site access instructions |
| aiSummary | string | No | — | Ai summary |
| riskLevel | unknown | No | — | Risk level |
| customerApprovalStatus | unknown | No | — | Customer approval status |
| changeOrderCount | unknown | No | — | Change order count |
| changeOrderValue | unknown | No | — | Change order value |
| engagementType | enum(direct_to_end_user, subcontracted_by_upstream, prime_with_subcontractors, upstream_and_downstream, service_only, warranty_only, internal, other) | No | — | Engagement type |
| communicationPolicy | enum(unrestricted, through_upstream_only, direct_after_closeout, emergency_direct_only, internal_review_required) | No | — | Communication policy |
| deliveryBrandingMode | enum(our_brand, upstream_white_label, co_branded, internal_only) | No | — | Delivery branding mode |
| postCloseoutServicePolicy | enum(transfers_to_end_user, remains_with_customer_of_record, remains_with_upstream, remains_with_property_manager, manual_review, no_service_relationship) | No | — | Post closeout service policy |
| endUserOrganizationId | unknown | No | — | ID of the associated end user organization |
| upstreamOrganizationId | unknown | No | — | ID of the associated upstream organization |