Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringRequired within parentID specified by the client for uniquely identifying shift rate across organization
Maximum length: 48
Minimum length: 8
namestringRequired within parentName of the shift rate policy
Maximum length: 3000
Minimum length: 1
typestringOptionalType of the shift
One of: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE
valuenumberOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the timesheet was created
Format: date-time
idstringRequired within parentUnique identifier for the created timesheet
Format: uuid
updated_atstringRequired within parentTimestamp when the timesheet was last updated
Format: date-time
upload_fieldsobjectRequired within parentForm 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.*JSONAdditional keysAny type
upload_urlstringRequired within parentPre-signed S3 URL for uploading the timesheet file
Format: uri

Generate timesheet upload url — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentId of the worker's contract associated with the timesheet
Maximum length: 50
Minimum length: 1
end_datestringRequired within parentEnd date of the timesheet period. Must be equal to or later than start_date.
Format: date
file_namestringRequired within parentName of the timesheet file. Must end with .csv extension.
Maximum length: 255
Minimum length: 1
Pattern: \.csv$
start_datestringRequired within parentStart 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

FieldTypePresenceDescription and constraints
$objectRootShift rate policies response
dataarrayRequired within parent
data[]ModelEach itemExpand Update a Shift Rate — 201 response body — data
pageModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
items_per_pageJSONRequired within parent
items_per_page (anyOf 1)numberAlternativeNumber of shift rate policies 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 shift rate policies
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a timesheet — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootTimesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL.
contract_idstringRequired within parentExternal id of the worker's contract associated with the timesheet
created_atstringRequired within parentTimestamp when the timesheet was created
Format: date-time
end_datestringRequired within parentEnd date of the timesheet period
Format: date
file_dataJSONOptionalPresent only when `extend=file_data` is provided. Contains file details and download URL.
file_data (anyOf 1)ModelAlternativeExpand Retrieve a timesheet — 200 response body — data file data download url, file id, file name
file_data (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier for the timesheet
Format: uuid
review_statusstringRequired within parentCurrent status of the timesheet review
Known values: PENDING_CREATION, PENDING_REVIEW, APPROVED, REJECTED
start_datestringRequired within parentStart date of the timesheet period
Format: date
submission_statusstringRequired within parentCurrent status of the timesheet submission
Known values: UPLOADING, UPLOAD_FAILED, PROCESSING, SUBMITTED, INVALID, FAILED
updated_atstringRequired within parentTimestamp when the timesheet was last updated
Format: date-time
validation_errorsJSONRequired within parent
validation_errors (anyOf 1)arrayAlternativeArray of validation errors found during timesheet processing. Null if no errors found.
validation_errors (anyOf 1)[]ModelEach itemExpand Retrieve a timesheet — 200 response body — data validation errors null item
validation_errors (anyOf 2)nullAlternativeArray of validation errors found during timesheet processing. Null if no errors found.
validation_errors (anyOf 2)[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootPresent only when `extend=file_data` is provided. Contains file details and download URL.
download_urlstringRequired within parentPre-signed S3 URL for downloading the timesheet file
Format: uri
file_idstringRequired within parentUnique identifier for the timesheet file
Format: uuid
file_namestringRequired within parentName of the timesheet file

Retrieve a timesheet — 200 response body — data validation errors null item

FieldTypePresenceDescription and constraints
$objectRoot
columnJSONOptional
column (anyOf 1)stringAlternativeColumn name in the timesheet file where the error occurred
column (anyOf 2)nullAlternativeColumn name in the timesheet file where the error occurred
contextJSONOptional
context (anyOf 1)objectAlternativeAdditional context information about the error
Additional keys: see wildcard field
context (anyOf 1).*JSONAdditional keysAny type
context (anyOf 2)nullAlternativeAdditional context information about the error
Additional keys: see wildcard field
context (anyOf 2).*JSONAdditional keysAny type
messagestringRequired within parentHuman-readable error message
rowJSONOptional
row (anyOf 1)JSONAlternative
row (anyOf 1) (anyOf 1)numberAlternativeRow number in the timesheet file where the error occurred
Format: double
row (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
row (anyOf 2)nullAlternativeRow number in the timesheet file where the error occurred
Format: double
typeModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$stringRootType 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootUpdated timesheet details after review
idstringRequired within parentUnique identifier for the timesheet
Format: uuid
review_reasonJSONOptional
review_reason (anyOf 1)stringAlternativeReason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED.
review_reason (anyOf 2)nullAlternativeReason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED.
review_statusstringRequired within parentCurrent status of the timesheet review
Known values: PENDING_CREATION, PENDING_REVIEW, APPROVED, REJECTED
reviewed_atstringRequired within parentTimestamp when the timesheet was reviewed
Format: date-time

Review a submitted timesheet — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
review_reasonstring or nullOptionalReason for rejecting the timesheet. Required when review_status is REJECTED, optional when APPROVED.
Maximum length: 30000
Minimum length: 0
review_statusstringRequired within parentThe review status for the timesheet. Must be APPROVED or REJECTED.
One of: APPROVED, REJECTED

Update a Shift Rate — 201 response body

FieldTypePresenceDescription and constraints
$objectRootShift rate policy response
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentDate when the shift rate was created
Format: date-time
external_idstringRequired within parentID specified by the client for uniquely identifying shift rate across organization
namestringRequired within parentName of the shift rate policy
typestringOptionalType of the shift rate
Known values: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE
updated_atstringRequired within parentDate when the shift rate was last updated
Format: date-time
valueJSONOptional
value (anyOf 1)numberAlternativeThe value of the shift rate (supports up to 2 decimal places)
Greater than: 0
Format: double
Multiple of: 0.01
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update a Shift Rate — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe updated name of the shift rate.
Maximum length: 3000
Minimum length: 1
typestringOptionalThe updated type of shift rate.
One of: MULTIPLIER_PERCENTAGE, PER_HOUR_FLAT_RATE, PER_UNIT_FLAT_RATE
valuenumberOptionalThe updated value of the shift rate.
Greater than: 0
Format: double
Multiple of: 0.01

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.