ZRM Docs
API ReferenceProject

project.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
opportunityIdstringNoID of the associated opportunity
acceptedQuoteIdstringNoID of the associated accepted quote
customerIdstringYesID of the associated customer
siteIdstringNoID of the associated site
primaryContactIdstringNoID of the associated primary contact
namestringYesName
descriptionstringNoDescription
statusenum(planning, active, on_hold, completed, canceled)Yes"planning"Status
priorityenum(low, medium, high, urgent)Yes"medium"Priority
projectTypeenum(new_construction, retrofit, service_agreement, expansion, other)NoProject type
startDatestring.date-timeNoStart date
targetEndDatestring.date-timeNoTarget end date
actualEndDatestring.date-timeNoActual end date
projectManagerUserIdunknownNoID of the associated project manager user
percentCompleteunknownNoPercent complete
materialBudgetunknownNoMaterial budget
laborBudgetunknownNoLabor budget
recurringBudgetunknownNoRecurring budget
totalBudgetunknownNoTotal budget
discountTotalunknownNoDiscount total
taxTotalunknownNoTax total
scopeOfWorkstringNoScope of work
assumptionsstringNoAssumptions
exclusionsstringNoExclusions
warrantyTermsstringNoWarranty terms
permitRequiredbooleanNoPermit required
permitNotesstringNoPermit notes
insuranceRequirementsstringNoInsurance requirements
projectTimelineEstimatestringNoProject timeline estimate
siteAccessInstructionsstringNoSite access instructions
aiSummarystringNoAi summary
riskLevelenum(low, medium, high, critical)NoRisk level
customerApprovalStatusenum(not_required, pending, approved, rejected)No"not_required"Customer approval status
changeOrderCountintegerNoChange order count
changeOrderValuenumberNoChange order value
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "opportunityId": "550e8400-e29b-41d4-a716-446655440000",
  "acceptedQuoteId": "550e8400-e29b-41d4-a716-446655440000",
  "customerId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "primaryContactId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "status": "planning",
  "priority": "low",
  "visibilityMode": "global"
}

On this page