Deel: EOR job scopes schemas
9 Deel schemas with complete fields and constraints.
← EOR job scopes operations · All schemas
List of job scope templates for EOR contracts — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
content | string | Optional | Detailed description of the job scope |
created_at | string | Optional | Timestamp of when the job scope was created |
created_by | Model | Optional | Expand List of job scope templates for EOR contracts — response body — item created by |
id | string | Optional | Unique identifier for the job scope |
organization_id | JSON | Optional | |
organization_id (anyOf 1) | string | Alternative | Identifier of the associated organization, if any |
organization_id (anyOf 2) | null | Alternative | Identifier of the associated organization, if any |
personal | JSON | Optional | |
personal (anyOf 1) | string | Alternative | Identifier from the team or the profile, whichever is available |
personal (anyOf 2) | null | Alternative | Identifier from the team or the profile, whichever is available |
source_type | string | Optional | Source of the job scope data Known values: MANUAL, AI |
team | Model | Optional | Expand List of job scope templates for EOR contracts — response body — item team |
title | string | Optional | Title or name of the job scope |
updated_at | string | Optional | Timestamp of when the job scope was last updated |
updated_by | Model | Optional | Expand List of job scope templates for EOR contracts — response body — item updated by |
Referenced models: List of job scope templates for EOR contracts — response body — item created by, List of job scope templates for EOR contracts — response body — item team, List of job scope templates for EOR contracts — response body — item updated by
List of job scope templates for EOR contracts — response body — item created by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the user who created the job scope |
id (anyOf 2) | null | Alternative | Unique identifier of the user who created the job scope |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the user who created the job scope |
name (anyOf 2) | null | Alternative | Name of the user who created the job scope |
List of job scope templates for EOR contracts — response body — item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the associated team, if any |
id (anyOf 2) | null | Alternative | Unique identifier of the associated team, if any |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the team associated with the job scope, if any |
name (anyOf 2) | null | Alternative | Name of the team associated with the job scope, if any |
List of job scope templates for EOR contracts — response body — item updated by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the user who last updated the job scope |
id (anyOf 2) | null | Alternative | Unique identifier of the user who last updated the job scope |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Name of the user who last updated the job scope |
name (anyOf 2) | null | Alternative | Name of the user who last updated the job scope |
Request job scope validation — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data_for_corrected_job_scope_endpoint | Model | Optional | Expand Request job scope validation — 200 response body — data for corrected job scope endpoint Data for corrected job scope endpoint. |
errors | array | Optional | List of validation errors, if empty the validation was successfully. |
errors[] | Model | Each item | Expand Request job scope validation — 200 response body — errors item |
quote_validation_log_public_id | string | Optional | Id from validation request. |
Referenced models: Request job scope validation — 200 response body — errors item, Request job scope validation — 200 response body — data for corrected job scope endpoint
Request job scope validation — 200 response body — data for corrected job scope endpoint
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Data for corrected job scope endpoint. |
anonymized_job_scope | JSON | Optional | |
anonymized_job_scope (anyOf 1) | string | Alternative | Anonymized job scope. |
anonymized_job_scope (anyOf 2) | null | Alternative | Anonymized job scope. |
errors_for_correct_job_scope | array | Optional | List of errors for corrected job scope. |
errors_for_correct_job_scope[] | Model | Each item | Expand Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item |
must_create_correct_job_scope | boolean | Optional | Indicates if a corrected job scope is required. |
Referenced models: Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | Message with error description |
Request job scope validation — 200 response body — errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | A description of the returned error |
path | string | Optional | The JSON path where input validation failed |
Request job scope validation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | details of job scope |
client_legal_entity_id | string | Required within parent | The ID of the client's legal entity. Format: uuid |
client_name | string | Optional | Optional client name. The validation refuses a job scope if it includes the client name. If not provided, it will be inferred from the legal entity instead. |
employee_name | string | Required within parent | The name of the employee. |
employee_nationality | string | Optional | The nationality of the employee. |
employment_country | string | Required within parent | The country of employment. |
employment_state | string or null | Optional | The state of employment. |
job_scope | string | Required within parent | The scope of the job. Maximum length: 10000 Minimum length: 100 |
job_title | string | Required within parent | The title of the job. |
special_job_id | string or null | Optional | The ID of the special job. Format: uuid |
team_id | string | Required within parent | The ID of the team. Format: uuid |
work_visa | boolean | Optional | Indicates if a work visa is required. |