Deel: Time tracking schemas
17 Deel schemas with complete fields and constraints.
← Time tracking operations · All schemas
Create a New Shift Rate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Required within parent | ID specified by the client for uniquely identifying shift rate across organization Maximum length: 48 Minimum length: 8 |
name | string | Required within parent | Name of the shift rate policy Maximum length: 3000 Minimum length: 1 |
type | string | Optional | Type of the shift One of: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE |
value | number | Optional | The value of the shift rate (supports up to 2 decimal places) Greater than: 0 Format: double Multiple of: 0.01 |
Generate timesheet upload url — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Generate timesheet upload url — 201 response body — data |
Referenced models: Generate timesheet upload url — 201 response body — data
Generate timesheet upload url — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp when the timesheet was created Format: date-time |
id | string | Required within parent | Unique identifier for the created timesheet Format: uuid |
updated_at | string | Required within parent | Timestamp when the timesheet was last updated Format: date-time |
upload_fields | object | Required within parent | Form fields required for the multipart POST upload to S3. Include these fields alongside the file in the upload request. Additional keys: see wildcard field |
upload_fields.* | JSON | Additional keys | Any type |
upload_url | string | Required within parent | Pre-signed S3 URL for uploading the timesheet file Format: uri |
Generate timesheet upload url — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | Id of the worker's contract associated with the timesheet Maximum length: 50 Minimum length: 1 |
end_date | string | Required within parent | End date of the timesheet period. Must be equal to or later than start_date. Format: date |
file_name | string | Required within parent | Name of the timesheet file. Must end with .csv extension. Maximum length: 255 Minimum length: 1 Pattern: \.csv$ |
start_date | string | Required within parent | Start date of the timesheet period. Must be equal to or earlier than end_date. Format: date |
Retrieve a Paginated List of Shift Rates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift rate policies response |
data | array | Required within parent | |
data[] | Model | Each item | Expand Update a Shift Rate — 201 response body — data |
page | Model | Required within parent | Expand Retrieve a Paginated List of Shift Rates — 200 response body — page |
Referenced models: Update a Shift Rate — 201 response body — data, Retrieve a Paginated List of Shift Rates — 200 response body — page
Retrieve a Paginated List of Shift Rates — 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 shift rate policies 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 shift rate policies Format: double |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve a timesheet — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve a timesheet — 200 response body — data Timesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL. |
Referenced models: Retrieve a timesheet — 200 response body — data
Retrieve a timesheet — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL. |
contract_id | string | Required within parent | External id of the worker's contract associated with the timesheet |
created_at | string | Required within parent | Timestamp when the timesheet was created Format: date-time |
end_date | string | Required within parent | End date of the timesheet period Format: date |
file_data | JSON | Optional | Present only when `extend=file_data` is provided. Contains file details and download URL. |
file_data (anyOf 1) | Model | Alternative | Expand Retrieve a timesheet — 200 response body — data file data download url, file id, file name |
file_data (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the timesheet Format: uuid |
review_status | string | Required within parent | Current status of the timesheet review Known values: PENDING_CREATION, PENDING_REVIEW, APPROVED, REJECTED |
start_date | string | Required within parent | Start date of the timesheet period Format: date |
submission_status | string | Required within parent | Current status of the timesheet submission Known values: UPLOADING, UPLOAD_FAILED, PROCESSING, SUBMITTED, INVALID, FAILED |
updated_at | string | Required within parent | Timestamp when the timesheet was last updated Format: date-time |
validation_errors | JSON | Required within parent | |
validation_errors (anyOf 1) | array | Alternative | Array of validation errors found during timesheet processing. Null if no errors found. |
validation_errors (anyOf 1)[] | Model | Each item | Expand Retrieve a timesheet — 200 response body — data validation errors null item |
validation_errors (anyOf 2) | null | Alternative | Array of validation errors found during timesheet processing. Null if no errors found. |
validation_errors (anyOf 2)[] | Model | Each item | Expand Retrieve a timesheet — 200 response body — data validation errors null item |
Referenced models: Retrieve a timesheet — 200 response body — data file data download url, file id, file name, Retrieve a timesheet — 200 response body — data validation errors null item
Retrieve a timesheet — 200 response body — data file data download url, file id, file name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Present only when `extend=file_data` is provided. Contains file details and download URL. |
download_url | string | Required within parent | Pre-signed S3 URL for downloading the timesheet file Format: uri |
file_id | string | Required within parent | Unique identifier for the timesheet file Format: uuid |
file_name | string | Required within parent | Name of the timesheet file |
Retrieve a timesheet — 200 response body — data validation errors null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column | JSON | Optional | |
column (anyOf 1) | string | Alternative | Column name in the timesheet file where the error occurred |
column (anyOf 2) | null | Alternative | Column name in the timesheet file where the error occurred |
context | JSON | Optional | |
context (anyOf 1) | object | Alternative | Additional context information about the error Additional keys: see wildcard field |
context (anyOf 1).* | JSON | Additional keys | Any type |
context (anyOf 2) | null | Alternative | Additional context information about the error Additional keys: see wildcard field |
context (anyOf 2).* | JSON | Additional keys | Any type |
message | string | Required within parent | Human-readable error message |
row | JSON | Optional | |
row (anyOf 1) | JSON | Alternative | |
row (anyOf 1) (anyOf 1) | number | Alternative | Row number in the timesheet file where the error occurred Format: double |
row (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
row (anyOf 2) | null | Alternative | Row number in the timesheet file where the error occurred Format: double |
type | Model | Required within parent | Expand Retrieve a timesheet — 200 response body — data validation errors null item type Type of validation error |
Referenced models: Retrieve a timesheet — 200 response body — data validation errors null item type
Retrieve a timesheet — 200 response body — data validation errors null item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Type of validation error Known values: EMPTY_TIMESHEET, INVALID_TIMESHEET_FORMAT, FILE_TOO_LARGE, INVALID_FILE_TYPE, INVALID_SHIFT_TIME_ORDER, INVALID_BREAK_TIME_ORDER, BREAK_OUTSIDE_SHIFT, OVERLAPPING_BREAKS, CANNOT_SUBMIT_SHIFTS, WORK_DURATION_MISMATCH, NON_WORKING_DAY_VIOLATION, PUBLIC_HOLIDAY_VIOLATION, TIME_OFF_VIOLATION, SHIFT_OUT_OF_CYCLE, DAY_UNAVAILABLE, INVALID_SHIFT_SUBMIT_TYPE, INVALID_SHIFT_ORIGIN, INVALID_SHIFT_TYPE, INVALID_SHIFT_KEEP_IN_TOUCH_DATE_INTERVAL, OVERLAPPING_SHIFT, SHIFT_CONTRACT_IN_RESTRICTED_STATUS, SHIFT_CONTRACT_IN_TERMINATION_STATUS, SHIFT_CONTRACT_COMPLETION_DATE, SHIFT_CONTRACT_START_DATE, SHIFT_MAX_SATURDAYS_PER_YEAR_VIOLATION, INVALID_DAY_TRACKING_DATA, SHIFT_MAX_WORKING_DAYS_PER_YEAR_VIOLATION, SHIFT_MAX_CONSECUTIVE_DAYS_STREAK_VIOLATION, BREAK_TYPE_NOT_AVAILABLE, BREAK_MISSED_OR_WAIVED, BREAK_DURATION_MISMATCH, BREAK_MAX_DURATION_EXCEEDED, WORK_LOCATION_VIOLATION, WORK_LOCATION_MISMATCH_BETWEEN_TIME_CLOCK_EVENTS_FOR_SHIFT, MISSING_WORK_DESCRIPTION |
Review a submitted timesheet — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Review a submitted timesheet — 201 response body — data Updated timesheet details after review |
Referenced models: Review a submitted timesheet — 201 response body — data
Review a submitted timesheet — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Updated timesheet details after review |
id | string | Required within parent | Unique identifier for the timesheet Format: uuid |
review_reason | JSON | Optional | |
review_reason (anyOf 1) | string | Alternative | Reason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED. |
review_reason (anyOf 2) | null | Alternative | Reason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED. |
review_status | string | Required within parent | Current status of the timesheet review Known values: PENDING_CREATION, PENDING_REVIEW, APPROVED, REJECTED |
reviewed_at | string | Required within parent | Timestamp when the timesheet was reviewed Format: date-time |
Review a submitted timesheet — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
review_reason | string or null | Optional | Reason for rejecting the timesheet. Required when review_status is REJECTED, optional when APPROVED. Maximum length: 30000 Minimum length: 0 |
review_status | string | Required within parent | The review status for the timesheet. Must be APPROVED or REJECTED. One of: APPROVED, REJECTED |
Update a Shift Rate — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shift rate policy response |
data | Model | Required within parent | Expand Update a Shift Rate — 201 response body — data |
Referenced models: Update a Shift Rate — 201 response body — data
Update a Shift Rate — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Date when the shift rate was created Format: date-time |
external_id | string | Required within parent | ID specified by the client for uniquely identifying shift rate across organization |
name | string | Required within parent | Name of the shift rate policy |
type | string | Optional | Type of the shift rate Known values: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE |
updated_at | string | Required within parent | Date when the shift rate was last updated Format: date-time |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | The value of the shift rate (supports up to 2 decimal places) Greater than: 0 Format: double Multiple of: 0.01 |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update a Shift Rate — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The updated name of the shift rate. Maximum length: 3000 Minimum length: 1 |
type | string | Optional | The updated type of shift rate. One of: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE |
value | number | Optional | The updated value of the shift rate. Greater than: 0 Format: double Multiple of: 0.01 |