Deel: Tasks schemas
16 Deel schemas with complete fields and constraints.
← Tasks operations · All schemas
Create a new task — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Optional | Indicates whether the task creation operation was successful. |
id | string | Optional | The unique identifier for the created task. Format: uuid |
status | JSON | Optional | The current status of the task. |
status (anyOf 1) | string | Alternative | The current status of the task. Known values: approved, declined, new, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative |
Create a new task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | The amount to be associated with the task, in the appropriate currency. |
date_submitted | Model | Required within parent | Expand 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). |
description | string or null | Required within parent | A description of the task. |
group_key | string or null | Optional | When 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_id | string or null | Optional | Id of an existing TRACKING preset. Format: uuid |
is_auto_approved | boolean | Optional | If 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ). |
$ (oneOf 1) | string | Alternative | Format: date |
$ (oneOf 2) | string | Alternative | Format: date-time |
Delete task — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Delete task — 200 response body — data |
Referenced models: Delete task — 200 response body — data
Delete task — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
deleted | boolean | Required within parent | Indicates whether the task was successfully deleted. |
List of tasks — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Required within parent | The monetary amount associated with the task. |
attachment | Model | Optional | Expand List of tasks — 200 response body — data item attachment |
date_submitted | string | Required within parent | (Required) The date when the task was submitted. |
description | string | Required within parent | (Required) A brief description of the task. |
id | string | Required within parent | The unique identifier for the task. Minimum length: 1 |
status | JSON | Required within parent | The current status of the task. |
status (anyOf 1) | string | Alternative | The current status of the task. Known values: approved, declined, not_payable, paid, pending, processing |
status (anyOf 2) | null | Alternative |
Referenced models: List of tasks — 200 response body — data item attachment
List of tasks — 200 response body — data item attachment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filename | JSON | Optional | |
filename (anyOf 1) | string | Alternative | (Optional) The name of the file attached to the task. |
filename (anyOf 2) | null | Alternative | (Optional) The name of the file attached to the task. |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | (Optional) The key for accessing the attachment. |
key (anyOf 2) | null | Alternative | (Optional) The key for accessing the attachment. |
Review a single task — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created | boolean | Required within parent | Indicating whether the task review was created |
Review a single task — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reason | string or null | Optional | Optional reason for declining the task. |
status | string | Required within parent | The review status of the task. Possible values are 'approved' or 'declined'. One of: approved, declined |
Review multiple tasks — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
ids | array | Required within parent | An array of task IDs to review. A maximum of 1000 task IDs is allowed per request. |
ids[] | string | Each item | Format: uuid |
reason | string or null | Optional | Optional reason for declining the tasks. |
status | string | Required within parent | The review status of the tasks. Possible values are 'approved' or 'declined'. One of: approved, declined |
Update Task By ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp indicating when the task was created. Format: date-time |
updated_at | string | Required within parent | Timestamp indicating when the task was last updated. Format: date-time |
Update Task By ID — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string or null | Optional | The amount to be associated with the task, in the appropriate currency. |
description | string or null | Optional | A description of the task. |
hourly_report_preset_id | string or null | Optional | Public ID of the hourly report preset, if applicable. |