Skip to content

Deel: Tasks schemas

16 Deel schemas with complete fields and constraints.

← Tasks operations · All schemas

Create a new task — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a new task — 201 response body — data

Referenced models: Create a new task — 201 response body — data

Create a new task — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanOptionalIndicates whether the task creation operation was successful.
idstringOptionalThe unique identifier for the created task.
Format: uuid
statusJSONOptionalThe current status of the task.
status (anyOf 1)stringAlternativeThe current status of the task.
Known values: approved, declined, new, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

Create a new task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentThe amount to be associated with the task, in the appropriate currency.
date_submittedModelRequired within parentExpand Create a new task — request body — body data date submitted
The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ).
descriptionstring or nullRequired within parentA description of the task.
group_keystring or nullOptionalWhen provided, tasks sharing the same group_key within the same payment cycle are merged into a single aggregated line item on the invoice. The group_key is used as the invoice line item description. Requires is_auto_approved to be true.
Maximum length: 300
hourly_report_preset_idstring or nullOptionalId of an existing TRACKING preset.
Format: uuid
is_auto_approvedbooleanOptionalIf true, the task will be automatically approved as part of the request. Required to be true when group_key is provided.

Referenced models: Create a new task — request body — body data date submitted

Create a new task — request body — body data date submitted

FieldTypePresenceDescription and constraints
$JSONRootThe date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ).
$ (oneOf 1)stringAlternativeFormat: date
$ (oneOf 2)stringAlternativeFormat: date-time

Delete task — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Delete task — 200 response body — data

Referenced models: Delete task — 200 response body — data

Delete task — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
deletedbooleanRequired within parentIndicates whether the task was successfully deleted.

List of tasks — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List of tasks — 200 response body — data item

Referenced models: List of tasks — 200 response body — data item

List of tasks — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentThe monetary amount associated with the task.
attachmentModelOptionalExpand List of tasks — 200 response body — data item attachment
date_submittedstringRequired within parent(Required) The date when the task was submitted.
descriptionstringRequired within parent(Required) A brief description of the task.
idstringRequired within parentThe unique identifier for the task.
Minimum length: 1
statusJSONRequired within parentThe current status of the task.
status (anyOf 1)stringAlternativeThe current status of the task.
Known values: approved, declined, not_payable, paid, pending, processing
status (anyOf 2)nullAlternative

Referenced models: List of tasks — 200 response body — data item attachment

List of tasks — 200 response body — data item attachment

FieldTypePresenceDescription and constraints
$objectRoot
filenameJSONOptional
filename (anyOf 1)stringAlternative(Optional) The name of the file attached to the task.
filename (anyOf 2)nullAlternative(Optional) The name of the file attached to the task.
keyJSONOptional
key (anyOf 1)stringAlternative(Optional) The key for accessing the attachment.
key (anyOf 2)nullAlternative(Optional) The key for accessing the attachment.

Review a single task — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Review a single task — 201 response body — data

Referenced models: Review a single task — 201 response body — data

Review a single task — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
createdbooleanRequired within parentIndicating whether the task review was created

Review a single task — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
reasonstring or nullOptionalOptional reason for declining the task.
statusstringRequired within parentThe review status of the task. Possible values are 'approved' or 'declined'.
One of: approved, declined

Review multiple tasks — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
idsarrayRequired within parentAn array of task IDs to review. A maximum of 1000 task IDs is allowed per request.
ids[]stringEach itemFormat: uuid
reasonstring or nullOptionalOptional reason for declining the tasks.
statusstringRequired within parentThe review status of the tasks. Possible values are 'approved' or 'declined'.
One of: approved, declined

Update Task By ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Update Task By ID — 200 response body — data

Referenced models: Update Task By ID — 200 response body — data

Update Task By ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp indicating when the task was created.
Format: date-time
updated_atstringRequired within parentTimestamp indicating when the task was last updated.
Format: date-time

Update Task By ID — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
amountstring or nullOptionalThe amount to be associated with the task, in the appropriate currency.
descriptionstring or nullOptionalA description of the task.
hourly_report_preset_idstring or nullOptionalPublic ID of the hourly report preset, if applicable.

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.