Deel: Contracts schemas (part 2)
24 Deel schemas with complete fields and constraints.
← Contracts operations · All schemas
Retrieve a single contract — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | JSON | Required within parent | Client details associated with the contract. |
client (anyOf 1) | Model | Alternative | Expand Retrieve a single contract — 200 response body — data client Client details associated with the contract |
client (anyOf 2) | null | Alternative | |
compensation_details | Model | Optional | Expand Add external Id — 200 response body — compensation details Compensation and payment configuration for the contract. |
contract_template | JSON | Optional | Contract template details. |
contract_template (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — contract template Contract template details |
contract_template (anyOf 2) | null | Alternative | |
cost_centers | array | Optional | List of cost centers associated with the contract. |
cost_centers[] | Model | Each item | Expand Add external Id — 200 response body — cost centers item |
created_at | string | Required within parent | Date and time when the contract was created. Format: date-time |
custom_fields | JSON | Optional | |
custom_fields (anyOf 1) | array | Alternative | List of custom fields attached to the contract. |
custom_fields (anyOf 1)[] | Model | Each item | Expand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item |
custom_fields (anyOf 2) | null | Alternative | List of custom fields attached to the contract. |
custom_fields (anyOf 2)[] | Model | Each item | Expand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item |
division | JSON | Optional | |
division (anyOf 1) | string | Alternative | Division the worker belongs to, from the active job information of a Global Payroll contract. Null for other contract types or when no division is set. |
division (anyOf 2) | null | Alternative | Division the worker belongs to, from the active job information of a Global Payroll contract. Null for other contract types or when no division is set. |
employment_details | Model | Optional | Expand Retrieve a single contract — 200 response body — data employment details Employment-related details for the contract. |
employment_type | JSON | Optional | Type of employment. |
employment_type (anyOf 1) | string | Alternative | Type of employment. Known values: FULL_TIME, PART_TIME |
employment_type (anyOf 2) | null | Alternative | |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | External identifier of the contract. |
external_id (anyOf 2) | null | Alternative | External identifier of the contract. |
fte_percentage | JSON | Optional | |
fte_percentage (anyOf 1) | JSON | Alternative | |
fte_percentage (anyOf 1) (anyOf 1) | number | Alternative | Full time percentage Format: double |
fte_percentage (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
fte_percentage (anyOf 2) | null | Alternative | Full time percentage Format: double |
id | string | Required within parent | Unique identifier for the contract. Minimum length: 1 |
invitations | Model | Required within parent | Expand Add external Id — 200 response body — invitations Invitation email addresses for signing the contract. |
is_archived | JSON | Required within parent | |
is_archived (anyOf 1) | boolean | Alternative | Flag to indicate if the contract is archived. |
is_archived (anyOf 2) | null | Alternative | Flag to indicate if the contract is archived. |
job_title | string | Optional | Job title associated with the contract. |
location | JSON | Optional | |
location (anyOf 1) | string | Alternative | Location name associated with the contract. |
location (anyOf 2) | null | Alternative | Location name associated with the contract. |
notice_period | JSON | Optional | |
notice_period (anyOf 1) | JSON | Alternative | |
notice_period (anyOf 1) (anyOf 1) | number | Alternative | Notice period in days. Format: double |
notice_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_period (anyOf 2) | null | Alternative | Notice period in days. Format: double |
platform_payment_type | string | Optional | Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only. Known values: STANDARD, OFF_PLATFORM |
product_area | JSON | Optional | |
product_area (anyOf 1) | JSON | Alternative | |
product_area (anyOf 1) (anyOf 1) | number | Alternative | Product area code associated with the contract. Format: double |
product_area (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
product_area (anyOf 2) | null | Alternative | Product area code associated with the contract. Format: double |
quote | Model | Optional | Expand Add external Id — 200 response body — quote EOR quote approved by Deel. |
scope_of_work | JSON | Optional | |
scope_of_work (anyOf 1) | string | Alternative | Scope of work of the contract. |
scope_of_work (anyOf 2) | null | Alternative | Scope of work of the contract. |
seniority | JSON | Optional | Seniority describes level of expertise at a job e.g. junior. |
seniority (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — seniority id, level, name |
seniority (anyOf 2) | null | Alternative | |
signatures | Model | Required within parent | Expand Add external Id — 200 response body — signatures Signature information for the contract parties. |
special_clause | JSON | Required within parent | |
special_clause (anyOf 1) | string | Alternative | Special clause of the contract. |
special_clause (anyOf 2) | null | Alternative | Special clause of the contract. |
start_date | string | Required within parent | Date and time when the contract starts. Format: date-time |
status | Model | Required within parent | Expand Add external Id — 200 response body — status Status of a contract in Deel workflow. |
termination_date | JSON | Required within parent | |
termination_date (anyOf 1) | string | Alternative | Date and time when the contract ends. |
termination_date (anyOf 2) | null | Alternative | Date and time when the contract ends. |
title | string | Required within parent | Title of the contract. Minimum length: 1 |
type | string | Required within parent | Type of a contract. Known values: ongoing_time_based, milestones, time_based, pay_as_you_go_time_based, commission, payg_milestones, payg_tasks, contractor_outside_deel, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee, peo |
updated_at | string | Required within parent | Date and time when the contract was updated. Format: date-time |
who_reports | string | Optional | Who reports the hours. |
work_schedule | JSON | Optional | Defines a work schedule including working days, hours, and employment details |
work_schedule (anyOf 1) | Model | Alternative | Expand Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types |
work_schedule (anyOf 2) | null | Alternative | |
work_statement_id | JSON | Optional | |
work_statement_id (anyOf 1) | string | Alternative | The unique identifier of the associated work statement. |
work_statement_id (anyOf 2) | null | Alternative | The unique identifier of the associated work statement. |
worker | JSON | Required within parent | Worker details associated with the contract. |
worker (anyOf 1) | Model | Alternative | Expand Retrieve a single contract — 200 response body — data worker Worker details associated with the contract |
worker (anyOf 2) | null | Alternative |
Referenced models: Add external Id — 200 response body — contract template Contract template details, Retrieve a single contract — 200 response body — data client Client details associated with the contract, Add external Id — 200 response body — compensation details, Add external Id — 200 response body — cost centers item, Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item, Retrieve a single contract — 200 response body — data employment details, Add external Id — 200 response body — invitations, Add external Id — 200 response body — quote, Add external Id — 200 response body — seniority id, level, name, Add external Id — 200 response body — signatures, Add external Id — 200 response body — status, Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types, Retrieve a single contract — 200 response body — data worker Worker details associated with the contract
Retrieve a single contract — 200 response body — data client Client details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details associated with the contract. |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
email (anyOf 2) | null | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
full_name | string | Optional | Full name of the client. |
id | string | Optional | Unique identifier of this resource. |
legal_entity | JSON | Optional | Legal entity details of the client. |
legal_entity (anyOf 1) | Model | Alternative | Expand Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client |
legal_entity (anyOf 2) | null | Alternative | |
team | Model | Required within parent | Expand Add external Id — 200 response body — client Client details associated with the contract team Team information for the client organization. |
Referenced models: Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client, Add external Id — 200 response body — client Client details associated with the contract team
Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Customized attributes on contracts (Employee ID, Project code, etc). |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | Unique identifier of the custom field. |
id (anyOf 2) | null | Alternative | Unique identifier of the custom field. |
name | string | Optional | Custom field property name. |
value | string | Optional | Custom field property value. |
Retrieve a single contract — 200 response body — data employment details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment-related details for the contract. |
days_per_week | JSON | Optional | |
days_per_week (anyOf 1) | number | Alternative | Number of days per week. Format: double |
days_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours_per_day | JSON | Optional | |
hours_per_day (anyOf 1) | number | Alternative | Number of hours per day. Format: double |
hours_per_day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
non_compete_clause | JSON | Optional | |
non_compete_clause (anyOf 1) | boolean | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_compete_clause (anyOf 2) | null | Alternative | Non-compete clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause | JSON | Optional | |
non_solicitation_clause (anyOf 1) | boolean | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
non_solicitation_clause (anyOf 2) | null | Alternative | Non-solicitation clause state on the active EOR SOW. Null when not yet populated. |
paid_vacation_days | JSON | Optional | |
paid_vacation_days (anyOf 1) | number | Alternative | Number of paid vacation days. Format: double |
paid_vacation_days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | number | Alternative | Probation period in days. Format: double |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Probation period in days. Format: double |
type | string | Optional | Type of employment. |
Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines a work schedule including working days, hours, and employment details |
country | string | Required within parent | Country code where this work schedule applies (ISO 3166-1 alpha-2) Pattern: ^[A-Z]{2}$ |
days | array | Required within parent | Working days and hours configuration |
days[] | Model | Each item | Expand Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types days item |
effective_from | string | Required within parent | Date and time when the contract's work schedule became effective. |
employment_type | JSON | Optional | Type of employment arrangement |
employment_type (anyOf 1) | string | Alternative | Type of employment arrangement Known values: FULL_TIME, PART_TIME, CONTRACT, TEMPORARY |
employment_type (anyOf 2) | null | Alternative | |
name | string | Required within parent | Unique identifier or name for the work schedule Maximum length: 50 |
work_hours_per_week | JSON | Required within parent | |
work_hours_per_week (anyOf 1) | integer | Alternative | Total number of working hours per week Maximum: 168 Minimum: 1 |
work_hours_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
work_schedule_type | string | Required within parent | Work schedule type |
worker_types | array | Required within parent | List of worker types that can use this schedule |
worker_types[] | string | Each item | Known values: SALARIED_DIRECT_EMPLOYEE_PAYROLL, SALARIED_HRIS_DIRECT_EMPLOYEE, SALARIED_EOR_EMPLOYEE, HOURLY_EOR_EMPLOYEE, HOURLY_DIRECT_EMPLOYEE_PAYROLL |
Retrieve a single contract — 200 response body — data work schedule country, days, effective from, employment type, name, work hours per week, work schedule type, worker types days item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines working hours for a specific day of the week |
day | string | Required within parent | Day of the week Known values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
end | JSON | Required within parent | |
end (anyOf 1) | string | Alternative | End time for the work day (HH:MM:SS format) Format: time Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
end (anyOf 2) | null | Alternative | End time for the work day (HH:MM:SS format) Format: time Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
start | string | Required within parent | Start time for the work day (HH:MM:SS format) Format: time Pattern: ^([01]?[0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]$ |
work_hours | string | Required within parent | Number of working hours for this day |
Retrieve a single contract — 200 response body — data worker Worker details associated with the contract
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Worker details associated with the contract. |
alternate_email | JSON | Optional | |
alternate_email (anyOf 1) | array | Alternative | List of alternate email addresses. |
alternate_email (anyOf 1)[] | Model | Each item | Expand Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item |
alternate_email (anyOf 2) | null | Alternative | List of alternate email addresses. |
alternate_email (anyOf 2)[] | Model | Each item | Expand Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the worker. |
country (anyOf 2) | null | Alternative | Country of the worker. |
date_of_birth | Model | Optional | Expand Retrieve a single contract — 200 response body — data worker Worker details associated with the contract date of birth |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
email (anyOf 2) | null | Alternative | User's email address. Minimum length: 5 Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$ |
expected_email | string | Optional | Expected email address of the worker (e.g., invitation target email). |
first_name | string | Optional | First name of the worker. |
full_name | string | Optional | Full name of the client. |
id | string | Optional | Unique identifier of this resource. |
last_name | string | Optional | Last name of the worker. |
nationality | JSON | Optional | |
nationality (anyOf 1) | string | Alternative | Nationality of the worker. |
nationality (anyOf 2) | null | Alternative | Nationality of the worker. |
Referenced models: Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item, Retrieve a single contract — 200 response body — data worker Worker details associated with the contract date of birth
Retrieve a single contract — 200 response body — data worker Worker details associated with the contract date of birth
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Format: date |
$ (anyOf 2) | string | Alternative | Maximum length: 0 |
Retrieve contract PDF download link — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve contract PDF download link — 200 response body — data |
Referenced models: Retrieve contract PDF download link — 200 response body — data
Retrieve contract PDF download link — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Required within parent | A pre-signed URL to download the PDF version of the specified contract Format: uri |
Retrieve contract templates — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve contract templates — 200 response body — data item |
Referenced models: Retrieve contract templates — 200 response body — data item
Retrieve contract templates — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | Model | Required within parent | Expand Retrieve a single milestone — 200 response body — data id |
title | string | Required within parent | The title of a contract template. |
Referenced models: Retrieve a single milestone — 200 response body — data id
Sign Amendment — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Sign Amendment — 201 response body — data |
Referenced models: Sign Amendment — 201 response body — data
Sign Amendment — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the signed amendment. |
is_signed | boolean | Required within parent | Indicates whether the amendment was successfully signed. |
Sign Amendment — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contractor_signature | string | Required within parent | The signature of the worker signing the amendment. Minimum length: 2 |
Sign worker contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Sign worker contract — 201 response body — data |
Referenced models: Sign worker contract — 201 response body — data
Sign worker contract — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The timestamp when the contract was created. Format: date-time |
id | string | Required within parent | The unique identifier of the signed contract. |
is_signed | boolean | Required within parent | Indicates whether the contract was successfully signed. |
updated_at | string | Required within parent | The timestamp when the contract was last updated. Format: date-time |
Sign worker contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
worker_signature | string | Required within parent | Signature of the worker for the contract |
Submit Global Payroll amendment signature — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Submit Global Payroll amendment signature — 200 response body — data |
Referenced models: Submit Global Payroll amendment signature — 200 response body — data
Submit Global Payroll amendment signature — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique identifier of the signed amendment. Format: uuid |
is_signed | boolean | Required within parent | Indicates whether the amendment was successfully signed. |
Submit Global Payroll amendment signature — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_signature | string | Required within parent | The client's signature for the amendment. Minimum length: 2 |
Update contract payment type — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update contract payment type — 200 response body — data The updated contract. See `GET /contracts/{contract_id}` for the full response shape. |
Referenced models: Update contract payment type — 200 response body — data
Update contract payment type — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The updated contract. See `GET /contracts/{contract_id}` for the full response shape. |
id | string | Optional | Unique identifier for the contract. |
platform_payment_type | string | Optional | Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Known values: STANDARD, OFF_PLATFORM |
Update contract payment type — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
platform_payment_type | string | Required within parent | Whether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only. One of: STANDARD, OFF_PLATFORM |
platform_payment_type_application_type | string | Optional | When to apply the change. Required when changing `platform_payment_type` on a signed contract. One of: IMMEDIATELY, NEXT_PAYMENT_CYCLE |