Skip to content

Deel: Contracts schemas (part 1)

82 Deel schemas with complete fields and constraints.

← Contracts operations · All schemas

Add external Id — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
clientJSONRequired within parentClient details associated with the contract.
client (anyOf 1)ModelAlternativeExpand Add external Id — 200 response body — 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 Create a new contract — 201 response body — data custom fields item
custom_fields (anyOf 2)nullAlternativeList of custom fields attached to the contract.
custom_fields (anyOf 2)[]ModelEach itemExpand Create a new contract — 201 response body — data custom fields item
employment_detailsModelOptionalExpand Add external Id — 200 response body — 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.
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.
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
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 Add external Id — 200 response body — work schedule country, days, 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 Add external Id — 200 response body — worker Worker details associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: Add external Id — 200 response body — contract template Contract template details, Create a new contract — 201 response body — data custom fields item, Add external Id — 200 response body — compensation details, Add external Id — 200 response body — cost centers item, 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, Add external Id — 200 response body — client Client details associated with the contract, Add external Id — 200 response body — employment details, Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types, Add external Id — 200 response body — worker Worker details associated with the contract

Add external Id — 200 response body — client Client details associated with the contract

FieldTypePresenceDescription and constraints
$objectRootClient details associated with the contract.
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding.
email (anyOf 2)nullAlternativeUser's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding.
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

Add external Id — 200 response body — client Client details associated with the contract legal entity Legal entity details of the client

FieldTypePresenceDescription and constraints
$objectRootLegal entity details of the client.
emailJSONOptional
email (anyOf 1)stringAlternativeEmail address of the legal entity.
email (anyOf 2)nullAlternativeEmail address of the legal entity.
idstringOptionalUnique identifier of this resource.
namestringOptionalName of a team.
registration_numberJSONOptional
registration_number (anyOf 1)stringAlternativeRegistration number of the legal entity.
registration_number (anyOf 2)nullAlternativeRegistration number of the legal entity.
subtypeJSONOptional
subtype (anyOf 1)stringAlternativeSub-type of the legal entity.
subtype (anyOf 2)nullAlternativeSub-type of the legal entity.
typeJSONOptional
type (anyOf 1)stringAlternativeType of the legal entity.
type (anyOf 2)nullAlternativeType of the legal entity.
vat_numberJSONOptional
vat_number (anyOf 1)stringAlternativeVAT number of the legal entity.
vat_number (anyOf 2)nullAlternativeVAT number of the legal entity.

Add external Id — 200 response body — client Client details associated with the contract team

FieldTypePresenceDescription and constraints
$objectRootTeam information for the client organization.
idModelRequired within parentExpand Add external Id — 200 response body — client Client details associated with the contract team id
Unique identifier of this resource.
namestringRequired within parentName of a team.

Referenced models: Add external Id — 200 response body — client Client details associated with the contract team id

Add external Id — 200 response body — client Client details associated with the contract team id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of this resource.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Add external Id — 200 response body — compensation details

FieldTypePresenceDescription and constraints
$objectRootCompensation and payment configuration for the contract.
amountJSONOptional
amount (anyOf 1)stringAlternativeAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
amount (anyOf 2)nullAlternativeAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
currency_codeJSONOptional
currency_code (anyOf 1)stringAlternativeCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
currency_code (anyOf 2)nullAlternativeCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endJSONOptional
cycle_end (anyOf 1)JSONAlternative
cycle_end (anyOf 1) (anyOf 1)numberAlternativeDay of the cycle end
Format: double
cycle_end (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cycle_end (anyOf 2)nullAlternativeDay of the cycle end
Format: double
cycle_end_typeJSONOptionalCycle end type
cycle_end_type (anyOf 1)stringAlternativeCycle end type
Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
cycle_end_type (anyOf 2)nullAlternative
first_paymentJSONOptional
first_payment (anyOf 1)stringAlternativeFirst payment amount.
first_payment (anyOf 2)nullAlternativeFirst payment amount.
first_payment_dateJSONOptional
first_payment_date (anyOf 1)stringAlternativeFirst payment date.
first_payment_date (anyOf 2)nullAlternativeFirst payment date.
frequencystringOptionalScale of the invoice cycle.
gross_annual_salaryJSONOptional
gross_annual_salary (anyOf 1)stringAlternativeGross annual salary.
gross_annual_salary (anyOf 2)nullAlternativeGross annual salary.
gross_signing_bonusJSONOptional
gross_signing_bonus (anyOf 1)stringAlternativeGross signing bonus.
gross_signing_bonus (anyOf 2)nullAlternativeGross signing bonus.
gross_variable_bonusJSONOptional
gross_variable_bonus (anyOf 1)stringAlternativeGross variable bonus.
gross_variable_bonus (anyOf 2)nullAlternativeGross variable bonus.
scaleJSONOptional
scale (anyOf 1)stringAlternativeScale of the payment.
scale (anyOf 2)nullAlternativeScale of the payment.

Add external Id — 200 response body — contract template Contract template details

FieldTypePresenceDescription and constraints
$objectRootContract template details.
idstringOptionalUnique identifier of a contract template.
titlestringOptionalTitle of a contract template

Add external Id — 200 response body — cost centers item

FieldTypePresenceDescription and constraints
$objectRoot
allocation_percentageJSONOptional
allocation_percentage (anyOf 1)numberAlternativePercentage of the cost center allocation.
Format: double
allocation_percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalCost center name.
numberstringOptionalCost center number.

Add external Id — 200 response body — 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]+)?$
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.

Add external Id — 200 response body — invitations

FieldTypePresenceDescription and constraints
$objectRootInvitation email addresses for signing the contract.
client_emailJSONOptional
client_email (anyOf 1)stringAlternativeUser's email address.
client_email (anyOf 2)nullAlternativeUser's email address.
worker_emailJSONOptional
worker_email (anyOf 1)stringAlternativeUser's email address.
worker_email (anyOf 2)nullAlternativeUser's email address.

Add external Id — 200 response body — quote

FieldTypePresenceDescription and constraints
$objectRootEOR quote approved by Deel.
benefitsarrayOptionalArray of benefits.
benefits[]ModelEach itemExpand Add external Id — 200 response body — quote benefits item
currencystringOptionalCurrency used for the quote.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$

Referenced models: Add external Id — 200 response body — quote benefits item

Add external Id — 200 response body — quote benefits item

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
feeJSONOptional
fee (anyOf 1)numberAlternativeFee in local currency.
Format: double
fee (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fee_usdJSONOptional
fee_usd (anyOf 1)numberAlternativeFee in USD.
Format: double
fee_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalBenefit's name.
planstringOptionalBenefit's plan.
priceJSONOptional
price (anyOf 1)numberAlternativePrice in local currency.
Format: double
price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price_usdJSONOptional
price_usd (anyOf 1)numberAlternativePrice in USD.
Format: double
price_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Add external Id — 200 response body — seniority id, level, name

FieldTypePresenceDescription and constraints
$objectRootSeniority describes level of expertise at a job e.g. junior.
idJSONOptional
id (anyOf 1)JSONAlternative
id (anyOf 1) (anyOf 1)numberAlternativeUnique identifier of this resource.
Format: double
id (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)nullAlternativeUnique identifier of this resource.
Format: double
levelJSONOptional
level (anyOf 1)JSONAlternative
level (anyOf 1) (anyOf 1)numberAlternativeLevel of seniority level e.g. 2.
Format: double
level (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
level (anyOf 2)nullAlternativeLevel of seniority level e.g. 2.
Format: double
nameJSONOptional
name (anyOf 1)stringAlternativeName of seniority level e.g. Mid (Individual Contributor Level 2).
name (anyOf 2)nullAlternativeName of seniority level e.g. Mid (Individual Contributor Level 2).

Add external Id — 200 response body — signatures

FieldTypePresenceDescription and constraints
$objectRootSignature information for the contract parties.
client_signaturestringOptionalClient representative signature (typically a name).
client_signed_atJSONOptional
client_signed_at (anyOf 1)stringAlternativeDate and time when the client signed the contract.
Format: date-time
client_signed_at (anyOf 2)nullAlternativeDate and time when the client signed the contract.
Format: date-time
signed_atJSONOptional
signed_at (anyOf 1)stringAlternativeDate and time when the contract was signed.
Format: date-time
signed_at (anyOf 2)nullAlternativeDate and time when the contract was signed.
Format: date-time
worker_signaturestringOptionalWorker signature (typically a name).
worker_signed_atJSONOptional
worker_signed_at (anyOf 1)stringAlternativeDate and time when the worker signed the contract.
Format: date-time
worker_signed_at (anyOf 2)nullAlternativeDate and time when the worker signed the contract.
Format: date-time

Add external Id — 200 response body — status

FieldTypePresenceDescription and constraints
$stringRootStatus of a contract in Deel workflow.
Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding, waiting_for_approval, onboarded

Add external Id — 200 response body — work schedule country, days, 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 Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types days item
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: Add external Id — 200 response body — work schedule country, days, employment type, name, work hours per week, work schedule type, worker types days item

Add external Id — 200 response body — work schedule country, days, 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, local time without offset)
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, local time without offset)
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, local time without offset)
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

Add external Id — 200 response body — 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 Add external Id — 200 response body — worker Worker details associated with the contract date of birth
Date of birth of the worker. Supports full date-time, date-only, or an empty string.
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Format: email
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Format: email
Minimum length: 5
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, Add external Id — 200 response body — worker Worker details associated with the contract date of birth

Add external Id — 200 response body — worker Worker details associated with the contract alternate email List of alternate email addresses item

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalEmail address of the worker.
isVerifiedbooleanOptionalIndicates whether this alternate email address has been verified.

Add external Id — 200 response body — worker Worker details associated with the contract date of birth

FieldTypePresenceDescription and constraints
$JSONRootDate of birth of the worker. Supports full date-time, date-only, or an empty string.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeFormat: date
$ (anyOf 3)stringAlternativeEmpty string for unknown/unset values.
Known values: "" (empty string)

Add external Id — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
external_idstring or nullRequired within parentA unique identifier for the object provided by an external system. Use or send null when you want to reset the external id.

Approve an equity exercise — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date when the equity exercise was created.
Format: date
employer_approvalstringRequired within parentIndicates whether the employer has approved the equity exercise. Valid values: 'approved', 'rejected'.
idstringRequired within parentUnique identifier of the equity exercise.
Format: uuid
statusstringRequired within parentThe current status of the equity exercise, e.g., 'approved' or 'pending'.
updated_atstringRequired within parentThe date when the equity exercise was last updated.
Format: date

Create a new contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a new contract — 201 response body — data

Referenced models: Create a new contract — 201 response body — data

Create a new contract — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
clientJSONRequired within parentClient details associated with the contract.
client (anyOf 1)ModelAlternativeExpand Create a new contract — 201 response body — data client Client details associated with the contract
client (anyOf 2)nullAlternative
compensation_detailsModelRequired within parentExpand Create a new contract — 201 response body — data compensation details
Compensation configuration and payment schedule details for the contract.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
created_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
custom_fieldsarrayOptionalCustom fields attached to the contract.
custom_fields[]ModelEach itemExpand Create a new contract — 201 response body — data custom fields item
employment_detailsModelRequired within parentExpand Create a new contract — 201 response body — data employment details
Employment-related details for the contract, when applicable.
external_idJSONOptional
external_id (anyOf 1)stringAlternativeA unique identifier for the object provided by an external system.
external_id (anyOf 2)nullAlternativeA unique identifier for the object provided by an external system.
idstringRequired within parentThe public id of the object
invitationsModelRequired within parentExpand Create a new contract — 201 response body — data invitations
List of signature invitations sent for this contract.
is_archivedbooleanRequired within parentFlag to indicate if the contract is archived
job_titlestringRequired within parentJob title associated with the contract.
notice_periodJSONOptional
notice_period (anyOf 1)numberAlternativeDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
notice_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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
quoteModelOptionalExpand Create a new contract — 201 response body — data quote
EOR quote approved by Deel
scope_of_workJSONOptional
scope_of_work (anyOf 1)stringAlternativeScope of work for the contract
scope_of_work (anyOf 2)nullAlternativeScope of work for the contract
seniorityJSONOptionalSeniority describes level of expertise at a job e.g. junior
seniority (anyOf 1)ModelAlternativeExpand Create a new contract — 201 response body — data seniority id, level, name
seniority (anyOf 2)nullAlternative
signaturesModelRequired within parentExpand Create a new contract — 201 response body — data signatures
List of signatures recorded for this contract.
special_clausestringRequired within parentSpecial clause for the contract
start_dateJSONRequired within parent
start_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
start_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
statusstringRequired within parentStatus of a contract in Deel workflow
Known values: new, under_review, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment
termination_dateModelRequired within parentExpand Create a new contract — 201 response body — data termination date
Contract termination date. When present, it is a date-time string in ISO-8601 format.
titlestringRequired within parentTitle of a 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, eor, unknown, employee, global_payroll, shield_msa, hris_direct_employee
who_reportsstringOptionalFlag to indicate who is supposed to provide regular reports
Known values: both, client, contractor, "" (empty string)
work_statement_idstringRequired within parentThe public unique identifier of the work statement
workerJSONRequired within parentWorker details associated with the contract.
worker (anyOf 1)ModelAlternativeExpand Create a new contract — 201 response body — data worker Worker details associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: Create a new contract — 201 response body — data custom fields item, Create a new contract — 201 response body — data client Client details associated with the contract, Create a new contract — 201 response body — data compensation details, Create a new contract — 201 response body — data employment details, Create a new contract — 201 response body — data invitations, Create a new contract — 201 response body — data quote, Create a new contract — 201 response body — data seniority id, level, name, Create a new contract — 201 response body — data signatures, Create a new contract — 201 response body — data termination date, Create a new contract — 201 response body — data worker Worker details associated with the contract

Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company

FieldTypePresenceDescription and constraints
$objectRootLegal entity information for the client organization.
emailJSONRequired within parent
email (anyOf 1)stringAlternativeUser's email address.
email (anyOf 2)nullAlternativeUser's email address.
idstringRequired within parentUnique identifier of this resource.
namestringRequired within parentName of a legal entity
registration_numberstringRequired within parentRegistration number of a legal entity
subtypestringRequired within parentSubtype of a legal entity
typestringRequired within parentType of a legal entity
Known values: individual, company
vat_numberstringRequired within parentVAT number of a legal entity

Create a new contract — 201 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.
Format: email
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Format: email
Minimum length: 5
full_namestringOptionalUser's full name.
idstringOptionalUnique identifier of this resource.
legal_entityJSONRequired within parentLegal entity information for the client organization.
legal_entity (anyOf 1)ModelAlternativeExpand Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company
legal_entity (anyOf 2)nullAlternative
teamModelRequired within parentExpand Create a new contract — 201 response body — data client Client details associated with the contract team
Team information for the client organization.

Referenced models: Create a new contract — 201 response body — data client Client details associated with the contract team, Create a new contract — 201 response body — data / client / Client details associated with the contract / legal_entity / type: individual, company

Create a new contract — 201 response body — data client Client details associated with the contract team

FieldTypePresenceDescription and constraints
$objectRootTeam information for the client organization.
idstringRequired within parentUnique identifier of this resource.
namestringRequired within parentName of a team

Create a new contract — 201 response body — data compensation details

FieldTypePresenceDescription and constraints
$objectRootCompensation configuration and payment schedule details for the contract.
amountJSONRequired within parent
amount (anyOf 1)stringAlternativeAmount of compensation
amount (anyOf 2)nullAlternativeAmount of compensation
currency_codestringRequired within parentCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
first_paymentJSONRequired within parent
first_payment (anyOf 1)stringAlternativeFirst payment
first_payment (anyOf 2)nullAlternativeFirst payment
first_payment_dateJSONRequired within parent
first_payment_date (anyOf 1)stringAlternativeLong date-time format following ISO-8601
first_payment_date (anyOf 2)nullAlternativeLong date-time format following ISO-8601
frequencystringRequired within parentFrequency of compensation
gross_annual_salaryJSONRequired within parent
gross_annual_salary (anyOf 1)stringAlternativeGross annual salary
gross_annual_salary (anyOf 2)nullAlternativeGross annual salary
gross_signing_bonusJSONRequired within parent
gross_signing_bonus (anyOf 1)stringAlternativeGross signing bonus
gross_signing_bonus (anyOf 2)nullAlternativeGross signing bonus
gross_variable_bonusJSONRequired within parent
gross_variable_bonus (anyOf 1)stringAlternativeGross variable bonus
gross_variable_bonus (anyOf 2)nullAlternativeGross variable bonus
scalestringRequired within parentScale of compensation

Create a new contract — 201 response body — data custom fields item

FieldTypePresenceDescription and constraints
$objectRootCustomized attributes on contracts (Employee ID, Project code, etc).
namestringOptionalCustom field property name.
valuestringOptionalCustom field property value.

Create a new contract — 201 response body — data employment details

FieldTypePresenceDescription and constraints
$objectRootEmployment-related details for the contract, when applicable.
countrystringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
days_per_weekJSONRequired within parent
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_dayJSONRequired within parent
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_daysJSONRequired within parent
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_periodJSONRequired within parent
probation_period (anyOf 1)JSONAlternative
probation_period (anyOf 1) (anyOf 1)numberAlternativeNumber of days for probation period
Format: double
probation_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period (anyOf 2)nullAlternativeNumber of days for probation period
Format: double
stateJSONOptional
state (anyOf 1)stringAlternativeState code.
state (anyOf 2)nullAlternativeState code.
typestringRequired within parentEmployment type classification for the contract.

Create a new contract — 201 response body — data invitations

FieldTypePresenceDescription and constraints
$objectRootList of signature invitations sent for this contract.
client_emailJSONOptional
client_email (anyOf 1)stringAlternativeUser's email address.
client_email (anyOf 2)nullAlternativeUser's email address.
worker_emailJSONOptional
worker_email (anyOf 1)stringAlternativeUser's email address.
worker_email (anyOf 2)nullAlternativeUser's email address.

Create a new contract — 201 response body — data quote

FieldTypePresenceDescription and constraints
$objectRootEOR quote approved by Deel
annual_salaryJSONOptional
annual_salary (anyOf 1)numberAlternativeAnnual Salary in local currency
Format: double
annual_salary (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
benefitsarrayOptionalArray of benefits
benefits[]ModelEach itemExpand Create a new contract — 201 response body — data quote benefits item
breakdown_costsModelOptionalExpand Create a new contract — 201 response body — data quote breakdown costs
Cost breakdown for the quote, grouped by billing cadence (e.g., monthly).
cba_totalJSONOptional
cba_total (anyOf 1)numberAlternativeTotal CBA in local currency
Format: double
cba_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
cba_total_usdJSONOptional
cba_total_usd (anyOf 1)numberAlternativeTotal CBA in USD
Format: double
cba_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
created_atJSONOptional
created_at (anyOf 1)stringAlternativeShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
created_at (anyOf 2)nullAlternativeShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
currencystringOptionalCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
employer_cost_totalJSONOptional
employer_cost_total (anyOf 1)numberAlternativeTotal employer cost in local currency
Format: double
employer_cost_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
employer_cost_total_usdJSONOptional
employer_cost_total_usd (anyOf 1)numberAlternativeTotal employer cost in USD
Format: double
employer_cost_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gross_salary_totalJSONOptional
gross_salary_total (anyOf 1)numberAlternativeTotal gross salary in local currency
Format: double
gross_salary_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
gross_salary_total_usdJSONOptional
gross_salary_total_usd (anyOf 1)numberAlternativeTotal gross salary in USD
Format: double
gross_salary_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mobility_fee_totalJSONOptional
mobility_fee_total (anyOf 1)numberAlternativeTotal mobility fee in local currency
Format: double
mobility_fee_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mobility_fee_total_usdJSONOptional
mobility_fee_total_usd (anyOf 1)numberAlternativeTotal mobility fee in USD
Format: double
mobility_fee_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthly_cost_totalJSONOptional
monthly_cost_total (anyOf 1)numberAlternativeTotal monthly cost in local currency
Format: double
monthly_cost_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
monthly_cost_total_usdJSONOptional
monthly_cost_total_usd (anyOf 1)numberAlternativeTotal monthly cost in USD
Format: double
monthly_cost_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
platform_fee_totalJSONOptional
platform_fee_total (anyOf 1)numberAlternativeTotal platform fee in local currency
Format: double
platform_fee_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
platform_fee_total_usdJSONOptional
platform_fee_total_usd (anyOf 1)numberAlternativeTotal platform fee in USD
Format: double
platform_fee_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurring_allowance_totalJSONOptional
recurring_allowance_total (anyOf 1)numberAlternativeTotal recurring allowance in local currency
Format: double
recurring_allowance_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
recurring_allowance_total_usdJSONOptional
recurring_allowance_total_usd (anyOf 1)numberAlternativeTotal recurring allowance in USD
Format: double
recurring_allowance_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salary_totalJSONOptional
salary_total (anyOf 1)numberAlternativeTotal salary in local currency
Format: double
salary_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
salary_total_usdJSONOptional
salary_total_usd (anyOf 1)numberAlternativeTotal salary in USD
Format: double
salary_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
severance_accrual_totalJSONOptional
severance_accrual_total (anyOf 1)numberAlternativeTotal severance accrual in local currency
Format: double
severance_accrual_total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
severance_accrual_total_usdJSONOptional
severance_accrual_total_usd (anyOf 1)numberAlternativeTotal severance accrual in USD
Format: double
severance_accrual_total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updated_atJSONOptional
updated_at (anyOf 1)stringAlternativeShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
updated_at (anyOf 2)nullAlternativeShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$

Referenced models: Create a new contract — 201 response body — data quote benefits item, Create a new contract — 201 response body — data quote breakdown costs

Create a new contract — 201 response body — data quote benefits item

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
feeJSONOptional
fee (anyOf 1)numberAlternativeFee in local currency
Format: double
fee (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fee_usdJSONOptional
fee_usd (anyOf 1)numberAlternativeFee in USD
Format: double
fee_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalBenefit's name
planstringOptionalBenefit's plan
priceJSONOptional
price (anyOf 1)numberAlternativePrice in local currency
Format: double
price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
price_usdJSONOptional
price_usd (anyOf 1)numberAlternativePrice in USD
Format: double
price_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a new contract — 201 response body — data quote breakdown costs

FieldTypePresenceDescription and constraints
$objectRootCost breakdown for the quote, grouped by billing cadence (e.g., monthly).
monthlyModelOptionalExpand Create a new contract — 201 response body — data quote breakdown costs monthly
Monthly cost breakdown for the quote.

Referenced models: Create a new contract — 201 response body — data quote breakdown costs monthly

Create a new contract — 201 response body — data quote breakdown costs monthly

FieldTypePresenceDescription and constraints
$objectRootMonthly cost breakdown for the quote.
costsarrayOptionalList of individual monthly cost line items included in the quote.
costs[]ModelEach itemExpand Create a new contract — 201 response body — data quote breakdown costs monthly costs item
totalJSONOptional
total (anyOf 1)numberAlternativeTotal costs in local currency
Format: double
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_usdJSONOptional
total_usd (anyOf 1)numberAlternativeTotal costs in USD
Format: double
total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create a new contract — 201 response body — data quote breakdown costs monthly costs item

Create a new contract — 201 response body — data quote breakdown costs monthly costs item

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
namestringOptionalCost's name
totalJSONOptional
total (anyOf 1)numberAlternativeTotal cost in local currency
Format: double
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_usdJSONOptional
total_usd (anyOf 1)numberAlternativeTotal cost in USD
Format: double
total_usd (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create a new contract — 201 response body — data seniority id, level, name

FieldTypePresenceDescription and constraints
$objectRootSeniority describes level of expertise at a job e.g. junior
idJSONRequired within parent
id (anyOf 1)numberAlternativeUnique identifier of this resource.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
levelJSONOptional
level (anyOf 1)JSONAlternative
level (anyOf 1) (anyOf 1)numberAlternativeLevel of seniority level e.g. 2
Format: double
level (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
level (anyOf 2)nullAlternativeLevel of seniority level e.g. 2
Format: double
namestringRequired within parentName of seniority level e.g. Mid (Individual Contributor Level 2)
Minimum length: 1

Create a new contract — 201 response body — data signatures

FieldTypePresenceDescription and constraints
$objectRootList of signatures recorded for this contract.
client_signaturestringRequired within parentnormally name of client is used as signature
client_signed_atJSONRequired within parent
client_signed_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
client_signed_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
signed_atJSONRequired within parent
signed_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
signed_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
worker_signaturestringRequired within parentSignatures of client representative.
worker_signed_atJSONRequired within parent
worker_signed_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
worker_signed_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601

Create a new contract — 201 response body — data termination date

FieldTypePresenceDescription and constraints
$JSONRootContract termination date. When present, it is a date-time string in ISO-8601 format.
$ (anyOf 1)stringAlternativeFormat: date-time
$ (anyOf 2)stringAlternativeKnown values: "" (empty string)

Create a new contract — 201 response body — data worker Worker details associated with the contract

FieldTypePresenceDescription and constraints
$objectRootWorker details associated with the contract.
alternate_emailarrayOptionalList of alternate email addresses.
alternate_email[]ModelEach itemExpand Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item
countryJSONOptional
country (anyOf 1)stringAlternativeWorker's country (location not nationality)
country (anyOf 2)nullAlternativeWorker's country (location not nationality)
date_of_birthJSONOptional
date_of_birth (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Format: date-time
date_of_birth (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Format: date-time
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Format: email
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Format: email
Minimum length: 5
expected_emailJSONOptional
expected_email (anyOf 1)stringAlternativeWorker's email address.
Format: email
Minimum length: 5
expected_email (anyOf 2)nullAlternativeWorker's email address.
Format: email
Minimum length: 5
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeWorker's first name
Maximum length: 255
first_name (anyOf 2)nullAlternativeWorker's first name
Maximum length: 255
full_namestringOptionalWorker's full name.
Minimum length: 1
idJSONOptional
id (anyOf 1)stringAlternativeA unique identifier for this resource.
id (anyOf 2)nullAlternativeA unique identifier for this resource.
imagestringOptionalURL to worker's image
Format: url
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeWorker's last name
Maximum length: 255
last_name (anyOf 2)nullAlternativeWorker's last name
Maximum length: 255
legal_entityModelOptionalExpand Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity
Worker legal entity information, if applicable.
nationalityJSONOptional
nationality (anyOf 1)stringAlternativeWorker's nationality.
nationality (anyOf 2)nullAlternativeWorker's nationality.

Referenced models: Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item, Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity

Create a new contract — 201 response body — data worker Worker details associated with the contract alternate email item

FieldTypePresenceDescription and constraints
$objectRoot
emailJSONRequired within parent
email (anyOf 1)stringAlternativeUser's email address.
Format: email
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Format: email
Minimum length: 5
isVerifiedbooleanRequired within parentTrue if email has been verified

Create a new contract — 201 response body — data worker Worker details associated with the contract legal entity

FieldTypePresenceDescription and constraints
$objectRootWorker legal entity information, if applicable.
personal_namestringRequired within parentName of a legal entity
registration_numberstringRequired within parentRegistration number of a legal entity
typestringRequired within parentType of a legal entity
Known values: individual, company

Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor

FieldTypePresenceDescription and constraints
$objectRootDetails of contract to create
citizenshipstring or nullOptionalISO 3166-1 alpha-2 country code of the worker's citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
clientModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client
Client details for the contract, including the legal entity and team.
compensation_detailsModelRequired within parentExpand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details
Compensation and invoicing configuration for the contract.
contract_template_idstring or nullOptionalContract Template Id.
country_codestringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
external_idstring or nullOptionalExternal Id.
job_titleModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
metaModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta
Additional custom info about a contract
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
platform_payment_typestringOptionalWhether the contract is paid through Deel (`STANDARD`) or outside Deel (`OFF_PLATFORM`). Applies to IC contracts only.
One of: STANDARD, OFF_PLATFORM
scope_of_workstring or nullOptionalDescribe the work to be performed.
scope_of_work_idstring or nullOptionalExisting scope of work public id
Format: uuid
seniorityJSONOptionalJob seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
seniority (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id
seniority (oneOf 2)nullAlternative
special_clausestring or nullOptionalEnter any special clause you may have.
start_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
state_codestring or nullOptionalThe state or province code. Use country lookup endpoint to retrieve state codes.
termination_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
titlestringRequired within parentThe title of the contract.
typestringRequired within parentType of contract
One of: pay_as_you_go_time_based
who_reportsstringOptionalFlag to indicate who is supposed to provide regular reports
One of: both, client, contractor
workerJSONOptionalWorker properties
worker (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
worker (oneOf 2)nullAlternative

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties

Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor

FieldTypePresenceDescription and constraints
$objectRootDetails of contract to create
citizenshipstring or nullOptionalISO 3166-1 alpha-2 country code of the worker's citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
clientModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client
Client details for the contract, including the legal entity and team.
compensation_detailsModelRequired within parentExpand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details
Compensation and invoicing configuration for the contract.
contract_template_idstring or nullOptionalContract Template Id.
country_codestringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
external_idstring or nullOptionalExternal Id.
job_titleModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
metaModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta
Additional custom info about a contract
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
scope_of_workstring or nullOptionalDescribe the work to be performed.
scope_of_work_idstring or nullOptionalExisting scope of work public id
Format: uuid
seniorityJSONOptionalJob seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
seniority (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id
seniority (oneOf 2)nullAlternative
special_clausestring or nullOptionalEnter any special clause you may have.
start_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
state_codestring or nullOptionalThe state or province code. Use country lookup endpoint to retrieve state codes.
termination_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
titlestringRequired within parentThe title of the contract.
typestringRequired within parentType of contract
One of: ongoing_time_based
who_reportsstringOptionalFlag to indicate who is supposed to provide regular reports
One of: both, client, contractor
workerJSONOptionalWorker properties
worker (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
worker (oneOf 2)nullAlternative

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties

Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor compensation details

FieldTypePresenceDescription and constraints
$objectRootCompensation and invoicing configuration for the contract.
amountnumberRequired within parentAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
Format: double
currency_codestringRequired within parentCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endnumberOptionalDate invoice cycle ends.
Format: double
Maximum: 31
Minimum: 1
cycle_end_typestringOptionalCycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
first_paymentnumberOptionalFirst payment amount.
Default: 0
Format: double
Minimum: 0
first_payment_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
frequencystringOptionalScale of the invoice cycle.
One of: weekly, monthly, biweekly, semimonthly, calendar-month
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
pay_before_weekendsbooleanOptionalIf the payment due is on a weekend, pay on Friday.
payment_due_daysnumberOptionalNumber of days to pay the invoice.
Format: double
Maximum: 90
Minimum: 0
payment_due_typestringOptionalType of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.
Default: REGULAR
One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END
payment_policy_idstringOptionalID of a pre-configured payment policy. When provided, the payment schedule is derived from the policy and the individual payment fields (frequency, cycle_end, cycle_end_type, payment_due_type, payment_due_days, pay_before_weekends) must be omitted. Mutually exclusive with those individual fields.
Format: uuid
scalestringRequired within parentDefines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
One of: hourly, daily, weekly, monthly, biweekly, semimonthly, custom

Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor

FieldTypePresenceDescription and constraints
$objectRootDetails of contract to create
citizenshipstring or nullOptionalISO 3166-1 alpha-2 country code of the worker's citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
clientModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client
Client details for the contract, including the legal entity and team.
compensation_detailsModelRequired within parentExpand Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details
Compensation and invoicing configuration for the contract.
contract_template_idstring or nullOptionalContract Template Id.
country_codestringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
external_idstring or nullOptionalExternal Id.
job_titleModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
metaModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta
Additional custom info about a contract
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
scope_of_workstring or nullOptionalDescribe the work to be performed.
scope_of_work_idstring or nullOptionalExisting scope of work public id
Format: uuid
seniorityJSONOptionalJob seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
seniority (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id
seniority (oneOf 2)nullAlternative
special_clausestring or nullOptionalEnter any special clause you may have.
start_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
state_codestring or nullOptionalThe state or province code. Use country lookup endpoint to retrieve state codes.
termination_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
titlestringRequired within parentThe title of the contract.
typestringRequired within parentType of contract
One of: payg_milestones
who_reportsstringOptionalFlag to indicate who is supposed to provide regular reports
One of: both, client, contractor
workerJSONOptionalWorker properties
worker (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
worker (oneOf 2)nullAlternative

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties, Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details

Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor compensation details

FieldTypePresenceDescription and constraints
$objectRootCompensation and invoicing configuration for the contract.
amountnumberOptionalAmount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.
Format: double
currency_codestringRequired within parentCurrency code.
Maximum length: 3
Minimum length: 3
Pattern: ^[A-Z]{3}$
cycle_endnumberRequired within parentDate invoice cycle ends.
Format: double
Maximum: 31
Minimum: 1
cycle_end_typestringRequired within parentCycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.
One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
first_paymentnumberOptionalFirst payment amount.
Default: 0
Format: double
Minimum: 0
first_payment_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
frequencystringRequired within parentScale of the invoice cycle.
One of: weekly, monthly, biweekly, semimonthly, calendar-month
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
pay_before_weekendsbooleanOptionalIf the payment due is on a weekend, pay on Friday.
payment_due_daysnumberRequired within parentNumber of days to pay the invoice.
Format: double
Maximum: 90
Minimum: 0
payment_due_typestringRequired within parentType of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.
Default: REGULAR
One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor

FieldTypePresenceDescription and constraints
$objectRootDetails of contract to create
citizenshipstring or nullOptionalISO 3166-1 alpha-2 country code of the worker's citizenship.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
clientModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client
Client details for the contract, including the legal entity and team.
compensation_detailsModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details
Compensation and invoicing configuration for the contract.
contract_template_idstring or nullOptionalContract Template Id.
country_codestringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
external_idstring or nullOptionalExternal Id.
job_titleModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title
Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
metaModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta
Additional custom info about a contract
notice_periodnumberOptionalDays before to notice the termination of contract for either party.
Default: 10
Format: double
Minimum: 0
scope_of_workstring or nullOptionalDescribe the work to be performed.
scope_of_work_idstring or nullOptionalExisting scope of work public id
Format: uuid
seniorityJSONOptionalJob seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
seniority (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id
seniority (oneOf 2)nullAlternative
special_clausestring or nullOptionalEnter any special clause you may have.
start_datestringRequired within parentShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
state_codestring or nullOptionalThe state or province code. Use country lookup endpoint to retrieve state codes.
termination_datestring or nullOptionalShort date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.
Format: date
Pattern: ^\d{4}-\d{2}-\d{2}$
titlestringRequired within parentThe title of the contract.
typestringRequired within parentType of contract
One of: payg_tasks
who_reportsstringOptionalFlag to indicate who is supposed to provide regular reports
One of: both, client, contractor
workerJSONOptionalWorker properties
worker (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties
worker (oneOf 2)nullAlternative

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client

FieldTypePresenceDescription and constraints
$objectRootClient details for the contract, including the legal entity and team.
legal_entityModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity
Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
teamModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team
Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client legal entity

FieldTypePresenceDescription and constraints
$objectRootChoose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.
idModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Unique identifier of this resource.

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor client team

FieldTypePresenceDescription and constraints
$objectRootChoose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.
idModelRequired within parentExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Unique identifier of this resource.

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor compensation details

FieldTypePresenceDescription and constraints
$JSONRootCompensation and invoicing configuration for the contract.
$ (oneOf 1)JSONAlternativeAny type
$ (oneOf 2)JSONAlternativeAny type

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title

FieldTypePresenceDescription and constraints
$objectRootWorker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.
idModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Unique identifier of this resource.
namestring or nullOptionalJob title. Please leave it blank when entering an Id.
Maximum length: 255

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id

FieldTypePresenceDescription and constraints
$JSONRootUnique identifier of this resource.
$ (oneOf 1)stringAlternative
$ (oneOf 2)numberAlternativeFormat: double

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor meta

FieldTypePresenceDescription and constraints
$objectRootAdditional custom info about a contract
documents_requiredbooleanRequired within parentRequire the contractor to upload necessary compliance documents as per their country’s labor laws.
is_main_incomebooleanOptionalFlag to indicate if the contract is the main income for the contractor.

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor seniority id

FieldTypePresenceDescription and constraints
$objectRootJob seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.
idModelOptionalExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id
Unique identifier of this resource.

Referenced models: Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor job title id

Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor worker Worker properties

FieldTypePresenceDescription and constraints
$objectRootWorker properties
expected_emailstring or nullRequired within parentWorker's email address.
Format: email
Minimum length: 5
first_namestring or nullRequired within parentWorker's first name
Maximum length: 255
last_namestring or nullOptionalWorker's last name
Maximum length: 255
work_emailstring or nullOptionalWorker's work email address.
Format: email
Maximum length: 255

Create a new contract — request body — body data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor
$ (oneOf 2)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor
$ (oneOf 3)ModelAlternativeExpand Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor
$ (oneOf 4)ModelAlternativeExpand Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor

Referenced models: Create a new contract — request body — body / data / platform_payment_type: STANDARD, OFF PLATFORM, type: pay as you go time based, who reports: both, client, contractor, Create a new contract — request body — body / data / type: payg tasks, who reports: both, client, contractor, Create a new contract — request body — body / data / type: payg milestones, who reports: both, client, contractor, Create a new contract — request body — body / data / type: ongoing time based, who reports: both, client, contractor

Create a request to exercise equity — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a request to exercise equity — 201 response body — data

Referenced models: Create a request to exercise equity — 201 response body — data

Create a request to exercise equity — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentISO 8601 timestamp when the equity exercise request was created.
Format: date-time
idstringRequired within parentUnique identifier of the equity exercise request.
Format: uuid
statusstringRequired within parentThe initial status of the newly created equity exercise request.
updated_atstringRequired within parentISO 8601 timestamp when the equity exercise request was last updated.
Format: date-time

Create a work statement payment policy — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create a work statement payment policy — 201 response body — data
The created work statement payment policy.

Referenced models: Create a work statement payment policy — 201 response body — data

Create a work statement payment policy — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRootThe created work statement payment policy.
idstringRequired within parentThe public ID (UUID) of the created payment policy.
Format: uuid

Create a work statement payment policy — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalDescription of the payment policy.
Maximum length: 400
due_daysintegerOptionalNumber of days after cycle end before payment is released. Defaults to 0.
Maximum: 90
Minimum: 0
due_typestringOptionalHow the payment due date is calculated relative to cycle end. Defaults to REGULAR.
One of: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END
end_dayintegerRequired within parentDay the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or
DAY_OF_LAST_WEEK.
Maximum: 31
Minimum: 1
end_typestringOptionalHow end_day is interpreted. Defaults to DAY_OF_MONTH.
One of: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
end_week_paritystringOptionalWeek parity constraint for biweekly cycles. Only applicable when scale is BIWEEKLY.
One of: AUTO, ODD, EVEN
namestringRequired within parentName of the payment policy. Must be unique within the organization.
Maximum length: 255
Minimum length: 3
scalestringRequired within parentPayment cycle frequency.
One of: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH
should_pay_before_weekendsbooleanOptionalWhether payment is moved earlier when the due date falls on a weekend. Defaults to false.

List contract termination reasons — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List contract termination reasons — 200 response body — data item
has_morebooleanRequired within parentIndicates whether there are more results available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to use for fetching the next page. Null if there are no more results.
next_cursor (anyOf 2)nullAlternativeCursor to use for fetching the next page. Null if there are no more results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of termination reasons available
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List contract termination reasons — 200 response body — data item

List contract termination reasons — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp when the termination reason was created
Format: date-time
frequencystringRequired within parentHow commonly this reason is used
Known values: COMMON, MOST_COMMON, LESS_COMMON
idstringRequired within parentUnique identifier for the termination reason
Format: uuid
namestringRequired within parentThe display text for the termination reason that can be shown to users
updated_atstringRequired within parentTimestamp when the termination reason was last updated
Format: date-time

List of contracts — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of contract objects.
data[]ModelEach itemExpand List of contracts — 200 response body — data item
pageModelRequired within parentExpand List of contracts — 200 response body — page
Pagination information for the response.

Referenced models: List of contracts — 200 response body — data item, List of contracts — 200 response body — page

List of contracts — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
clientModelRequired within parentExpand List of contracts — 200 response body — data item client
Client information associated with the contract.
cost_centersarrayOptionalList of cost centers associated with the contract.
cost_centers[]ModelEach itemExpand List of contracts — 200 response body — data item cost centers item
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeTimestamp when the contract was created, in ISO-8601 format.
Format: date-time
created_at (anyOf 2)nullAlternativeTimestamp when the contract was created, in ISO-8601 format.
Format: date-time
custom_fieldsJSONOptional
custom_fields (anyOf 1)arrayAlternativeContract-level custom fields. Only returned when `expand=custom_fields` is provided.
custom_fields (anyOf 1)[]ModelEach itemExpand List of contracts — 200 response body — data item custom fields null item
custom_fields (anyOf 2)nullAlternativeContract-level custom fields. Only returned when `expand=custom_fields` is provided.
custom_fields (anyOf 2)[]ModelEach itemExpand List of contracts — 200 response body — data item custom fields null item
employment_detailsModelOptionalExpand List of contracts — 200 response body — data item employment details
Employment-related details for the contract.
external_idJSONOptional
external_id (anyOf 1)stringAlternativeA unique identifier for the object provided by an external system.
external_id (anyOf 2)nullAlternativeA unique identifier for the object provided by an external system.
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 parentUUID of the contract.
Minimum length: 1
invitationsModelRequired within parentExpand List of contracts — 200 response body — data item invitations
Details of invitations sent for signing the contract.
is_archivedbooleanRequired within parentIndicates whether the contract is archived.
is_shieldedbooleanRequired within parentIndicates whether the contract is shielded.
notice_periodJSONOptional
notice_period (anyOf 1)numberAlternativeNumber of days required to give notice before terminating the contract.
Default: 0
Format: double
Minimum: 0
notice_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
scaleJSONOptional
scale (anyOf 1)stringAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.).
scale (anyOf 2)nullAlternativeThe payment scale (e.g., hourly, weekly, monthly, etc.).
signaturesModelRequired within parentExpand List of contracts — 200 response body — data item signatures
Signature information for the contract.
statusModelRequired within parentExpand List of contracts — 200 response body — data item status
Status of a contract in Deel workflow.
termination_dateJSONRequired within parent
termination_date (anyOf 1)stringAlternativeDate when the contract is terminated, in ISO-8601 format.
Format: date-time
termination_date (anyOf 2)nullAlternativeDate when the contract is terminated, in ISO-8601 format.
Format: date-time
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, eor, unknown, peo, employee, global_payroll, shield_msa, hris_direct_employee, contractor_outside_deel
who_reportsstringOptionalIndicates who is responsible for providing regular reports.
Known values: both, client, contractor
workerJSONOptionalWorker information associated with the contract.
worker (anyOf 1)ModelAlternativeExpand List of contracts — 200 response body — data item worker Worker information associated with the contract
worker (anyOf 2)nullAlternative

Referenced models: List of contracts — 200 response body — data item client, List of contracts — 200 response body — data item cost centers item, List of contracts — 200 response body — data item custom fields null item, List of contracts — 200 response body — data item employment details, List of contracts — 200 response body — data item invitations, List of contracts — 200 response body — data item signatures, List of contracts — 200 response body — data item status, List of contracts — 200 response body — data item worker Worker information associated with the contract

List of contracts — 200 response body — data item client

FieldTypePresenceDescription and constraints
$objectRootClient information associated with the contract.
legal_entityJSONOptionalLegal entity information for the client.
legal_entity (anyOf 1)ModelAlternativeExpand List of contracts — 200 response body — data item client legal entity Legal entity information for the client
legal_entity (anyOf 2)nullAlternative
teamModelOptionalExpand List of contracts — 200 response body — data item client team
Team information for the client.

Referenced models: List of contracts — 200 response body — data item client legal entity Legal entity information for the client, List of contracts — 200 response body — data item client team

List of contracts — 200 response body — data item client legal entity Legal entity information for the client

FieldTypePresenceDescription and constraints
$objectRootLegal entity information for the client.
idstringRequired within parentUnique identifier of this resource.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of the legal entity.
name (anyOf 2)nullAlternativeName of the legal entity.

List of contracts — 200 response body — data item client team

FieldTypePresenceDescription and constraints
$objectRootTeam information for the client.
idstringRequired within parentUnique identifier of this resource.
nameJSONRequired within parent
name (anyOf 1)stringAlternativeName of a team.
name (anyOf 2)nullAlternativeName of a team.

List of contracts — 200 response body — data item cost centers item

FieldTypePresenceDescription and constraints
$objectRootCost center object.
allocation_percentageJSONOptional
allocation_percentage (anyOf 1)numberAlternativePercentage of the cost center allocation.
Format: double
allocation_percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalCost center name.
numberstringOptionalCost center number.

List of contracts — 200 response body — data item custom fields null item

FieldTypePresenceDescription and constraints
$objectRootContract custom field object.
idstringOptionalPublic identifier of the custom field.
namestringOptionalName of the custom field.
valueJSONOptional
value (anyOf 1)stringAlternativeValue of the custom field for this contract.
value (anyOf 2)nullAlternativeValue of the custom field for this contract.

List of contracts — 200 response body — data item employment details

FieldTypePresenceDescription and constraints
$objectRootEmployment-related details for the contract.
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.

List of contracts — 200 response body — data item invitations

FieldTypePresenceDescription and constraints
$objectRootDetails of invitations sent for signing the contract.
client_emailJSONOptional
client_email (anyOf 1)stringAlternativeEmail address of the client to invite.
client_email (anyOf 2)nullAlternativeEmail address of the client to invite.
worker_emailJSONOptional
worker_email (anyOf 1)stringAlternativeEmail address of the worker to invite.
worker_email (anyOf 2)nullAlternativeEmail address of the worker to invite.

List of contracts — 200 response body — data item signatures

FieldTypePresenceDescription and constraints
$objectRootSignature information for the contract.
client_signed_atJSONRequired within parent
client_signed_at (anyOf 1)stringAlternativeTimestamp when the client signed the contract, in ISO-8601 format.
Format: date-time
client_signed_at (anyOf 2)nullAlternativeTimestamp when the client signed the contract, in ISO-8601 format.
Format: date-time
worker_signatureJSONRequired within parent
worker_signature (anyOf 1)stringAlternativeWorker's signature.
worker_signature (anyOf 2)nullAlternativeWorker's signature.
worker_signed_atJSONRequired within parent
worker_signed_at (anyOf 1)stringAlternativeTimestamp when the worker signed the contract, in ISO-8601 format.
Format: date-time
worker_signed_at (anyOf 2)nullAlternativeTimestamp when the worker signed the contract, in ISO-8601 format.
Format: date-time

List of contracts — 200 response body — data item status

FieldTypePresenceDescription and constraints
$stringRootStatus of a contract in Deel workflow.
Known values: new, under_review, waiting_for_approval, waiting_for_employee_contract, waiting_for_client_sign, processing_payment, waiting_for_contractor_sign, waiting_for_eor_sign, waiting_for_employee_sign, waiting_for_hris_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected, waiting_for_client_payment, onboarding, onboarded

List of contracts — 200 response body — data item worker Worker information associated with the contract

FieldTypePresenceDescription and constraints
$objectRootWorker information associated with the contract.
alternate_emailarrayOptionalList of alternate email addresses.
alternate_email[]ModelEach itemExpand List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Minimum length: 5
full_namestringOptionalFull name of the worker.
Minimum length: 1
idstringRequired within parentUnique identifier of this resource.
imageJSONOptional
image (anyOf 1)stringAlternativeURL of the worker's profile image.
Format: uri
Minimum length: 5
image (anyOf 2)nullAlternativeURL of the worker's profile image.
Format: uri
Minimum length: 5

Referenced models: List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item

List of contracts — 200 response body — data item worker Worker information associated with the contract alternate email item

FieldTypePresenceDescription and constraints
$objectRootAlternate email address object.
emailJSONOptional
email (anyOf 1)stringAlternativeUser's email address.
Format: email
Minimum length: 5
email (anyOf 2)nullAlternativeUser's email address.
Format: email
Minimum length: 5
isVerifiedbooleanOptionalIndicates whether the alternate email address is verified.

List of contracts — 200 response body — page

FieldTypePresenceDescription and constraints
$objectRootPagination information for the response.
cursorstringRequired within parentCursor for paginated results.
total_rowsJSONRequired within parent
total_rows (anyOf 1)numberAlternativeTotal number of rows in the result set.
Format: double
total_rows (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List work statement payment policies — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentThe organization's work statement payment policies.
data[]ModelEach itemExpand List work statement payment policies — 200 response body — data item

Referenced models: List work statement payment policies — 200 response body — data item

List work statement payment policies — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRootA work statement payment policy of the organization.
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the payment policy.
description (anyOf 2)nullAlternativeDescription of the payment policy.
due_daysJSONRequired within parent
due_days (anyOf 1)integerAlternativeNumber of days after cycle end before payment is released.
due_days (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
due_typestringRequired within parentHow the payment due date is calculated relative to cycle end.
Known values: REGULAR, WITHIN_MONTH, AFTER_MONTH, BEFORE_CYCLE_END
end_dayJSONRequired within parent
end_day (anyOf 1)integerAlternativeDay the billing cycle ends. 1–31 when end_type is DAY_OF_MONTH, 1–7 when DAY_OF_WEEK or
DAY_OF_LAST_WEEK.
end_day (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end_typestringRequired within parentHow end_day is interpreted.
Known values: DAY_OF_WEEK, DAY_OF_LAST_WEEK, DAY_OF_MONTH
end_week_parityJSONOptionalWeek parity constraint for biweekly cycles. Null for non-biweekly scales.
end_week_parity (anyOf 1)stringAlternativeWeek parity constraint for biweekly cycles. Null for non-biweekly scales.
Known values: AUTO, ODD, EVEN
end_week_parity (anyOf 2)nullAlternative
idstringRequired within parentThe public ID (UUID) of the payment policy.
Format: uuid
namestringRequired within parentName of the payment policy.
scalestringRequired within parentPayment cycle frequency.
Known values: WEEKLY, MONTHLY, BIWEEKLY, SEMIMONTHLY, CALENDAR_MONTH
semimonthly_first_dayJSONOptional
semimonthly_first_day (anyOf 1)JSONAlternative
semimonthly_first_day (anyOf 1) (anyOf 1)integerAlternativeFirst payment day of the month for semimonthly cycles. Null for other scales.
semimonthly_first_day (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
semimonthly_first_day (anyOf 2)nullAlternativeFirst payment day of the month for semimonthly cycles. Null for other scales.
semimonthly_second_dayJSONOptional
semimonthly_second_day (anyOf 1)JSONAlternative
semimonthly_second_day (anyOf 1) (anyOf 1)integerAlternativeSecond payment day of the month for semimonthly cycles. Null for other scales.
semimonthly_second_day (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
semimonthly_second_day (anyOf 2)nullAlternativeSecond payment day of the month for semimonthly cycles. Null for other scales.
should_pay_before_weekendsbooleanRequired within parentWhether payment is moved earlier when the due date falls on a weekend.

Retrieve a single contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve a single contract — 200 response body — data

Referenced models: Retrieve a single contract — 200 response body — data

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.