Deel: Projects schemas
26 Deel schemas with complete fields and constraints.
← Projects operations · All schemas
Create Hourly Report Preset — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the newly created hourly report preset Format: uuid |
Create Hourly Report Preset — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string or null | Optional | A detailed description of the hourly report preset's purpose and contents Maximum length: 30000 |
file | string or null | Optional | Optional file attachment for the hourly report preset Format: binary |
hourly_report_root_preset_id | string | Required within parent | The unique identifier of the root preset this report is based on Format: uuid |
rate | number | Optional | The hourly rate for this preset (must be greater than 0) Format: double Minimum: 0.1 |
title | string | Optional | The title of the hourly report preset Maximum length: 255 |
work_statement_id | string | Required within parent | The unique identifier of the associated work statement Format: uuid |
Create Hourly Report Root Preset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
async_task | Model | Optional | Expand Create Hourly Report Root Preset — 200 response body — data async task |
id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | The identifier of the asynchronous task processing this request |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create Hourly Report Root Preset — request body — body hourly report presets item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action_type | string | Optional | The action to perform with this preset (currently only ADD is supported) Default: ADD One of: ADD |
contract_id | string | Required within parent | The unique identifier of the contract this preset is associated with |
description | string or null | Optional | Detailed description for this specific preset instance (maximum 30000 characters) Maximum length: 30000 |
file | string or null | Optional | Optional file attachment for this specific preset instance Format: binary |
rate | number | Optional | The hourly rate for this preset (must be greater than 0) Format: double Minimum: 0.1 |
title | string | Optional | The title for this specific preset instance (maximum 255 characters) Maximum length: 255 |
Delete Hourly Report Preset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Container object confirming the outcome of the delete operation. |
deleted | boolean | Required within parent | Indicates whether the hourly report preset was successfully deleted |
Get Hourly Report Preset by ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | A detailed description of the hourly report preset |
file | JSON | Optional | |
file (anyOf 1) | Model | Alternative | Expand Get Hourly Report Preset by ID — 200 response body — data file id, name, type |
file (anyOf 2) | null | Alternative | |
id | string | Required within parent | The unique identifier of the hourly report preset Format: uuid |
status | string | Required within parent | The current status of the hourly report preset |
title | string | Required within parent | The title of the hourly report preset |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
type | string | Optional | The type of the file |
Get Hourly Report Presets — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | List of hourly report presets matching the requested filters. |
data[] | Model | Each item | Expand Get Hourly Report Presets — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Detailed description of the hourly report preset |
file | JSON | Optional | File attached to this hourly report preset, if any. |
file (anyOf 1) | Model | Alternative | Expand Get Hourly Report Presets — 200 response body — data item file File attached to this hourly report preset, if any |
file (anyOf 2) | null | Alternative | |
hourly_report_root_preset | Model | Required within parent | Expand Get Hourly Report Presets — 200 response body — data item hourly report root preset Root preset this hourly report preset is based on. |
id | string | Required within parent | The unique identifier of the hourly report preset Format: uuid |
rate | JSON | Required within parent | |
rate (anyOf 1) | number | Alternative | The hourly rate for this preset Format: double |
rate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File attached to this hourly report preset, if any. |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
type | string | Optional | The type of the file |
Get Hourly Report Presets — 200 response body — data item hourly report root preset
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Root preset this hourly report preset is based on. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Detailed description of the root preset template |
description (anyOf 2) | null | Alternative | Detailed description of the root preset template |
file | JSON | Optional | File attached to this root preset, if any. |
file (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
id | string | Required within parent | The unique identifier of the root preset Format: uuid |
title | string | Required within parent | The title of the root preset template |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | File attached to this root preset, if any. |
id | string | Optional | The unique identifier of the file |
name | string | Optional | The name of the file |
type | string | Optional | The type of the file |
Get Hourly Report Presets — 200 response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination metadata for the response. |
cursor | string | Required within parent | Pagination cursor for fetching the next set of results |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | integer | Alternative | Total number of rows available in the result set |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get Hourly Report Root Preset by ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | Detailed description of the hourly report root preset's purpose and contents |
file | JSON | Optional | |
file (anyOf 1) | Model | Alternative | Expand Get Hourly Report Preset by ID — 200 response body — data file id, name, type |
file (anyOf 2) | null | Alternative | |
id | string | Required within parent | The unique identifier of the hourly report root preset Format: uuid |
status | string | Required within parent | The current status of the hourly report root preset |
title | string | Required within parent | The title of the hourly report root preset |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Get Hourly Report Root Presets — 200 response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contracts_count | JSON | Required within parent | |
contracts_count (anyOf 1) | integer | Alternative | Number of contracts using this root preset |
contracts_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Required within parent | Detailed description of the hourly report root preset |
file | JSON | Optional | |
file (anyOf 1) | Model | Alternative | Expand Get Hourly Report Preset by ID — 200 response body — data file id, name, type |
file (anyOf 2) | null | Alternative | |
hourly_report_presets_count | JSON | Required within parent | |
hourly_report_presets_count (anyOf 1) | integer | Alternative | Number of hourly report presets created from this root preset |
hourly_report_presets_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | The unique identifier of the hourly report root preset Format: uuid |
title | string | Required within parent | The title of the hourly report root preset |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cursor | string | Required within parent | Pagination cursor for fetching the next set of results |
total_rows | JSON | Required within parent | |
total_rows (anyOf 1) | integer | Alternative | Total number of root presets available |
total_rows (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Update Hourly Report Preset — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the updated hourly report preset Format: uuid |
Update Hourly Report Preset — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string or null | Optional | A detailed description of the hourly report preset's purpose and contents (maximum 30000 characters) Maximum length: 30000 |
file | string or null | Optional | The file to be attached to this hourly report preset (optional) Format: binary |
rate | string | Optional | The hourly rate for this preset (must be greater than 0) |
title | string | Optional | The title of the hourly report preset (maximum 255 characters) Maximum length: 255 |