Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
contentstringOptionalDetailed description of the job scope
created_atstringOptionalTimestamp of when the job scope was created
created_byModelOptionalExpand List of job scope templates for EOR contracts — response body — item created by
idstringOptionalUnique identifier for the job scope
organization_idJSONOptional
organization_id (anyOf 1)stringAlternativeIdentifier of the associated organization, if any
organization_id (anyOf 2)nullAlternativeIdentifier of the associated organization, if any
personalJSONOptional
personal (anyOf 1)stringAlternativeIdentifier from the team or the profile, whichever is available
personal (anyOf 2)nullAlternativeIdentifier from the team or the profile, whichever is available
source_typestringOptionalSource of the job scope data
Known values: MANUAL, AI
teamModelOptionalExpand List of job scope templates for EOR contracts — response body — item team
titlestringOptionalTitle or name of the job scope
updated_atstringOptionalTimestamp of when the job scope was last updated
updated_byModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the user who created the job scope
id (anyOf 2)nullAlternativeUnique identifier of the user who created the job scope
nameJSONOptional
name (anyOf 1)stringAlternativeName of the user who created the job scope
name (anyOf 2)nullAlternativeName of the user who created the job scope

List of job scope templates for EOR contracts — response body — item team

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the associated team, if any
id (anyOf 2)nullAlternativeUnique identifier of the associated team, if any
nameJSONOptional
name (anyOf 1)stringAlternativeName of the team associated with the job scope, if any
name (anyOf 2)nullAlternativeName of the team associated with the job scope, if any

List of job scope templates for EOR contracts — response body — item updated by

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the user who last updated the job scope
id (anyOf 2)nullAlternativeUnique identifier of the user who last updated the job scope
nameJSONOptional
name (anyOf 1)stringAlternativeName of the user who last updated the job scope
name (anyOf 2)nullAlternativeName of the user who last updated the job scope

Request job scope validation — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
data_for_corrected_job_scope_endpointModelOptionalExpand Request job scope validation — 200 response body — data for corrected job scope endpoint
Data for corrected job scope endpoint.
errorsarrayOptionalList of validation errors, if empty the validation was successfully.
errors[]ModelEach itemExpand Request job scope validation — 200 response body — errors item
quote_validation_log_public_idstringOptionalId 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

FieldTypePresenceDescription and constraints
$objectRootData for corrected job scope endpoint.
anonymized_job_scopeJSONOptional
anonymized_job_scope (anyOf 1)stringAlternativeAnonymized job scope.
anonymized_job_scope (anyOf 2)nullAlternativeAnonymized job scope.
errors_for_correct_job_scopearrayOptionalList of errors for corrected job scope.
errors_for_correct_job_scope[]ModelEach itemExpand Request job scope validation — 200 response body — data for corrected job scope endpoint errors for correct job scope item
must_create_correct_job_scopebooleanOptionalIndicates 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

FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalMessage with error description

Request job scope validation — 200 response body — errors item

FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalA description of the returned error
pathstringOptionalThe JSON path where input validation failed

Request job scope validation — request body — body data

FieldTypePresenceDescription and constraints
$objectRootdetails of job scope
client_legal_entity_idstringRequired within parentThe ID of the client's legal entity.
Format: uuid
client_namestringOptionalOptional 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_namestringRequired within parentThe name of the employee.
employee_nationalitystringOptionalThe nationality of the employee.
employment_countrystringRequired within parentThe country of employment.
employment_statestring or nullOptionalThe state of employment.
job_scopestringRequired within parentThe scope of the job.
Maximum length: 10000
Minimum length: 100
job_titlestringRequired within parentThe title of the job.
special_job_idstring or nullOptionalThe ID of the special job.
Format: uuid
team_idstringRequired within parentThe ID of the team.
Format: uuid
work_visabooleanOptionalIndicates if a work visa is required.

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.