ZRM Docs
Domain Model

Project Milestone

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
projectIdstringYesID of the associated project
namestringYesName
descriptionunknownYesDescription
statusenum(pending, in_progress, completed, skipped)YesStatus
milestoneTypeenum(payment, project)YesMilestone type
percentageunknownYesPercentage
triggerTypeunknownYesTrigger type
dependsOnMilestoneIdunknownYesID of the associated depends on milestone
paymentTermMilestoneIdunknownYesID of the associated payment term milestone
dueDateunknownYesDue date
completedDateunknownYesCompleted date
sortOrderintegerYesSort order
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
projectIdstringYesID of the associated project
namestringYesName
descriptionstringNoDescription
statusenum(pending, in_progress, completed, skipped)Yes"pending"Status
milestoneTypeenum(payment, project)Yes"project"Milestone type
percentageunknownNoPercentage
triggerTypeunknownNoTrigger type
dependsOnMilestoneIdunknownNoID of the associated depends on milestone
paymentTermMilestoneIdunknownNoID of the associated payment term milestone
dueDatestring.date-timeNoDue date
completedDatestring.date-timeNoCompleted date
sortOrderintegerYes0Sort order
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
descriptionstringNoDescription
statusenum(pending, in_progress, completed, skipped)No"pending"Status
milestoneTypeenum(payment, project)No"project"Milestone type
percentageunknownNoPercentage
triggerTypeunknownNoTrigger type
dependsOnMilestoneIdunknownNoID of the associated depends on milestone
paymentTermMilestoneIdunknownNoID of the associated payment term milestone
dueDatestring.date-timeNoDue date
completedDatestring.date-timeNoCompleted date
sortOrderintegerNo0Sort order

On this page