Skip to content

Deel: Projects schemas

26 Deel schemas with complete fields and constraints.

← Projects operations · All schemas

Create Hourly Report Preset — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create Hourly Report Preset — 201 response body — data

Referenced models: Create Hourly Report Preset — 201 response body — data

Create Hourly Report Preset — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the newly created hourly report preset
Format: uuid

Create Hourly Report Preset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstring or nullOptionalA detailed description of the hourly report preset's purpose and contents
Maximum length: 30000
filestring or nullOptionalOptional file attachment for the hourly report preset
Format: binary
hourly_report_root_preset_idstringRequired within parentThe unique identifier of the root preset this report is based on
Format: uuid
ratenumberOptionalThe hourly rate for this preset (must be greater than 0)
Format: double
Minimum: 0.1
titlestringOptionalThe title of the hourly report preset
Maximum length: 255
work_statement_idstringRequired within parentThe unique identifier of the associated work statement
Format: uuid

Create Hourly Report Root Preset — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create Hourly Report Root Preset — 200 response body — data

Referenced models: Create Hourly Report Root Preset — 200 response body — data

Create Hourly Report Root Preset — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
async_taskModelOptionalExpand Create Hourly Report Root Preset — 200 response body — data async task
idstringRequired within parentThe unique identifier of the created root preset
Format: uuid

Referenced models: Create Hourly Report Root Preset — 200 response body — data async task

Create Hourly Report Root Preset — 200 response body — data async task

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)integerAlternativeThe identifier of the asynchronous task processing this request
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create Hourly Report Root Preset — request body — body hourly report presets item

FieldTypePresenceDescription and constraints
$objectRoot
action_typestringOptionalThe action to perform with this preset (currently only ADD is supported)
Default: ADD
One of: ADD
contract_idstringRequired within parentThe unique identifier of the contract this preset is associated with
descriptionstring or nullOptionalDetailed description for this specific preset instance (maximum 30000 characters)
Maximum length: 30000
filestring or nullOptionalOptional file attachment for this specific preset instance
Format: binary
ratenumberOptionalThe hourly rate for this preset (must be greater than 0)
Format: double
Minimum: 0.1
titlestringOptionalThe title for this specific preset instance (maximum 255 characters)
Maximum length: 255

Delete Hourly Report Preset — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Delete Hourly Report Preset — 200 response body — data
Container object confirming the outcome of the delete operation.

Referenced models: Delete Hourly Report Preset — 200 response body — data

Delete Hourly Report Preset — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootContainer object confirming the outcome of the delete operation.
deletedbooleanRequired within parentIndicates whether the hourly report preset was successfully deleted

Get Hourly Report Preset by ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get Hourly Report Preset by ID — 200 response body — data

Referenced models: Get Hourly Report Preset by ID — 200 response body — data

Get Hourly Report Preset by ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentA detailed description of the hourly report preset
fileJSONOptional
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Preset by ID — 200 response body — data file id, name, type
file (anyOf 2)nullAlternative
idstringRequired within parentThe unique identifier of the hourly report preset
Format: uuid
statusstringRequired within parentThe current status of the hourly report preset
titlestringRequired within parentThe title of the hourly report preset
typestringOptionalThe type of preset based on type of root preset
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Preset by ID — 200 response body — data file id, name, type

Get Hourly Report Preset by ID — 200 response body — data file id, name, type

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file

Get Hourly Report Presets — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentList of hourly report presets matching the requested filters.
data[]ModelEach itemExpand Get Hourly Report Presets — 200 response body — data item
pageModelRequired within parentExpand Get Hourly Report Presets — 200 response body — page
Pagination metadata for the response.

Referenced models: Get Hourly Report Presets — 200 response body — data item, Get Hourly Report Presets — 200 response body — page

Get Hourly Report Presets — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDetailed description of the hourly report preset
fileJSONOptionalFile attached to this hourly report preset, if any.
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any
file (anyOf 2)nullAlternative
hourly_report_root_presetModelRequired within parentExpand Get Hourly Report Presets — 200 response body — data item hourly report root preset
Root preset this hourly report preset is based on.
idstringRequired within parentThe unique identifier of the hourly report preset
Format: uuid
rateJSONRequired within parent
rate (anyOf 1)numberAlternativeThe hourly rate for this preset
Format: double
rate (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
titlestringRequired within parentTitle of the hourly report preset.

Referenced models: Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any, Get Hourly Report Presets — 200 response body — data item hourly report root preset

Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any

FieldTypePresenceDescription and constraints
$objectRootFile attached to this hourly report preset, if any.
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file

Get Hourly Report Presets — 200 response body — data item hourly report root preset

FieldTypePresenceDescription and constraints
$objectRootRoot preset this hourly report preset is based on.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDetailed description of the root preset template
description (anyOf 2)nullAlternativeDetailed description of the root preset template
fileJSONOptionalFile attached to this root preset, if any.
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any
file (anyOf 2)nullAlternative
idstringRequired within parentThe unique identifier of the root preset
Format: uuid
titlestringRequired within parentThe title of the root preset template
typestringOptionalThe type of preset based on type of root preset
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any

Get Hourly Report Presets — 200 response body — data item hourly report root preset file File attached to this root preset, if any

FieldTypePresenceDescription and constraints
$objectRootFile attached to this root preset, if any.
idstringOptionalThe unique identifier of the file
namestringOptionalThe name of the file
typestringOptionalThe type of the file

Get Hourly Report Presets — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination metadata for the response.
cursorstringRequired within parentPagination cursor for fetching the next set of results
total_rowsJSONRequired within parent
total_rows (anyOf 1)integerAlternativeTotal number of rows available in the result set
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Hourly Report Root Preset by ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get Hourly Report Root Preset by ID — 200 response body — data

Referenced models: Get Hourly Report Root Preset by ID — 200 response body — data

Get Hourly Report Root Preset by ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentDetailed description of the hourly report root preset's purpose and contents
fileJSONOptional
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Preset by ID — 200 response body — data file id, name, type
file (anyOf 2)nullAlternative
idstringRequired within parentThe unique identifier of the hourly report root preset
Format: uuid
statusstringRequired within parentThe current status of the hourly report root preset
titlestringRequired within parentThe title of the hourly report root preset
typestringOptionalThe type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Preset by ID — 200 response body — data file id, name, type

Get Hourly Report Root Presets — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Get Hourly Report Root Presets — 200 response body — data item
pageModelRequired within parentExpand Get Hourly Report Root Presets — 200 response body — page

Referenced models: Get Hourly Report Root Presets — 200 response body — data item, Get Hourly Report Root Presets — 200 response body — page

Get Hourly Report Root Presets — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
contracts_countJSONRequired within parent
contracts_count (anyOf 1)integerAlternativeNumber of contracts using this root preset
contracts_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
descriptionstringRequired within parentDetailed description of the hourly report root preset
fileJSONOptional
file (anyOf 1)ModelAlternativeExpand Get Hourly Report Preset by ID — 200 response body — data file id, name, type
file (anyOf 2)nullAlternative
hourly_report_presets_countJSONRequired within parent
hourly_report_presets_count (anyOf 1)integerAlternativeNumber of hourly report presets created from this root preset
hourly_report_presets_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique identifier of the hourly report root preset
Format: uuid
titlestringRequired within parentThe title of the hourly report root preset
typestringOptionalThe type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate
Known values: RATE, TRACKING

Referenced models: Get Hourly Report Preset by ID — 200 response body — data file id, name, type

Get Hourly Report Root Presets — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRoot
cursorstringRequired within parentPagination cursor for fetching the next set of results
total_rowsJSONRequired within parent
total_rows (anyOf 1)integerAlternativeTotal number of root presets available
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Update Hourly Report Preset — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update Hourly Report Preset — 200 response body — data

Referenced models: Update Hourly Report Preset — 200 response body — data

Update Hourly Report Preset — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the updated hourly report preset
Format: uuid

Update Hourly Report Preset — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstring or nullOptionalA detailed description of the hourly report preset's purpose and contents (maximum 30000 characters)
Maximum length: 30000
filestring or nullOptionalThe file to be attached to this hourly report preset (optional)
Format: binary
ratestringOptionalThe hourly rate for this preset (must be greater than 0)
titlestringOptionalThe title of the hourly report preset (maximum 255 characters)
Maximum length: 255

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.