Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
clientJSONRequired within parentClient details associated with the contract.
client (anyOf 1)ModelAlternativeExpand Retrieve a single contract — 200 response body — data client Client details associated with the contract
client (anyOf 2)nullAlternative
compensation_detailsModelOptionalExpand Add external Id — 200 response body — compensation details
Compensation and payment configuration for the contract.
contract_templateJSONOptionalContract template details.
contract_template (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — contract template Contract template details
contract_template (anyOf 2)nullAlternative
cost_centersarrayOptionalList of cost centers associated with the contract.
cost_centers[]ModelEach itemExpand Add external Id — 200 response body — cost centers item
created_atstringRequired within parentDate and time when the contract was created.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 1)[]ModelEach itemExpand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
custom_fields (anyOf 2)nullAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 2)[]ModelEach itemExpand Retrieve a single contract — 200 response body — data custom fields List of custom fields attached to the contract item
divisionJSONOptional
division (anyOf 1)stringAlternativeDivision 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)nullAlternativeDivision 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_detailsModelOptionalExpand Retrieve a single contract — 200 response body — data employment details
Employment-related details for the contract.
employment_typeJSONOptionalType of employment.
employment_type (anyOf 1)stringAlternativeType of employment.
Known values: FULL_TIME, PART_TIME
employment_type (anyOf 2)nullAlternative
external_idJSONOptional
external_id (anyOf 1)stringAlternativeExternal identifier of the contract.
external_id (anyOf 2)nullAlternativeExternal identifier of the contract.
fte_percentageJSONOptional
fte_percentage (anyOf 1)JSONAlternative
fte_percentage (anyOf 1) (anyOf 1)numberAlternativeFull time percentage
Format: double
fte_percentage (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fte_percentage (anyOf 2)nullAlternativeFull time percentage
Format: double
idstringRequired within parentUnique identifier for the contract.
Minimum length: 1
invitationsModelRequired within parentExpand Add external Id — 200 response body — invitations
Invitation email addresses for signing the contract.
is_archivedJSONRequired within parent
is_archived (anyOf 1)booleanAlternativeFlag to indicate if the contract is archived.
is_archived (anyOf 2)nullAlternativeFlag to indicate if the contract is archived.
job_titlestringOptionalJob title associated with the contract.
locationJSONOptional
location (anyOf 1)stringAlternativeLocation name associated with the contract.
location (anyOf 2)nullAlternativeLocation name associated with the contract.
notice_periodJSONOptional
notice_period (anyOf 1)JSONAlternative
notice_period (anyOf 1) (anyOf 1)numberAlternativeNotice period in days.
Format: double
notice_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_period (anyOf 2)nullAlternativeNotice period in days.
Format: double
platform_payment_typestringOptionalWhether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.
Known values: STANDARD, OFF_PLATFORM
product_areaJSONOptional
product_area (anyOf 1)JSONAlternative
product_area (anyOf 1) (anyOf 1)numberAlternativeProduct area code associated with the contract.
Format: double
product_area (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
product_area (anyOf 2)nullAlternativeProduct area code associated with the contract.
Format: double
quoteModelOptionalExpand Add external Id — 200 response body — quote
EOR quote approved by Deel.
scope_of_workJSONOptional
scope_of_work (anyOf 1)stringAlternativeScope of work of the contract.
scope_of_work (anyOf 2)nullAlternativeScope of work of the contract.
seniorityJSONOptionalSeniority describes level of expertise at a job e.g. junior.
seniority (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — seniority id, level, name
seniority (anyOf 2)nullAlternative
signaturesModelRequired within parentExpand Add external Id — 200 response body — signatures
Signature information for the contract parties.
special_clauseJSONRequired within parent
special_clause (anyOf 1)stringAlternativeSpecial clause of the contract.
special_clause (anyOf 2)nullAlternativeSpecial clause of the contract.
start_datestringRequired within parentDate and time when the contract starts.
Format: date-time
statusModelRequired within parentExpand Add external Id — 200 response body — status
Status of a contract in Deel workflow.
termination_dateJSONRequired within parent
termination_date (anyOf 1)stringAlternativeDate and time when the contract ends.
termination_date (anyOf 2)nullAlternativeDate and time when the contract ends.
titlestringRequired within parentTitle of the contract.
Minimum length: 1
typestringRequired within parentType 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_atstringRequired within parentDate and time when the contract was updated.
Format: date-time
who_reportsstringOptionalWho reports the hours.
work_scheduleJSONOptionalDefines a work schedule including working days, hours, and employment details
work_schedule (anyOf 1)ModelAlternativeExpand 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)nullAlternative
work_statement_idJSONOptional
work_statement_id (anyOf 1)stringAlternativeThe unique identifier of the associated work statement.
work_statement_id (anyOf 2)nullAlternativeThe unique identifier of the associated work statement.
workerJSONRequired within parentWorker details associated with the contract.
worker (anyOf 1)ModelAlternativeExpand Retrieve a single contract — 200 response body — data worker Worker details associated with the contract
worker (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRootClient details associated with the contract.
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
email (anyOf 2)nullAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
full_namestringOptionalFull name of the client.
idstringOptionalUnique identifier of this resource.
legal_entityJSONOptionalLegal entity details of the client.
legal_entity (anyOf 1)ModelAlternativeExpand 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)nullAlternative
teamModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootCustomized attributes on contracts (Employee ID, Project code, etc).
idJSONOptional
id (anyOf 1)stringAlternativeUnique identifier of the custom field.
id (anyOf 2)nullAlternativeUnique identifier of the custom field.
namestringOptionalCustom field property name.
valuestringOptionalCustom field property value.

Retrieve a single contract — 200 response body — data employment details

FieldTypePresenceDescription and constraints
$objectRootEmployment-related details for the contract.
days_per_weekJSONOptional
days_per_week (anyOf 1)numberAlternativeNumber of days per week.
Format: double
days_per_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
hours_per_dayJSONOptional
hours_per_day (anyOf 1)numberAlternativeNumber of hours per day.
Format: double
hours_per_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
non_compete_clauseJSONOptional
non_compete_clause (anyOf 1)booleanAlternativeNon-compete clause state on the active EOR SOW. Null when not yet populated.
non_compete_clause (anyOf 2)nullAlternativeNon-compete clause state on the active EOR SOW. Null when not yet populated.
non_solicitation_clauseJSONOptional
non_solicitation_clause (anyOf 1)booleanAlternativeNon-solicitation clause state on the active EOR SOW. Null when not yet populated.
non_solicitation_clause (anyOf 2)nullAlternativeNon-solicitation clause state on the active EOR SOW. Null when not yet populated.
paid_vacation_daysJSONOptional
paid_vacation_days (anyOf 1)numberAlternativeNumber of paid vacation days.
Format: double
paid_vacation_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_periodJSONOptional
probation_period (anyOf 1)JSONAlternative
probation_period (anyOf 1) (anyOf 1)numberAlternativeProbation period in days.
Format: double
probation_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period (anyOf 2)nullAlternativeProbation period in days.
Format: double
typestringOptionalType 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

FieldTypePresenceDescription and constraints
$objectRootDefines a work schedule including working days, hours, and employment details
countrystringRequired within parentCountry code where this work schedule applies (ISO 3166-1 alpha-2)
Pattern: ^[A-Z]{2}$
daysarrayRequired within parentWorking days and hours configuration
days[]ModelEach itemExpand 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_fromstringRequired within parentDate and time when the contract's work schedule became effective.
employment_typeJSONOptionalType of employment arrangement
employment_type (anyOf 1)stringAlternativeType of employment arrangement
Known values: FULL_TIME, PART_TIME, CONTRACT, TEMPORARY
employment_type (anyOf 2)nullAlternative
namestringRequired within parentUnique identifier or name for the work schedule
Maximum length: 50
work_hours_per_weekJSONRequired within parent
work_hours_per_week (anyOf 1)integerAlternativeTotal number of working hours per week
Maximum: 168
Minimum: 1
work_hours_per_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
work_schedule_typestringRequired within parentWork schedule type
worker_typesarrayRequired within parentList of worker types that can use this schedule
worker_types[]stringEach itemKnown values: SALARIED_DIRECT_EMPLOYEE_PAYROLL, SALARIED_HRIS_DIRECT_EMPLOYEE, SALARIED_EOR_EMPLOYEE, HOURLY_EOR_EMPLOYEE, HOURLY_DIRECT_EMPLOYEE_PAYROLL

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRootDefines working hours for a specific day of the week
daystringRequired within parentDay of the week
Known values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
endJSONRequired within parent
end (anyOf 1)stringAlternativeEnd 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)nullAlternativeEnd 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]$
startstringRequired within parentStart 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_hoursstringRequired within parentNumber of working hours for this day

Retrieve a single contract — 200 response body — data worker Worker details associated with the contract

FieldTypePresenceDescription and constraints
$objectRootWorker details associated with the contract.
alternate_emailJSONOptional
alternate_email (anyOf 1)arrayAlternativeList of alternate email addresses.
alternate_email (anyOf 1)[]ModelEach itemExpand 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)nullAlternativeList of alternate email addresses.
alternate_email (anyOf 2)[]ModelEach itemExpand Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the worker.
country (anyOf 2)nullAlternativeCountry of the worker.
date_of_birthModelOptionalExpand Retrieve a single contract — 200 response body — data worker Worker details associated with the contract date of birth
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
email (anyOf 2)nullAlternativeUser's email address.
Minimum length: 5
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+(_no_mail|_archived)?$
expected_emailstringOptionalExpected email address of the worker (e.g., invitation target email).
first_namestringOptionalFirst name of the worker.
full_namestringOptionalFull name of the client.
idstringOptionalUnique identifier of this resource.
last_namestringOptionalLast name of the worker.
nationalityJSONOptional
nationality (anyOf 1)stringAlternativeNationality of the worker.
nationality (anyOf 2)nullAlternativeNationality 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternativeFormat: date
$ (anyOf 2)stringAlternativeMaximum length: 0

Retrieve contract PDF download link — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
urlstringRequired within parentA pre-signed URL to download the PDF version of the specified contract
Format: uri

Retrieve contract templates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
titlestringRequired within parentThe title of a contract template.

Referenced models: Retrieve a single milestone — 200 response body — data id

Sign Amendment — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Sign Amendment — 201 response body — data

Referenced models: Sign Amendment — 201 response body — data

Sign Amendment — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the signed amendment.
is_signedbooleanRequired within parentIndicates whether the amendment was successfully signed.

Sign Amendment — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
contractor_signaturestringRequired within parentThe signature of the worker signing the amendment.
Minimum length: 2

Sign worker contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Sign worker contract — 201 response body — data

Referenced models: Sign worker contract — 201 response body — data

Sign worker contract — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe timestamp when the contract was created.
Format: date-time
idstringRequired within parentThe unique identifier of the signed contract.
is_signedbooleanRequired within parentIndicates whether the contract was successfully signed.
updated_atstringRequired within parentThe timestamp when the contract was last updated.
Format: date-time

Sign worker contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
worker_signaturestringRequired within parentSignature of the worker for the contract

Submit Global Payroll amendment signature — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique identifier of the signed amendment.
Format: uuid
is_signedbooleanRequired within parentIndicates whether the amendment was successfully signed.

Submit Global Payroll amendment signature — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
client_signaturestringRequired within parentThe client's signature for the amendment.
Minimum length: 2

Update contract payment type — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootThe updated contract. See `GET /contracts/{contract_id}` for the full response shape.
idstringOptionalUnique identifier for the contract.
platform_payment_typestringOptionalWhether 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

FieldTypePresenceDescription and constraints
$objectRoot
platform_payment_typestringRequired within parentWhether 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_typestringOptionalWhen to apply the change. Required when changing `platform_payment_type` on a signed contract.
One of: IMMEDIATELY, NEXT_PAYMENT_CYCLE

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.