ZRM Docs
Domain Model

Time Entry

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
workOrderIdstringYesID of the associated work order
userIdstringYesID of the associated user
laborCodeenum(standard, overtime, travel, emergency, warranty)YesLabor code
entryTypeenum(clock, manual, auto_tracked)YesEntry type
startTimestring.date-timeYesStart time
endTimestring.date-timeNoEnd time
durationMinutesintegerNoDuration minutes
billableFlagbooleanYesBillable flag
payrollFlagbooleanYesPayroll flag
notesstringNoNotes
gpsClockInunknownNoGps clock in
gpsClockOutunknownNoGps clock out
workspaceIdstringYesID of the associated workspace
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
workOrderIdstringYesID of the associated work order
userIdstringYesID of the associated user
laborCodeenum(standard, overtime, travel, emergency, warranty)Yes"standard"Labor code
entryTypeenum(clock, manual, auto_tracked)Yes"manual"Entry type
startTimestring.date-timeYesStart time
endTimestring.date-timeNoEnd time
durationMinutesintegerNoDuration minutes
billableFlagbooleanYestrueBillable flag
payrollFlagbooleanYestruePayroll flag
notesstringNoNotes
gpsClockInobjectNoGps clock in
gpsClockOutobjectNoGps clock out
workspaceIdstringNoID of the associated workspace
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
workOrderIdstringNoID of the associated work order
userIdstringNoID of the associated user
laborCodeenum(standard, overtime, travel, emergency, warranty)No"standard"Labor code
entryTypeenum(clock, manual, auto_tracked)No"manual"Entry type
startTimestring.date-timeNoStart time
endTimestring.date-timeNoEnd time
durationMinutesintegerNoDuration minutes
billableFlagbooleanNotrueBillable flag
payrollFlagbooleanNotruePayroll flag
notesstringNoNotes
gpsClockInobjectNoGps clock in
gpsClockOutobjectNoGps clock out

On this page