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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | Associated contract ID for the shift |
created_at | string | Required within parent | Date when the shift was created Format: date-time |
date_of_work | string | Required within parent | Date when the shift takes place, in YYYY-MM-DD format |
description | string | Required within parent | Description of the shift |
external_id | string | Required within parent | ID specified by the client for uniquely identifying the shift |
meta | Model | Optional | Expand Update a shift — 200 response body — data meta |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_reference_id | string | Optional | External ID of the original shift this one references (set on correction shifts). Maximum length: 48 Minimum length: 8 |
shift_type | string | Required within parent | Type of the shift Known values: REGULAR |
summary | Model | Optional | Expand Create raw time tracking shifts — 201 response body — data item summary |
updated_at | string | Required within parent | Date 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payable_break_hours | JSON | Optional | |
payable_break_hours (anyOf 1) | number | Alternative | Break hours that are payable Format: double |
payable_break_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shift_duration_hours | JSON | Optional | |
shift_duration_hours (anyOf 1) | number | Alternative | Total duration of the shift in hours Format: double |
shift_duration_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shift_rate_external_id | string | Required within parent | External ID of the shift rate associated with this shift |
time_amount | JSON | Optional | |
time_amount (anyOf 1) | number | Alternative | The amount of time for the shift Greater than: 0 Format: double |
time_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
time_unit | string | Optional | The unit of time for the shift (DAY, HOUR, MONTH, WEEK) Known values: DAY, HOUR, MONTH, WEEK |
total_break_hours | JSON | Optional | |
total_break_hours (anyOf 1) | number | Alternative | Total break duration in hours Format: double |
total_break_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_payable_hours | JSON | Optional | |
total_payable_hours (anyOf 1) | number | Alternative | Total payable working hours after break deductions Format: double |
total_payable_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create raw time tracking shifts — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the employee contract. |
shifts | array | Required within parent | |
shifts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_work | string | Required within parent | Date of the shift, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
description | string | Required within parent | Description of the shift. Maximum length: 30000 Minimum length: 1 |
external_id | string | Required within parent | ID specified by the client for uniquely identifying the shift. Maximum length: 48 Minimum length: 8 |
meta | Model | Required within parent | Expand Create raw time tracking shifts — request body — body data shifts item meta |
payroll_cycle_ref | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_date | string | Optional | Approval date for the shift Pattern: ^\d{4}-\d{2}-\d{2}$ |
breaks | array | Optional | |
breaks[] | Model | Each item | Expand Create raw time tracking shifts — request body — body data shifts item meta breaks item |
end | Model | Required within parent | Expand Create raw time tracking shifts — request body — body data shifts item meta end Shift end date and time |
start | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Break start and end date and time |
end | Model | Required within parent | Expand Create raw time tracking shifts — request body — body data shifts item meta breaks item end Break end date and time |
is_paid | boolean | Optional | Indicates if the break is paid. |
start | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Break end date and time |
date | string | Required within parent | Break end date, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
time | string | Required within parent | Break 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Break start date and time |
date | string | Required within parent | Break start date, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
time | string | Required within parent | Break 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift end date and time |
date | string | Required within parent | Shift end date, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
is_public_holiday | boolean | Required within parent | Indicates if the shift end day is a public holiday. |
is_rest_day | boolean | Required within parent | Indicates if the shift end day is a rest day. |
time | string | Required within parent | Shift 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift start date and time |
date | string | Required within parent | Shift start date, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
is_public_holiday | boolean | Required within parent | Indicates if the shift start day is a public holiday. |
is_rest_day | boolean | Required within parent | Indicates if the shift start day is a rest day. |
time | string | Required within parent | Shift start time, in HH:mm format. Pattern: ^([0-1]\d|2[0-3]):[0-5]\d$ |
Create shifts — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Create shifts — 201 response body — data item |
Referenced models: Create shifts — 201 response body — data item
Create shifts — 201 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | Associated contract ID for the shift |
created_at | string | Required within parent | Date when the shift was created Format: date-time |
date_of_work | string | Required within parent | Date when the shift takes place, in YYYY-MM-DD format |
description | string | Required within parent | Description of the shift |
external_id | string | Required within parent | ID specified by the client for uniquely identifying the shift |
meta | Model | Optional | Expand Update a shift — 200 response body — data meta |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_reference_id | string | Optional | External ID of the original shift this one references (set on correction shifts). Maximum length: 48 Minimum length: 8 |
shift_type | string | Required within parent | Type of the shift Known values: REGULAR, CORRECTION_ABSOLUTE, CORRECTION_DELTA |
summary | Model | Optional | Expand Update a shift — 200 response body — data summary |
updated_at | string | Required within parent | Date 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Description of the shift. Maximum length: 30000 Minimum length: 1 |
external_id | string | Required within parent | External ID of the shift. Maximum length: 48 Minimum length: 8 |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_reference_id | string | Required within parent | External ID of the original shift being corrected. Maximum length: 48 Minimum length: 8 |
shift_type | string | Required within parent | Type of the shift One of: CORRECTION_ABSOLUTE |
summary | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payable_break_hours | number | Optional | Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
shift_duration_hours | number | Optional | Total 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_amount | number | Optional | Corrected 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_unit | string | Optional | The 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_hours | number | Optional | Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
total_payable_hours | number | Optional | Corrected 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
corrections | array | Required within parent | |
corrections[] | Model | Each item | Expand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION DELTA corrections item |
description | string | Required within parent | Description of the shift. Maximum length: 30000 Minimum length: 1 |
external_id | string | Required within parent | External ID of the shift. Maximum length: 48 Minimum length: 8 |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_reference_id | string | Required within parent | External ID of the original shift being corrected. Maximum length: 48 Minimum length: 8 |
shift_type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Correction entry for delta shifts |
payable_break_hours | number | Optional | Payable break hours to add or subtract Greater than: 0 Format: double |
shift_duration_hours | number | Optional | Shift duration hours to add or subtract Greater than: 0 Format: double |
time_amount | number | Optional | Time amount to add or subtract Greater than: 0 Format: double |
total_break_hours | number | Optional | Break hours to add or subtract Greater than: 0 Format: double |
total_payable_hours | number | Optional | Payable hours to add or subtract Greater than: 0 Format: double |
type | string | Required within parent | Type of correction One of: ADDITION, SUBTRACTION |
Create shifts — request body — body / data / shifts / item / shift_type: REGULAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_work | string | Required within parent | Pattern: ^\d{4}-\d{2}-\d{2}$ |
description | string | Required within parent | Description of the shift. Maximum length: 30000 Minimum length: 1 |
external_id | string | Required within parent | External ID of the shift. Maximum length: 48 Minimum length: 8 |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_type | string | Optional | Type of the shift Default: REGULAR One of: REGULAR |
summary | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
payable_break_hours | number | Optional | Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
shift_duration_hours | number | Optional | Total 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_id | string | Optional | External 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_amount | number | Optional | The 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_unit | string | Optional | The 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_hours | number | Optional | Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
total_payable_hours | number | Optional | Total 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the employee contract. |
shifts | array | Required within parent | |
shifts[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Create shifts — request body — body / data / shifts / item / shift_type: REGULAR |
$ (oneOf 2) | Model | Alternative | Expand Create shifts — request body — body / data / shifts / item / shift_type: CORRECTION ABSOLUTE |
$ (oneOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response body for bulk delete shifts |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent | Success message indicating the number of shifts deleted Maximum length: 200 |
Delete multiple shifts by External ID — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_ids | array | Required within parent | Array of shift external_ids to delete |
external_ids[] | string | Each item |
List of shifts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shifts response |
data | array | Required within parent | |
data[] | Model | Each item | Expand Update a shift — 200 response body — data |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
items_per_page | JSON | Required within parent | |
items_per_page (anyOf 1) | number | Alternative | Number of shifts per page Format: double |
items_per_page (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
offset | JSON | Required within parent | |
offset (anyOf 1) | number | Alternative | Offset for pagination Format: double |
offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | number | Alternative | Total number of shifts Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a shift — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift response wrapper |
data | Model | Required within parent | Expand Update a shift — 200 response body — data |
Referenced models: Update a shift — 200 response body — data
Update a shift — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | Associated contract ID for the shift |
created_at | string | Required within parent | Date when the shift was created Format: date-time |
date_of_work | string | Required within parent | Date when the shift takes place, in YYYY-MM-DD format |
description | string | Required within parent | Description of the shift |
external_id | string | Required within parent | ID specified by the client for uniquely identifying the shift |
meta | Model | Optional | Expand Update a shift — 200 response body — data meta |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
shift_reference_id | string | Optional | External ID of the original shift this one references (set on correction shifts). Maximum length: 48 Minimum length: 8 |
shift_type | string | Required within parent | Type of the shift Known values: REGULAR, CORRECTION_ABSOLUTE, CORRECTION_DELTA, TIME_OFF_QUALIFYING |
summary | Model | Optional | Expand Update a shift — 200 response body — data summary |
updated_at | string | Required within parent | Date 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_date | string | Optional | Approval date for the shift, in ISO format |
breaks | array | Optional | |
breaks[] | Model | Each item | Expand Update a shift — 200 response body — data meta breaks item |
end | Model | Required within parent | Expand Update a shift — 200 response body — data meta end |
start | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end | Model | Required within parent | Expand Update a shift — 200 response body — data meta breaks item end |
is_paid | boolean | Optional | Indicates if the break is paid |
start | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | Break end date |
time | string | Required within parent | Break end time in HH:mm format |
Update a shift — 200 response body — data meta breaks item start
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | Break start date |
time | string | Required within parent | Break start time in HH:mm format |
Update a shift — 200 response body — data meta end
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | Shift end date |
is_public_holiday | boolean | Required within parent | Indicates if it is a public holiday |
is_rest_day | boolean | Required within parent | Indicates if it is a rest day |
time | string | Required within parent | Shift end time in HH:mm format |
Update a shift — 200 response body — data meta start
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date | string | Required within parent | Shift start date |
is_public_holiday | boolean | Required within parent | Indicates if it is a public holiday |
is_rest_day | boolean | Required within parent | Indicates if it is a rest day |
time | string | Required within parent | Shift start time in HH:mm format |
Update a shift — 200 response body — data payroll cycle ref
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payroll cycle reference |
date | string | Required within parent | date in ISO Format: date-time |
Update a shift — 200 response body — data summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payable_break_hours | JSON | Optional | |
payable_break_hours (anyOf 1) | number | Alternative | Break hours that are payable Format: double |
payable_break_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shift_duration_hours | JSON | Optional | |
shift_duration_hours (anyOf 1) | number | Alternative | Total duration of the shift in hours Format: double |
shift_duration_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shift_rate_external_id | string | Required within parent | External ID of the shift rate associated with this shift |
time_amount | JSON | Optional | |
time_amount (anyOf 1) | number | Alternative | The amount of time for the shift Format: double Minimum: 0 |
time_amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
time_unit | string | Optional | The unit of time for the shift (DAY, HOUR, MONTH, WEEK) Known values: DAY, HOUR, MONTH, WEEK |
total_break_hours | JSON | Optional | |
total_break_hours (anyOf 1) | number | Alternative | Total break duration in hours Format: double |
total_break_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total_payable_hours | JSON | Optional | |
total_payable_hours (anyOf 1) | number | Alternative | Total payable working hours after break deductions Format: double |
total_payable_hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a shift — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_of_work | string | Optional | The updated date of the shift, in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$ |
description | string | Optional | The updated description of the shift. Maximum length: 30000 Minimum length: 1 |
payroll_cycle_ref | Model | Optional | Expand Update a shift — 200 response body — data payroll cycle ref Payroll cycle reference |
summary | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payable_break_hours | number | Optional | Break hours that are payable. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
shift_duration_hours | number | Optional | Total 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_id | string | Optional | External 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_amount | number | Optional | The 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_hours | number | Optional | Total break duration in hours. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |
total_payable_hours | number | Optional | Total payable working hours after break deductions. Part of the hours-based summary group (see `shift_duration_hours`). Greater than: 0 Format: double |