Skip to content

Deel: Time tracking shifts schemas

38 Deel schemas with complete fields and constraints.

← Time tracking shifts operations · All schemas

Create raw time tracking shifts — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Create raw time tracking shifts — 201 response body — data item

Referenced models: Create raw time tracking shifts — 201 response body — data item

Create raw time tracking shifts — 201 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentAssociated contract ID for the shift
created_atstringRequired within parentDate when the shift was created
Format: date-time
date_of_workstringRequired within parentDate when the shift takes place, in YYYY-MM-DD format
descriptionstringRequired within parentDescription of the shift
external_idstringRequired within parentID specified by the client for uniquely identifying the shift
metaModelOptionalExpand Update a shift — 200 response body — data meta
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_reference_idstringOptionalExternal ID of the original shift this one references (set on correction shifts).
Maximum length: 48
Minimum length: 8
shift_typestringRequired within parentType of the shift
Known values: REGULAR
summaryModelOptionalExpand Create raw time tracking shifts — 201 response body — data item summary
updated_atstringRequired within parentDate when the shift was last updated
Format: date-time

Referenced models: Update a shift — 200 response body — data meta, Update a shift — 200 response body — data payroll cycle ref, Create raw time tracking shifts — 201 response body — data item summary

Create raw time tracking shifts — 201 response body — data item summary

FieldTypePresenceDescription and constraints
$objectRoot
payable_break_hoursJSONOptional
payable_break_hours (anyOf 1)numberAlternativeBreak hours that are payable
Format: double
payable_break_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shift_duration_hoursJSONOptional
shift_duration_hours (anyOf 1)numberAlternativeTotal duration of the shift in hours
Format: double
shift_duration_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shift_rate_external_idstringRequired within parentExternal ID of the shift rate associated with this shift
time_amountJSONOptional
time_amount (anyOf 1)numberAlternativeThe amount of time for the shift
Greater than: 0
Format: double
time_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time_unitstringOptionalThe unit of time for the shift (DAY, HOUR, MONTH, WEEK)
Known values: DAY, HOUR, MONTH, WEEK
total_break_hoursJSONOptional
total_break_hours (anyOf 1)numberAlternativeTotal break duration in hours
Format: double
total_break_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_payable_hoursJSONOptional
total_payable_hours (anyOf 1)numberAlternativeTotal payable working hours after break deductions
Format: double
total_payable_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create raw time tracking shifts — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the employee contract.
shiftsarrayRequired within parent
shifts[]ModelEach itemExpand Create raw time tracking shifts — request body — body data shifts item

Referenced models: Create raw time tracking shifts — request body — body data shifts item

Create raw time tracking shifts — request body — body data shifts item

FieldTypePresenceDescription and constraints
$objectRoot
date_of_workstringRequired within parentDate of the shift, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
descriptionstringRequired within parentDescription of the shift.
Maximum length: 30000
Minimum length: 1
external_idstringRequired within parentID specified by the client for uniquely identifying the shift.
Maximum length: 48
Minimum length: 8
metaModelRequired within parentExpand Create raw time tracking shifts — request body — body data shifts item meta
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference

Referenced models: Update a shift — 200 response body — data payroll cycle ref, Create raw time tracking shifts — request body — body data shifts item meta

Create raw time tracking shifts — request body — body data shifts item meta

FieldTypePresenceDescription and constraints
$objectRoot
approval_datestringOptionalApproval date for the shift
Pattern: ^\d{4}-\d{2}-\d{2}$
breaksarrayOptional
breaks[]ModelEach itemExpand Create raw time tracking shifts — request body — body data shifts item meta breaks item
endModelRequired within parentExpand Create raw time tracking shifts — request body — body data shifts item meta end
Shift end date and time
startModelRequired within parentExpand Create raw time tracking shifts — request body — body data shifts item meta start
Shift start date and time

Referenced models: Create raw time tracking shifts — request body — body data shifts item meta breaks item, Create raw time tracking shifts — request body — body data shifts item meta end, Create raw time tracking shifts — request body — body data shifts item meta start

Create raw time tracking shifts — request body — body data shifts item meta breaks item

FieldTypePresenceDescription and constraints
$objectRootBreak start and end date and time
endModelRequired within parentExpand Create raw time tracking shifts — request body — body data shifts item meta breaks item end
Break end date and time
is_paidbooleanOptionalIndicates if the break is paid.
startModelRequired within parentExpand Create raw time tracking shifts — request body — body data shifts item meta breaks item start
Break start date and time

Referenced models: Create raw time tracking shifts — request body — body data shifts item meta breaks item end, Create raw time tracking shifts — request body — body data shifts item meta breaks item start

Create raw time tracking shifts — request body — body data shifts item meta breaks item end

FieldTypePresenceDescription and constraints
$objectRootBreak end date and time
datestringRequired within parentBreak end date, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
timestringRequired within parentBreak end time, in HH:mm format.
Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$

Create raw time tracking shifts — request body — body data shifts item meta breaks item start

FieldTypePresenceDescription and constraints
$objectRootBreak start date and time
datestringRequired within parentBreak start date, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
timestringRequired within parentBreak start time, in HH:mm format.
Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$

Create raw time tracking shifts — request body — body data shifts item meta end

FieldTypePresenceDescription and constraints
$objectRootShift end date and time
datestringRequired within parentShift end date, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
is_public_holidaybooleanRequired within parentIndicates if the shift end day is a public holiday.
is_rest_daybooleanRequired within parentIndicates if the shift end day is a rest day.
timestringRequired within parentShift end time, in HH:mm format.
Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$

Create raw time tracking shifts — request body — body data shifts item meta start

FieldTypePresenceDescription and constraints
$objectRootShift start date and time
datestringRequired within parentShift start date, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
is_public_holidaybooleanRequired within parentIndicates if the shift start day is a public holiday.
is_rest_daybooleanRequired within parentIndicates if the shift start day is a rest day.
timestringRequired within parentShift start time, in HH:mm format.
Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$

Create shifts — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Create shifts — 201 response body — data item

Referenced models: Create shifts — 201 response body — data item

Create shifts — 201 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentAssociated contract ID for the shift
created_atstringRequired within parentDate when the shift was created
Format: date-time
date_of_workstringRequired within parentDate when the shift takes place, in YYYY-MM-DD format
descriptionstringRequired within parentDescription of the shift
external_idstringRequired within parentID specified by the client for uniquely identifying the shift
metaModelOptionalExpand Update a shift — 200 response body — data meta
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_reference_idstringOptionalExternal ID of the original shift this one references (set on correction shifts).
Maximum length: 48
Minimum length: 8
shift_typestringRequired within parentType of the shift
Known values: REGULAR, CORRECTION_ABSOLUTE, CORRECTION_DELTA
summaryModelOptionalExpand Update a shift — 200 response body — data summary
updated_atstringRequired within parentDate when the shift was last updated
Format: date-time

Referenced models: Update a shift — 200 response body — data meta, Update a shift — 200 response body — data payroll cycle ref, Update a shift — 200 response body — data summary

Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDescription of the shift.
Maximum length: 30000
Minimum length: 1
external_idstringRequired within parentExternal ID of the shift.
Maximum length: 48
Minimum length: 8
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_reference_idstringRequired within parentExternal ID of the original shift being corrected.
Maximum length: 48
Minimum length: 8
shift_typestringRequired within parentType of the shift
One of: CORRECTION_ABSOLUTE
summaryModelRequired within parentExpand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE summary

Referenced models: Update a shift — 200 response body — data payroll cycle ref, Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE summary

Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE summary

FieldTypePresenceDescription and constraints
$objectRoot
payable_break_hoursnumberOptionalBreak hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
shift_duration_hoursnumberOptionalTotal duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.
Greater than: 0
Format: double
time_amountnumberOptionalCorrected amount of time (0 zeroes the original shift). Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.
Format: double
Minimum: 0
time_unitstringOptionalThe unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`).
One of: DAY, HOUR, MONTH, WEEK
total_break_hoursnumberOptionalTotal break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
total_payable_hoursnumberOptionalCorrected total payable hours (0 zeroes the original shift). Part of the hours-based summary group (see `shift_duration_hours`).
Format: double
Minimum: 0

Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA

FieldTypePresenceDescription and constraints
$objectRoot
correctionsarrayRequired within parent
corrections[]ModelEach itemExpand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA corrections item
descriptionstringRequired within parentDescription of the shift.
Maximum length: 30000
Minimum length: 1
external_idstringRequired within parentExternal ID of the shift.
Maximum length: 48
Minimum length: 8
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_reference_idstringRequired within parentExternal ID of the original shift being corrected.
Maximum length: 48
Minimum length: 8
shift_typestringRequired within parentType of the shift
One of: CORRECTION_DELTA

Referenced models: Update a shift — 200 response body — data payroll cycle ref, Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA corrections item

Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA corrections item

FieldTypePresenceDescription and constraints
$objectRootCorrection entry for delta shifts
payable_break_hoursnumberOptionalPayable break hours to add or subtract
Greater than: 0
Format: double
shift_duration_hoursnumberOptionalShift duration hours to add or subtract
Greater than: 0
Format: double
time_amountnumberOptionalTime amount to add or subtract
Greater than: 0
Format: double
total_break_hoursnumberOptionalBreak hours to add or subtract
Greater than: 0
Format: double
total_payable_hoursnumberOptionalPayable hours to add or subtract
Greater than: 0
Format: double
typestringRequired within parentType of correction
One of: ADDITION, SUBTRACTION

Create shifts — request body — body / data / shifts / item / shift_type: REGULAR

FieldTypePresenceDescription and constraints
$objectRoot
date_of_workstringRequired within parentPattern: ^\d{4}-\d{2}-\d{2}$
descriptionstringRequired within parentDescription of the shift.
Maximum length: 30000
Minimum length: 1
external_idstringRequired within parentExternal ID of the shift.
Maximum length: 48
Minimum length: 8
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_typestringOptionalType of the shift
Default: REGULAR
One of: REGULAR
summaryModelRequired within parentExpand Create shifts — request body — body / data / shifts / item / shift_type: REGULAR summary
Shift summary. The fields here form two mutually exclusive groups — hours-based (`shift_duration_hours`, `total_break_hours`, `payable_break_hours`, `total_payable_hours`) and unit-amount (`time_amount`, `time_unit`) — and the schema cannot express this as a strict either/or because which group is required depends on the shift rate (`shift_rate_external_id`) type, resolved server-side: PER_UNIT_FLAT_RATE requires the unit-amount group, PER_HOUR_FLAT_RATE requires the hours-based group, and MULTIPLIER_PERCENTAGE (or no shift rate) accepts either group but not a mix of both. Sending fields from both groups, or the wrong group for the rate type, is rejected.

Referenced models: Update a shift — 200 response body — data payroll cycle ref, Create shifts — request body — body / data / shifts / item / shift_type: REGULAR summary

Create shifts — request body — body / data / shifts / item / shift_type: REGULAR summary

FieldTypePresenceDescription and constraints
$objectRootShift summary. The fields here form two mutually exclusive groups — hours-based (`shift_duration_hours`, `total_break_hours`, `payable_break_hours`, `total_payable_hours`) and unit-amount (`time_amount`, `time_unit`) — and the schema cannot express this as a strict either/or because which group is required depends on the shift rate (`shift_rate_external_id`) type, resolved server-side: PER_UNIT_FLAT_RATE requires the unit-amount group, PER_HOUR_FLAT_RATE requires the hours-based group, and MULTIPLIER_PERCENTAGE (or no shift rate) accepts either group but not a mix of both. Sending fields from both groups, or the wrong group for the rate type, is rejected.
payable_break_hoursnumberOptionalBreak hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
shift_duration_hoursnumberOptionalTotal duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.
Greater than: 0
Format: double
shift_rate_external_idstringOptionalExternal ID of the shift rate associated with this shift. Its type (PER_UNIT_FLAT_RATE, PER_HOUR_FLAT_RATE, or MULTIPLIER_PERCENTAGE) determines which of the two field groups below is required — see the group descriptions.
Maximum length: 48
Minimum length: 8
time_amountnumberOptionalThe amount of time for the shift. Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.
Greater than: 0
Format: double
time_unitstringOptionalThe unit of time for the shift (DAY, HOUR, MONTH, WEEK). Part of the unit-amount summary group (see `time_amount`).
One of: DAY, HOUR, MONTH, WEEK
total_break_hoursnumberOptionalTotal break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
total_payable_hoursnumberOptionalTotal payable working hours after break deductions. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double

Create shifts — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the employee contract.
shiftsarrayRequired within parent
shifts[]ModelEach itemExpand Create shifts — request body — body data shifts item

Referenced models: Create shifts — request body — body data shifts item

Create shifts — request body — body data shifts item

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create shifts — request body — body / data / shifts / item / shift_type: REGULAR
$ (oneOf 2)ModelAlternativeExpand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE
$ (oneOf 3)ModelAlternativeExpand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA

Referenced models: Create shifts — request body — body / data / shifts / item / shift_type: REGULAR, Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE, Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA

Delete multiple shifts by External ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRootResponse body for bulk delete shifts
dataModelRequired within parentExpand Delete multiple shifts by External ID — 200 response body — data

Referenced models: Delete multiple shifts by External ID — 200 response body — data

Delete multiple shifts by External ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired within parentSuccess message indicating the number of shifts deleted
Maximum length: 200

Delete multiple shifts by External ID — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
external_idsarrayRequired within parentArray of shift external_ids to delete
external_ids[]stringEach item

List of shifts — 200 response body

FieldTypePresenceDescription and constraints
$objectRootShifts response
dataarrayRequired within parent
data[]ModelEach itemExpand Update a shift — 200 response body — data
pageModelRequired within parentExpand List of shifts — 200 response body — page

Referenced models: Update a shift — 200 response body — data, List of shifts — 200 response body — page

List of shifts — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of shifts per page
Format: double
items_per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
offsetJSONRequired within parent
offset (anyOf 1)numberAlternativeOffset for pagination
Format: double
offset (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of shifts
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a shift — 200 response body

FieldTypePresenceDescription and constraints
$objectRootShift response wrapper
dataModelRequired within parentExpand Update a shift — 200 response body — data

Referenced models: Update a shift — 200 response body — data

Update a shift — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentAssociated contract ID for the shift
created_atstringRequired within parentDate when the shift was created
Format: date-time
date_of_workstringRequired within parentDate when the shift takes place, in YYYY-MM-DD format
descriptionstringRequired within parentDescription of the shift
external_idstringRequired within parentID specified by the client for uniquely identifying the shift
metaModelOptionalExpand Update a shift — 200 response body — data meta
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
shift_reference_idstringOptionalExternal ID of the original shift this one references (set on correction shifts).
Maximum length: 48
Minimum length: 8
shift_typestringRequired within parentType of the shift
Known values: REGULAR, CORRECTION_ABSOLUTE, CORRECTION_DELTA, TIME_OFF_QUALIFYING
summaryModelOptionalExpand Update a shift — 200 response body — data summary
updated_atstringRequired within parentDate when the shift was last updated
Format: date-time

Referenced models: Update a shift — 200 response body — data meta, Update a shift — 200 response body — data payroll cycle ref, Update a shift — 200 response body — data summary

Update a shift — 200 response body — data meta

FieldTypePresenceDescription and constraints
$objectRoot
approval_datestringOptionalApproval date for the shift, in ISO format
breaksarrayOptional
breaks[]ModelEach itemExpand Update a shift — 200 response body — data meta breaks item
endModelRequired within parentExpand Update a shift — 200 response body — data meta end
startModelRequired within parentExpand Update a shift — 200 response body — data meta start

Referenced models: Update a shift — 200 response body — data meta breaks item, Update a shift — 200 response body — data meta end, Update a shift — 200 response body — data meta start

Update a shift — 200 response body — data meta breaks item

FieldTypePresenceDescription and constraints
$objectRoot
endModelRequired within parentExpand Update a shift — 200 response body — data meta breaks item end
is_paidbooleanOptionalIndicates if the break is paid
startModelRequired within parentExpand Update a shift — 200 response body — data meta breaks item start

Referenced models: Update a shift — 200 response body — data meta breaks item end, Update a shift — 200 response body — data meta breaks item start

Update a shift — 200 response body — data meta breaks item end

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentBreak end date
timestringRequired within parentBreak end time in HH:mm format

Update a shift — 200 response body — data meta breaks item start

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentBreak start date
timestringRequired within parentBreak start time in HH:mm format

Update a shift — 200 response body — data meta end

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentShift end date
is_public_holidaybooleanRequired within parentIndicates if it is a public holiday
is_rest_daybooleanRequired within parentIndicates if it is a rest day
timestringRequired within parentShift end time in HH:mm format

Update a shift — 200 response body — data meta start

FieldTypePresenceDescription and constraints
$objectRoot
datestringRequired within parentShift start date
is_public_holidaybooleanRequired within parentIndicates if it is a public holiday
is_rest_daybooleanRequired within parentIndicates if it is a rest day
timestringRequired within parentShift start time in HH:mm format

Update a shift — 200 response body — data payroll cycle ref

FieldTypePresenceDescription and constraints
$objectRootPayroll cycle reference
datestringRequired within parentdate in ISO
Format: date-time

Update a shift — 200 response body — data summary

FieldTypePresenceDescription and constraints
$objectRoot
payable_break_hoursJSONOptional
payable_break_hours (anyOf 1)numberAlternativeBreak hours that are payable
Format: double
payable_break_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shift_duration_hoursJSONOptional
shift_duration_hours (anyOf 1)numberAlternativeTotal duration of the shift in hours
Format: double
shift_duration_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shift_rate_external_idstringRequired within parentExternal ID of the shift rate associated with this shift
time_amountJSONOptional
time_amount (anyOf 1)numberAlternativeThe amount of time for the shift
Format: double
Minimum: 0
time_amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time_unitstringOptionalThe unit of time for the shift (DAY, HOUR, MONTH, WEEK)
Known values: DAY, HOUR, MONTH, WEEK
total_break_hoursJSONOptional
total_break_hours (anyOf 1)numberAlternativeTotal break duration in hours
Format: double
total_break_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_payable_hoursJSONOptional
total_payable_hours (anyOf 1)numberAlternativeTotal payable working hours after break deductions
Format: double
total_payable_hours (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a shift — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
date_of_workstringOptionalThe updated date of the shift, in YYYY-MM-DD format.
Pattern: ^\d{4}-\d{2}-\d{2}$
descriptionstringOptionalThe updated description of the shift.
Maximum length: 30000
Minimum length: 1
payroll_cycle_refModelOptionalExpand Update a shift — 200 response body — data payroll cycle ref
Payroll cycle reference
summaryModelOptionalExpand Update a shift — request body — body data summary

Referenced models: Update a shift — 200 response body — data payroll cycle ref, Update a shift — request body — body data summary

Update a shift — request body — body data summary

FieldTypePresenceDescription and constraints
$objectRoot
payable_break_hoursnumberOptionalBreak hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
shift_duration_hoursnumberOptionalTotal duration of the shift in hours. Part of the hours-based summary group, used when the shift rate is PER_HOUR_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `time_amount`/`time_unit` — do not send both groups.
Greater than: 0
Format: double
shift_rate_external_idstringOptionalExternal ID of the shift rate associated with this shift. Its type (PER_UNIT_FLAT_RATE, PER_HOUR_FLAT_RATE, or MULTIPLIER_PERCENTAGE) determines which of the two field groups below is required — see the group descriptions.
Maximum length: 48
Minimum length: 8
time_amountnumberOptionalThe amount of time for the shift. Part of the unit-amount summary group, required when the shift rate is PER_UNIT_FLAT_RATE (or MULTIPLIER_PERCENTAGE/omitted, where either group is accepted). Mutually exclusive with `shift_duration_hours`/`total_break_hours`/`payable_break_hours`/`total_payable_hours` — do not send both groups.
Greater than: 0
Format: double
total_break_hoursnumberOptionalTotal break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double
total_payable_hoursnumberOptionalTotal payable working hours after break deductions. Part of the hours-based summary group (see `shift_duration_hours`).
Greater than: 0
Format: double

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.