Skip to content

Deel: EOR contract schemas

58 Deel schemas with complete fields and constraints.

← EOR contract operations · All schemas

Create an EOR contract — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Create an EOR contract — 201 response body — data

Referenced models: Create an EOR contract — 201 response body — data

Create an EOR contract — 201 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
clientModelOptionalExpand Create an EOR contract — 201 response body — data client
Client information for the contract.
compensation_detailsModelOptionalExpand Create an EOR contract — 201 response body — data compensation details
costsModelOptionalExpand Create an EOR contract — 201 response body — data costs
Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.
created_atstringOptionalContract creation timestamp
Format: date-time
employeeModelOptionalExpand Create an EOR contract — 201 response body — data employee
employmentModelOptionalExpand Create an EOR contract — 201 response body — data employment
Employment contract specific details.
health_planJSONOptional
health_plan (anyOf 1)ModelAlternativeExpand Create an EOR contract — 201 response body — data health plan id, name
health_plan (anyOf 2)nullAlternative
idstringOptionalID of the created contract quote.
job_categorystringOptionalJob category assigned to the role. Present only for countries that use job categorisation.
job_codestringOptionalCountry-specific occupation code, when applicable.
job_titlestringOptionalEmployee's job title
seniorityModelOptionalExpand Create an EOR contract — 201 response body — data seniority
Seniority level of the employee
statusstringOptionalCurrent status of the contract.
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
typestringOptionalType of the 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, peo

Referenced models: Create an EOR contract — 201 response body — data costs, Create an EOR contract — 201 response body — data client, Create an EOR contract — 201 response body — data employee, Create an EOR contract — 201 response body — data health plan id, name, Create an EOR contract — 201 response body — data compensation details, Create an EOR contract — 201 response body — data employment, Create an EOR contract — 201 response body — data seniority

Create an EOR contract — 201 response body — data client

FieldTypePresenceDescription and constraints
$objectRootClient information for the contract.
legal_entityModelOptionalExpand Create an EOR contract — 201 response body — data client legal entity

Referenced models: Create an EOR contract — 201 response body — data client legal entity

Create an EOR contract — 201 response body — data client legal entity

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalLegal entity name

Create an EOR contract — 201 response body — data compensation details

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency of the salary
salarystringOptionalGross annual salary
variable_compensationstringOptionalVariable compensation account or percentage
variable_compensation_typeJSONOptional
variable_compensation_type (anyOf 1)stringAlternativeType of variable compensation
variable_compensation_type (anyOf 2)nullAlternativeType of variable compensation

Create an EOR contract — 201 response body — data costs

FieldTypePresenceDescription and constraints
$objectRootDetailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.
additional_dataModelOptionalExpand Create an EOR contract — 201 response body — data costs additional data
Supplementary notes and contextual information relevant to the cost quote.
sectionsarrayOptionalDetailed and categorized cost sections including grouped and standalone items.
sections[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item
summaryModelOptionalExpand Create an EOR contract — 201 response body — data costs summary
Top-level overview of costs, including key totals and currency metadata.

Referenced models: Create an EOR contract — 201 response body — data costs additional data, Create an EOR contract — 201 response body — data costs sections item, Create an EOR contract — 201 response body — data costs summary

Create an EOR contract — 201 response body — data costs additional data

FieldTypePresenceDescription and constraints
$objectRootSupplementary notes and contextual information relevant to the cost quote.
additional_notesarrayOptionalGeneral conditions, assumptions, or fees that may apply to the quote.
additional_notes[]stringEach item
annual_notesarrayOptionalNotes or assumptions specifically relevant to annual cost calculations.
annual_notes[]stringEach item
monthly_notesarrayOptionalNotes or assumptions specifically relevant to monthly cost calculations.
monthly_notes[]stringEach item
once_off_notesarrayOptionalNotes regarding one-time costs or irregular payments in the quote.
once_off_notes[]stringEach item

Create an EOR contract — 201 response body — data costs sections item

FieldTypePresenceDescription and constraints
$objectRoot
groupsarrayOptionalCollections of related costs grouped under a common label.
groups[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item groups item
is_summarizedbooleanOptionalIndicates whether the section is presented in summarized form.
labelstringOptionalDisplay name for the cost section.
namestringOptionalInternal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN).
standalone_itemsarrayOptionalCost items that do not belong to regular groups, often irregular or one-off costs.
standalone_items[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item standalone items item
totalsarrayOptionalOverall totals for the section, summing all groups and standalone items.
totals[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item totals item

Referenced models: Create an EOR contract — 201 response body — data costs sections item groups item, Create an EOR contract — 201 response body — data costs sections item standalone items item, Create an EOR contract — 201 response body — data costs sections item totals item

Create an EOR contract — 201 response body — data costs sections item groups item

FieldTypePresenceDescription and constraints
$objectRoot
costsarrayOptionalIndividual cost items within the group.
costs[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item groups item costs item
has_breakdownbooleanOptionalIndicates if the group contains multiple detailed cost items to be expanded.
labelstringOptionalDisplay name for the group (e.g., Gross Salary, Employer Cost).
namestringOptionalInternal identifier for the group.
totalsarrayOptionalAggregated totals for all items within the group.
totals[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item groups item totals item

Referenced models: Create an EOR contract — 201 response body — data costs sections item groups item costs item, Create an EOR contract — 201 response body — data costs sections item groups item totals item

Create an EOR contract — 201 response body — data costs sections item groups item costs item

FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalName of the specific cost item (e.g., Salary, Meal Voucher).
totalsarrayOptionalMonthly and annual totals for the cost item in local and supporting currencies.
totals[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item groups item costs item totals item

Referenced models: Create an EOR contract — 201 response body — data costs sections item groups item costs item totals item

Create an EOR contract — 201 response body — data costs sections item groups item costs item totals item

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalHow often this cost occurs (e.g., monthly, annual, one-time).
totalstringOptionalTotal cost amount in local currency.
total_supportingstringOptionalTotal cost amount in the supporting currency.

Create an EOR contract — 201 response body — data costs sections item groups item totals item

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalHow often the total is calculated (e.g., monthly, annual).
totalstringOptionalGroup total in local currency.
total_supportingstringOptionalGroup total in supporting currency.

Create an EOR contract — 201 response body — data costs sections item standalone items item

FieldTypePresenceDescription and constraints
$objectRoot
labelstringOptionalDisplay name for the standalone cost item.
namestringOptionalInternal identifier for the standalone cost item.
totalsarrayOptionalMonthly and annual totals for the standalone item in local and supporting currencies.
totals[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs sections item standalone items item totals item

Referenced models: Create an EOR contract — 201 response body — data costs sections item standalone items item totals item

Create an EOR contract — 201 response body — data costs sections item standalone items item totals item

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalHow often this cost occurs (e.g., monthly, annual, one-time).
totalstringOptionalStandalone cost amount in local currency.
total_supportingstringOptionalStandalone cost amount in the supporting currency.

Create an EOR contract — 201 response body — data costs sections item totals item

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalHow often the total is calculated (e.g., monthly, annual).
totalstringOptionalTotal cost for the section in local currency.
total_supportingstringOptionalTotal cost for the section in supporting currency.

Create an EOR contract — 201 response body — data costs summary

FieldTypePresenceDescription and constraints
$objectRootTop-level overview of costs, including key totals and currency metadata.
currencystringOptionalLocal currency code (e.g., BRL, PLN).
exchange_ratestringOptionalExchange rate used to convert from local to supporting currency.
salarystringOptionalAnnual gross salary in local currency.
supporting_currencystringOptionalReference or secondary currency (e.g., USD) used for reporting totals.
totals_formattedarrayOptionalFormatted summary totals in both local and supporting currencies.
totals_formatted[]ModelEach itemExpand Create an EOR contract — 201 response body — data costs summary totals formatted item

Referenced models: Create an EOR contract — 201 response body — data costs summary totals formatted item

Create an EOR contract — 201 response body — data costs summary totals formatted item

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalTime period for the total (e.g., monthly, annual).
titlestringOptionalDisplay title for the total (e.g., 'Monthly Total').
totalstringOptionalFormatted amount in local currency.
total_supportingstringOptionalFormatted amount in supporting currency.

Create an EOR contract — 201 response body — data employee

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalEmployee's email
first_namestringOptionalEmployee's first name
last_namestringOptionalEmployee's last name
legal_namestringOptionalEmployee's legal name

Create an EOR contract — 201 response body — data employment

FieldTypePresenceDescription and constraints
$objectRootEmployment contract specific details.
calculated_holidaysstringOptionalNumber of calculated holidays
countrystringOptionalCountry of employment
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeEmployment end date
Format: date-time
end_date (anyOf 2)nullAlternativeEmployment end date
Format: date-time
probation_periodJSONOptional
probation_period (anyOf 1)JSONAlternative
probation_period (anyOf 1) (anyOf 1)integerAlternativeNumber of probation days
probation_period (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period (anyOf 2)nullAlternativeNumber of probation days
scope_of_workstringOptionalScope of work description.
start_datestringOptionalEmployment start date
Format: date-time
stateJSONOptional
state (anyOf 1)stringAlternativeState or province of employment
state (anyOf 2)nullAlternativeState or province of employment
time_off_typestringOptionalType of time off for the employee
work_visa_requiredbooleanOptionalIf a work visa is required

Create an EOR contract — 201 response body — data health plan id, name

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalHealth plan ID
namestringOptionalHealth plan name

Create an EOR contract — 201 response body — data seniority

FieldTypePresenceDescription and constraints
$objectRootSeniority level of the employee
idJSONRequired within parent
id (anyOf 1)integerAlternativeSeniority level ID
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringRequired within parentSeniority level name

Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled

FieldTypePresenceDescription and constraints
$objectRootSome countries require additional employee information for employment contracts.
dobstringOptionalEmployee's date of birth.
genderstringOptionalEmployee's gender.
worker_typestringOptionalType of worker.
One of: Skilled, Unskilled

Create an EOR contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
benefitsarrayOptional
benefits[]ModelEach itemExpand Create an EOR contract — request body — body data benefits item
clientModelRequired within parentExpand Create an EOR contract — request body — body data client
Client details for the contract.
compensation_detailsModelRequired within parentExpand Create an EOR contract — request body — body data compensation details
employeeModelRequired within parentExpand Create an EOR contract — request body — body data employee
employmentModelRequired within parentExpand Create an EOR contract — request body — body data employment
Employment contract specific details.
health_plan_idstringOptionalHealthcare plan id. You can see available healthcare plans in the country guide endpoint.
is_team_managerbooleanOptionalItaly only. Whether the role is responsible for managing a team. Required when job_category is provided.
job_categorystringOptionalItaly only. Job category chosen by the client. If omitted, Deel assigns one automatically. When provided, is_team_manager, reports_to_job_title and employment.probation_period are required.
One of: Impiegato, Quadro, Dirigente
job_titlestringRequired within parentEmployee's job title.
pensionModelOptionalExpand Create an EOR contract — request body — body data pension
Some countries required a pension benefit.
quote_additional_fieldsJSONOptionalSome countries require additional employee information for employment contracts.
quote_additional_fields (oneOf 1)ModelAlternativeExpand Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled
quote_additional_fields (oneOf 2)nullAlternative
reports_to_job_titlestringOptionalItaly only. Job title of the person this role reports to. Required when job_category is provided.
Maximum length: 255
Minimum length: 1
seniorityModelRequired within parentExpand Create an EOR contract — request body — body data seniority
Seniority selection for the role.

Referenced models: Create an EOR contract — request body — body data benefits item, Create an EOR contract — request body — body data client, Create an EOR contract — request body — body data compensation details, Create an EOR contract — request body — body data employee, Create an EOR contract — request body — body data employment, Create an EOR contract — request body — body data pension, Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled, Create an EOR contract — request body — body data seniority

Create an EOR contract — request body — body data benefits item

FieldTypePresenceDescription and constraints
$objectRootList of additional benefits to include in the calculation
contributionnumberOptionalThe amount the client will contribute for the benefit in the currency of the contract. Only taken into account if cover_all is set to false. For Unisure provider contribution is always in USD.
Format: double
cover_allbooleanOptionalFlag indicating if benefit will fully cover the employee.
cover_dependentsbooleanOptionalFlag indicating if benefit will cover dependents. Only needed if cover_all is set to true.
plan_idstringOptionalThe ID of a benefits plan to include in the calculation.
provider_idstringOptionalThe ID of a benefits provider to include in the calculation.

Create an EOR contract — request body — body data client

FieldTypePresenceDescription and constraints
$objectRootClient details for the contract.
legal_entityModelOptionalExpand Create an EOR contract — request body — body data client legal entity
teamModelRequired within parentExpand Create an EOR contract — request body — body data client team

Referenced models: Create an EOR contract — request body — body data client legal entity, Create an EOR contract — request body — body data client team

Create an EOR contract — request body — body data client legal entity

FieldTypePresenceDescription and constraints
$objectRoot
idModelRequired within parentExpand Create an EOR contract — request body — body data client legal entity id
Legal entity reference for the client.

Referenced models: Create an EOR contract — request body — body data client legal entity id

Create an EOR contract — request body — body data client legal entity id

FieldTypePresenceDescription and constraints
$JSONRootLegal entity reference for the client.
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

Create an EOR contract — request body — body data client team

FieldTypePresenceDescription and constraints
$objectRoot
idModelRequired within parentExpand Create an EOR contract — request body — body data client team id
Team identifying information.

Referenced models: Create an EOR contract — request body — body data client team id

Create an EOR contract — request body — body data client team id

FieldTypePresenceDescription and constraints
$JSONRootTeam identifying information.
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

Create an EOR contract — request body — body data compensation details

FieldTypePresenceDescription and constraints
$objectRoot
currencystringRequired within parentSalary currency.
fixed_adjustmentsarrayOptional
fixed_adjustments[]ModelEach itemExpand Create an EOR contract — request body — body data compensation details fixed adjustments item
hourly_ratenumberOptionalEmployee's hourly rate. Required only if contract is set as hourly.
Format: double
salarynumberOptionalEmployee's gross annual salary. Required only if contract is salaried.
Format: double
signing_bonusnumber or nullOptionalSigning bonus amount.
Format: double
signing_bonus_payout_typeJSONOptionalShould be set only if signing_bonus is set. It defines when the bonus is paid.
signing_bonus_payout_type (oneOf 1)stringAlternativeShould be set only if signing_bonus is set. It defines when the bonus is paid.
One of: FIRST_CYCLE, AFTER_PROBATION, AFTER_FIRST_CONTRACT_ANNIVERSARY
signing_bonus_payout_type (oneOf 2)nullAlternative
variable_compensationnumber or nullOptionalVariable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5.
Format: double
variable_compensation_effective_datestringOptionalVariable compensation effective date.
Format: date
variable_compensation_timelineJSONOptionalVariable compensation timeline.
variable_compensation_timeline (oneOf 1)stringAlternativeVariable compensation timeline.
One of: ANNUALLY, BIANNUALLY, QUARTERLY, MONTHLY
variable_compensation_timeline (oneOf 2)nullAlternative
variable_compensation_titlestringOptionalVariable compensation title.
variable_compensation_typeJSONOptionalShould be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.
variable_compensation_type (oneOf 1)stringAlternativeShould be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.
One of: PERCENTAGE, FIXED
variable_compensation_type (oneOf 2)nullAlternative

Referenced models: Create an EOR contract — request body — body data compensation details fixed adjustments item

Create an EOR contract — request body — body data compensation details fixed adjustments item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalAdjustment description.
is_country_specificbooleanOptionalWhether this adjustment is country-specific.
is_recurringbooleanOptionalWhether the adjustment is paid recurring monthly or one-time on employee's first payroll.
namestringOptionalAdjustment name.
opt_outbooleanOptionalWhether the adjustment is being opted out of.
optionalbooleanOptionalWhether the adjustment is optional.
rule_cost_idstringOptionalIdentifier of the rule cost associated with the adjustment.
skipping_confirmation_textstringOptionalOptional skipping confirmation text shown to the user.
valuenumberOptionalAdjustment value.
Format: double

Create an EOR contract — request body — body data employee

FieldTypePresenceDescription and constraints
$objectRoot
addressJSONOptional
address (oneOf 1)ModelAlternativeExpand Create an EOR contract — request body — body data employee address city, country, state, street, zip
address (oneOf 2)nullAlternative
emailstringOptionalEmployee's email address.
external_idstringOptionalExternal identifier of the employee.
first_namestringRequired within parentEmployee's first name.
last_namestringRequired within parentEmployee's last name.
nationalitystringRequired within parentEmployee's nationality.
pf_deductionsstringOptionalEmployee's PF deductions. Required only for India contracts.
One of: 12% of Basic, 12% of Rs 15,000 (Rs 1,800)

Referenced models: Create an EOR contract — request body — body data employee address city, country, state, street, zip

Create an EOR contract — request body — body data employee address city, country, state, street, zip

FieldTypePresenceDescription and constraints
$objectRoot
citystringOptionalCity name.
countrystringOptionalCountry code.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
statestring or nullOptionalState code.
streetstringOptionalStreet and number.
zipstringOptionalZip code.

Create an EOR contract — request body — body data employment

FieldTypePresenceDescription and constraints
$objectRootEmployment contract specific details.
countrystringRequired within parentCountry code of employment.
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
employee_completed_past_probationbooleanOptionalWhether the employee has previously passed the probation period.
Default: false
end_datestring or nullOptionalEnd date in ISO-8601 format (YYYY-MM-DD).
Format: date
holidaysnumber or nullOptionalEnter the number of holidays. Leave this field blank if you are choosing "STANDARD" time_off_type.
Format: double
is_hourlybooleanOptionalIs the employee contract hourly instead of salaried?
notice_period_after_probationnumber or nullOptionalNotice period after probation required when type is CUSTOM.
Format: double
notice_period_after_probation_time_unitstringOptionalTime unit of notice period after probation.
One of: DAY, WEEK, MONTH
notice_period_during_probationnumber or nullOptionalNotice period during probation required when type is CUSTOM.
Format: double
notice_period_during_probation_time_unitstringOptionalTime unit of notice period during probation.
One of: DAY, WEEK, MONTH
notice_period_typestringOptionalType of notice period.
One of: STANDARD, CUSTOM
probation_periodnumber or nullOptionalNumber of probation days.
Format: double
probation_period_time_unitstringOptionalTime unit of probation period.
One of: DAY, WEEK, MONTH
probation_period_type_for_definitestringOptionalType of probation period for definite contracts.
One of: STANDARD, CUSTOM
scope_of_workModelRequired within parentExpand Create an EOR contract — request body — body data employment scope of work
Scope of work; either a string with full text or an object referencing a template/validation UUID.
seniority_datestringOptionalSeniority date
Format: date
sick_leave_daysintegerOptionalNumber of sick leave days
start_datestringRequired within parentStart date in ISO-8601 format (YYYY-MM-DD).
Format: date
statestring or nullOptionalState code of the state/province where the this person will be employed.
time_off_typestringOptionalIf you want to use standard number of holidays for this employee, choose "STANDARD". If you want to enter a specific number of holidays, choose "SPECIFIC" and enter the number of days in the holidays field.
One of: STANDARD, SPECIFIC
typestringOptionalIs it a full-time contract or a part-time contract?
One of: Full-time, Part-time
work_hours_per_weeknumberOptionalEmployee's work hours per week. Required only if contract is set as hourly.
Format: double
work_visa_requiredbooleanRequired within parentDo you require Deel to apply for work visa for this person?
Default: false

Referenced models: Create an EOR contract — request body — body data employment scope of work

Create an EOR contract — request body — body data employment scope of work

FieldTypePresenceDescription and constraints
$JSONRootScope of work; either a string with full text or an object referencing a template/validation UUID.
$ (oneOf 1)stringAlternativeMaximum length: 10000
Minimum length: 100
$ (oneOf 2)ModelAlternativeExpand Create an EOR contract — request body — body data employment scope of work scope template id
$ (oneOf 3)ModelAlternativeExpand Create an EOR contract — request body — body data employment scope of work scope validation id

Referenced models: Create an EOR contract — request body — body data employment scope of work scope template id, Create an EOR contract — request body — body data employment scope of work scope validation id

Create an EOR contract — request body — body data employment scope of work scope template id

FieldTypePresenceDescription and constraints
$objectRoot
scope_template_idstringOptionalScope template UUID.
Format: uuid

Create an EOR contract — request body — body data employment scope of work scope validation id

FieldTypePresenceDescription and constraints
$objectRoot
scope_validation_idstringOptionalScope validation UUID.
Format: uuid

Create an EOR contract — request body — body data pension

FieldTypePresenceDescription and constraints
$objectRootSome countries required a pension benefit.
contributionstringOptionalEnter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated.
idstringOptionalPension provider id. You can see available pension providers in the country guide endpoint.

Create an EOR contract — request body — body data seniority

FieldTypePresenceDescription and constraints
$objectRootSeniority selection for the role.
idModelOptionalExpand Create an EOR contract — request body — body data seniority id
Identifier for the seniority level (string or numeric ID).

Referenced models: Create an EOR contract — request body — body data seniority id

Create an EOR contract — request body — body data seniority id

FieldTypePresenceDescription and constraints
$JSONRootIdentifier for the seniority level (string or numeric ID).
$ (oneOf 1)stringAlternative
$ (oneOf 2)integerAlternativeFormat: int64

Retrieve EOR Contract Details — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
calculated_holidaysJSONOptional
calculated_holidays (anyOf 1)stringAlternativeCalculated number of holidays as a string.
calculated_holidays (anyOf 2)nullAlternativeCalculated number of holidays as a string.
can_adjust_onJSONOptionalTime frame when adjustments can be made.
can_adjust_on (anyOf 1)ModelAlternativeExpand Retrieve EOR Contract Details — 200 response body — can adjust on Time frame when adjustments can be made
can_adjust_on (anyOf 2)nullAlternative
can_remind_employee_to_signbooleanOptionalWhether reminders to sign the employee resignation can be sent to the employee or not.
cancelled_atJSONOptional
cancelled_at (anyOf 1)stringAlternativeThe date and time when the contract was cancelled.
Format: date-time
cancelled_at (anyOf 2)nullAlternativeThe date and time when the contract was cancelled.
Format: date-time
client_signatureJSONOptional
client_signature (anyOf 1)stringAlternativeThe signature of the client.
client_signature (anyOf 2)nullAlternativeThe signature of the client.
client_signed_atJSONOptional
client_signed_at (anyOf 1)stringAlternativeThe date and time when the client signed the contract.
Format: date-time
client_signed_at (anyOf 2)nullAlternativeThe date and time when the client signed the contract.
Format: date-time
compensation_typeJSONOptionalCompensation type for the contract.
compensation_type (anyOf 1)stringAlternativeCompensation type for the contract.
Known values: HOURLY, ANNUAL
compensation_type (anyOf 2)nullAlternative
completed_atJSONOptional
completed_at (anyOf 1)stringAlternativeThe date and time when the contract was completed.
Format: date-time
completed_at (anyOf 2)nullAlternativeThe date and time when the contract was completed.
Format: date-time
completion_dateJSONOptional
completion_date (anyOf 1)stringAlternativeThe completion date of the contract.
Format: date-time
completion_date (anyOf 2)nullAlternativeThe completion date of the contract.
Format: date-time
completion_plain_dateJSONOptional
completion_plain_date (anyOf 1)stringAlternativeThe completion date of the contract in plain contract.
Format: date
completion_plain_date (anyOf 2)nullAlternativeThe completion date of the contract in plain contract.
Format: date
contract_typestringOptionalThe type of contract.
Known values: eor
contractor_signatureJSONOptional
contractor_signature (anyOf 1)stringAlternativeThe signature of the EOR entity representative.
contractor_signature (anyOf 2)nullAlternativeThe signature of the EOR entity representative.
contractor_signed_atJSONOptional
contractor_signed_at (anyOf 1)stringAlternativeThe date and time when the contractor signed the contract.
Format: date-time
contractor_signed_at (anyOf 2)nullAlternativeThe date and time when the contractor signed the contract.
Format: date-time
created_atstringOptionalThe date and time when the contract was created.
Format: date-time
creatorModelOptionalExpand Retrieve EOR Contract Details — 200 response body — creator
currencystringOptionalThe currency used in the contract.
deposit_monthsJSONOptional
deposit_months (anyOf 1)stringAlternativeNumber of deposit months required.
deposit_months (anyOf 2)nullAlternativeNumber of deposit months required.
descriptionstringOptionalContract description
effective_datestringOptionalThe date and time when the contract is effective.
Format: date-time
effective_plain_datestringOptionalThe effective date in plain format.
Format: date
employeeModelOptionalExpand Retrieve EOR Contract Details — 200 response body — employee
Employee details
employee_late_sign_startJSONOptional
employee_late_sign_start (anyOf 1)stringAlternativeDate when employee signed late, if applicable.
Format: date-time
employee_late_sign_start (anyOf 2)nullAlternativeDate when employee signed late, if applicable.
Format: date-time
employee_signed_atJSONOptional
employee_signed_at (anyOf 1)stringAlternativeDate and time when the employee signed.
Format: date-time
employee_signed_at (anyOf 2)nullAlternativeDate and time when the employee signed.
Format: date-time
employment_costsJSONOptionalDetailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.
employment_costs (anyOf 1)ModelAlternativeExpand Create an EOR contract — 201 response body — data costs
employment_costs (anyOf 2)nullAlternative
employment_countrystringOptionalTwo letter country code of the employment country.
employment_stateJSONOptional
employment_state (anyOf 1)stringAlternativeThe state of the employment.
employment_state (anyOf 2)nullAlternativeThe state of the employment.
employment_typestringOptionalThe type of employment.
Known values: Full-time, Part-time
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe end date of the contract, if applicable.
Format: date-time
end_date (anyOf 2)nullAlternativeThe end date of the contract, if applicable.
Format: date-time
fixed_adjustment_idsJSONOptional
fixed_adjustment_ids (anyOf 1)arrayAlternativeList of fixed adjustment ids.
fixed_adjustment_ids (anyOf 1)[]stringEach item
fixed_adjustment_ids (anyOf 2)nullAlternativeList of fixed adjustment ids.
fixed_adjustment_ids (anyOf 2)[]stringEach item
hiring_objectiveJSONOptionalInformation about the hiring objective.
hiring_objective (anyOf 1)ModelAlternativeExpand Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective
hiring_objective (anyOf 2)nullAlternative
holidaysJSONOptional
holidays (anyOf 1)JSONAlternative
holidays (anyOf 1) (anyOf 1)integerAlternativeNumber of holidays for the contract.
holidays (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
holidays (anyOf 2)nullAlternativeNumber of holidays for the contract.
hourly_rateJSONOptional
hourly_rate (anyOf 1)stringAlternativeHourly rate as a string to preserve decimal precision.
hourly_rate (anyOf 2)nullAlternativeHourly rate as a string to preserve decimal precision.
hris_profile_idJSONOptional
hris_profile_id (anyOf 1)stringAlternativeThe HRIS profile ID linked to this contract.
Format: uuid
hris_profile_id (anyOf 2)nullAlternativeThe HRIS profile ID linked to this contract.
Format: uuid
idstringOptionalThe unique identifier for the Deel contract.
initial_effective_plain_datestringOptionalThe initial effective date in plain format.
Format: date
invited_client_emailJSONOptional
invited_client_email (anyOf 1)stringAlternativeThe email address of the invited client.
invited_client_email (anyOf 2)nullAlternativeThe email address of the invited client.
is_early_invoice_enabledbooleanOptionalWhether early invoicing is enabled or not.
is_employee_onboarding_delayedbooleanOptionalDetermines if the invite for employee onboarding should be dispatch manually.
is_foreign_currency_contractbooleanOptionalWhether the contract uses foreign currency or not.
is_onboarding_on_holdbooleanOptionalWhether onboarding is currently on hold or not.
job_title_nameJSONOptional
job_title_name (anyOf 1)stringAlternativeThe contract's job title.
job_title_name (anyOf 2)nullAlternativeThe contract's job title.
last_quote_rejectionJSONOptionalTimestamp of last quote rejection.
last_quote_rejection (anyOf 1)ModelAlternativeExpand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection
last_quote_rejection (anyOf 2)nullAlternative
monthly_employer_coststringOptionalMonthly cost to the employer.
monthly_eor_management_fee_usdstringOptionalMonthly EOR management fee in USD.
namestringOptionalContract name
notice_period_typeJSONOptionalType of notice period if applicable.
notice_period_type (anyOf 1)stringAlternativeType of notice period if applicable.
Known values: STANDARD, CUSTOM
notice_period_type (anyOf 2)nullAlternative
onboarding_step_durationJSONOptional
onboarding_step_duration (anyOf 1)JSONAlternative
onboarding_step_duration (anyOf 1) (anyOf 1)integerAlternativeDuration of onboarding steps in days.
onboarding_step_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
onboarding_step_duration (anyOf 2)nullAlternativeDuration of onboarding steps in days.
original_start_datestringOptionalThe originally planned start date.
Format: date-time
payroll_typestringOptionalPayroll frequency for the contract
Known values: BIMONTHLY, MONTHLY, BIWEEKLY, WEEKLY, FOUR_WEEKLY, QUARTERLY
probation_periodJSONOptional
probation_period (anyOf 1)integerAlternativeNumber of days in the probation period.
probation_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_period_type_for_definiteJSONOptionalProbation period type for definite contracts.
probation_period_type_for_definite (anyOf 1)stringAlternativeProbation period type for definite contracts.
Known values: STANDARD, CUSTOM
probation_period_type_for_definite (anyOf 2)nullAlternative
salarystringOptionalAnnual salary as a string to preserve decimal precision.
scope_of_workstringOptionalDescription of job scope and responsibilities.
seniorityModelOptionalExpand Retrieve EOR Contract Details — 200 response body — seniority
sick_daysModelOptionalExpand Retrieve EOR Contract Details — 200 response body — sick days
Allowed sick days range.
signed_dateJSONOptional
signed_date (anyOf 1)stringAlternativeThe date and time when the contract was signed by both parties.
Format: date-time
signed_date (anyOf 2)nullAlternativeThe date and time when the contract was signed by both parties.
Format: date-time
signing_bonusJSONOptional
signing_bonus (anyOf 1)stringAlternativeOne-time bonus paid at contract sign.
signing_bonus (anyOf 2)nullAlternativeOne-time bonus paid at contract sign.
signing_bonus_payout_typeJSONOptionalDefines when the signing bonus is paid. Set only when signing_bonus is present.
signing_bonus_payout_type (anyOf 1)stringAlternativeDefines when the signing bonus is paid. Set only when signing_bonus is present.
Known values: FIRST_CYCLE, AFTER_PROBATION, AFTER_FIRST_CONTRACT_ANNIVERSARY
signing_bonus_payout_type (anyOf 2)nullAlternative
start_datestringOptionalThe start date of the contract.
Format: date-time
statusstringOptionalThe current status of the contract.
Known values: under_review, waiting_for_employee_contract, waiting_for_client_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, in_progress, completed, cancelled, user_cancelled, rejected
teamModelOptionalExpand Retrieve EOR Contract Details — 200 response body — team
time_off_typestringOptionalType of time off policy.
Known values: STANDARD, SPECIFIC, PRORATED
timezonestringOptionalThe timezone of the contract.
updated_atstringOptionalThe date and time when the contract was last updated.
Format: date-time
variable_compensation_idsarrayOptionalList of variable compensation IDs.
variable_compensation_ids[]stringEach item
work_arrangement_typeJSONOptionalWork arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified.
work_arrangement_type (anyOf 1)stringAlternativeWork arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified.
Known values: REMOTE, ONSITE, FIELD, HYBRID
work_arrangement_type (anyOf 2)nullAlternative
work_hours_per_weekstringOptionalNumber of work hours per week.
work_schedule_assignment_settingsstringOptionalWork schedule assignment setting.
Known values: NOT_AVAILABLE, SPECIFIC_SCHEDULES, GENERAL_SCHEDULES, ONE_TIME_AMENDMENT
work_visabooleanOptionalIndicates if a work visa is required.

Referenced models: Retrieve EOR Contract Details — 200 response body — can adjust on Time frame when adjustments can be made, Retrieve EOR Contract Details — 200 response body — creator, Create an EOR contract — 201 response body — data costs, Retrieve EOR Contract Details — 200 response body — team, Retrieve EOR Contract Details — 200 response body — employee, Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective, Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection, Retrieve EOR Contract Details — 200 response body — seniority, Retrieve EOR Contract Details — 200 response body — sick days

Retrieve EOR Contract Details — 200 response body — can adjust on Time frame when adjustments can be made

FieldTypePresenceDescription and constraints
$objectRootTime frame when adjustments can be made.
endstringOptionalEnd of the period when adjustments can be made.
startstringOptionalStart of the period when adjustments can be made.

Retrieve EOR Contract Details — 200 response body — creator

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the contract creator.
firstnamestringOptionalThe first name of the contract creator.
namestringOptionalThe name of the contract creator.

Retrieve EOR Contract Details — 200 response body — employee

FieldTypePresenceDescription and constraints
$objectRootEmployee details
emailstringOptionalThe email of the employee.
first_namestringOptionalThe first name of the employee.
last_namestringOptionalThe last name of the employee.
legal_namestringOptionalThe legal name of the employee.
nationalitystringOptionalTwo letter country code of the employee nationality.
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL to employee's picture.
pic_url (anyOf 2)nullAlternativeURL to employee's picture.

Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective

FieldTypePresenceDescription and constraints
$objectRootInformation about the hiring objective.
extra_infoJSONOptional
extra_info (anyOf 1)stringAlternative
extra_info (anyOf 2)nullAlternative
typestringOptionalKnown values: EXPANDING_TO_NEW_COUNTRY, TEMP_EOR_OPENING_ENTITY, ONE_OFF_HIRE, CONVERTING_CONTRACTOR, OTHER

Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection

FieldTypePresenceDescription and constraints
$objectRootTimestamp of last quote rejection.
created_atstringOptionalTimestamp of when the rejection was made.
rejected_byModelOptionalExpand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by
Details of the person who rejected.
rejection_messageJSONOptional
rejection_message (anyOf 1)stringAlternativeOptional message explaining the rejection.
rejection_message (anyOf 2)nullAlternativeOptional message explaining the rejection.
rejection_reasonstringOptionalReason why the rejection occurred.
Known values: TOO_EXPENSIVE, DECIDED_AGAINST_EMPLOYING_EOR, TEST_QUOTE, NOT_SATISFIED_WITH_DEEL, INACCURATE_INFO_JOB_TITLE, INACCURATE_INFO_JOB_DESCRIPTION, INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK, COMPLIANCE_RESTRICTIONS, OTHER
rejection_typeJSONOptionalType of rejection.
rejection_type (anyOf 1)stringAlternativeType of rejection.
Known values: CLIENT, EOR_AGENT
rejection_type (anyOf 2)nullAlternative

Referenced models: Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by

Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by

FieldTypePresenceDescription and constraints
$objectRootDetails of the person who rejected.
namestringOptionalFull name of the rejecting person.
profile_public_idstringOptionalPublic identifier for the rejecting person's profile.
Format: uuid

Retrieve EOR Contract Details — 200 response body — seniority

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)numberAlternativeThe unique identifier for the seniority level.
Format: double
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the seniority level.

Retrieve EOR Contract Details — 200 response body — sick days

FieldTypePresenceDescription and constraints
$objectRootAllowed sick days range.
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum number of sick days allowed.
max (anyOf 2)nullAlternativeMaximum number of sick days allowed.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum number of sick days allowed.
min (anyOf 2)nullAlternativeMinimum number of sick days allowed.

Retrieve EOR Contract Details — 200 response body — team

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier for the team.
namestringOptionalThe name of the team.

Update EOR Contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
oidstringRequired within parentThe unique identifier of the employee contract.
scope_of_workstringOptionalScope of work description.
statusstringRequired within parentCurrent status of the contract
Known values: new, under_review, waiting_for_client_sign, waiting_for_eor_sign, waiting_for_employee_sign, awaiting_deposit_payment, rejected

Update EOR Contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
allow_consultant_equipment_reimbursementbooleanOptionalAllow equipment reimbursement for consultants
benefitsarray or nullOptionalArray of employee benefits
benefits[]ModelEach itemExpand Update EOR Contract — request body — body data benefits item
contract_term_typestringOptionalType of contract term
One of: DEFINITE, INDEFINITE
currencystringOptionalCurrency code for salary and benefits
employee_addressModelOptionalExpand Update EOR Contract — request body — body data employee address
Employee's address information
employee_emailstringRequired within parentEmployee's email address
Format: email
employee_first_namestringRequired within parentEmployee's first name
employee_idstringOptionalEmployee's unique identifier
employee_last_namestringRequired within parentEmployee's last name
employee_nationalitystringOptionalEmployee's nationality
employment_countrystringRequired within parentCountry of employment
employment_statestring or nullOptionalState/Province of employment
employment_typestringRequired within parentType of employment
One of: Full-time, Part-time
end_datestring or nullOptionalEmployment end date
Format: date
hiring_objectivestringOptionalObjective for hiring
One of: EXPANDING_TO_NEW_COUNTRY, TEMP_EOR_OPENING_ENTITY, ONE_OFF_HIRE, CONVERTING_CONTRACTOR, OTHER
hiring_objective_extra_infostring or nullOptionalAdditional information about hiring objective
holidaysnumber or nullOptionalNumber of holiday days per year
Format: double
Minimum: 0
hourly_ratestring or nullOptionalHourly rate. Required when is_hourly is true. Must not be sent when is_hourly is false or omitted.
is_auto_quote_validation_passedboolean or nullOptionalAuto quote validation status
is_hourlyboolean or nullOptionalIndicates if compensation is hourly
is_resubmitboolean or nullOptionalIndicates if this is a resubmission
job_titlestringRequired within parentJob title (cannot be C-level position)
medical_insurancebooleanOptionalMedical insurance coverage
notice_period_after_probationnumberOptionalNotice period after probation (days)
Format: double
Minimum: 0
notice_period_during_probationnumberOptionalNotice period during probation (days)
Format: double
Minimum: 0
notice_period_typestringOptionalType of notice period
One of: STANDARD, CUSTOM
probation_periodnumber or nullOptionalProbation period duration
Format: double
Minimum: 0
probation_period_type_for_definitestringOptionalUnit of time for probation period
One of: CUSTOM, STANDARD
quote_additional_fieldsModelOptionalExpand Update EOR Contract — request body — body data quote additional fields
Additional quote-specific information
reason_for_fixed_termJSONOptionalReason for fixed-term contract
reason_for_fixed_term (oneOf 1)stringAlternativeReason for fixed-term contract
One of: SEASONAL_OR_TEMPORARY_WORK, PROJECT_BASED_EMPLOYMENT, REPLACEMENT_FOR_PERMANENT_STAFF, TRIAL_PERIODS_FOR_NEW_ROLES_OR_BUSINESSES
reason_for_fixed_term (oneOf 2)nullAlternative
salarystringOptionalAnnual salary amount. Optional; must not be sent when is_hourly is true.
schedule_idstring or nullOptionalUnique identifier for the employee's work schedule
scopeModelOptionalExpand Update EOR Contract — request body — body data scope
Scope of work description, either as a plain string or as a reference to a scope template.
seniority_datestringOptionalEmployee seniority date
Format: date
seniority_idnumberOptionalSeniority level identifier
Format: double
sick_leave_daysnumber or nullOptionalNumber of sick leave days per year
Format: double
Maximum: 90
Minimum: 0
signing_bonusstring or nullOptionalSigning bonus amount
signing_bonus_payout_typeJSONOptionalDetermines when the signing bonus will be paid out
Default: FIRST_CYCLE
signing_bonus_payout_type (oneOf 1)stringAlternativeDetermines when the signing bonus will be paid out
Default: FIRST_CYCLE
One of: FIRST_CYCLE, AFTER_PROBATION, AFTER_FIRST_CONTRACT_ANNIVERSARY
signing_bonus_payout_type (oneOf 2)nullAlternative
start_datestringRequired within parentEmployment start date
Format: date
time_off_typestringOptionalType of time off
One of: STANDARD, SPECIFIC, PRORATED
work_arrangementJSONOptionalWork arrangement type
work_arrangement (oneOf 1)stringAlternativeWork arrangement type
One of: REMOTE, ON_SITE_OR_HYBRID
work_arrangement (oneOf 2)nullAlternative
work_eligibilityModelOptionalExpand Update EOR Contract — request body — body data work eligibility
Work eligibility documentation
work_hours_per_weeknumberOptionalWorking hours per week
Format: double
Maximum: 168
Minimum: 0
work_pensionboolean or nullOptionalIndicates if work pension is included
work_visaboolean or nullOptionalIndicates if work visa is required

Referenced models: Update EOR Contract — request body — body data benefits item, Update EOR Contract — request body — body data employee address, Update EOR Contract — request body — body data quote additional fields, Update EOR Contract — request body — body data scope, Update EOR Contract — request body — body data work eligibility

Update EOR Contract — request body — body data benefits item

FieldTypePresenceDescription and constraints
$objectRootBenefit plan details
contributionnumber or nullOptionalContribution amount
Format: double
Maximum: 9999999999999
Minimum: 0
cover_allbooleanOptionalIndicates if benefit covers all
cover_dependentsbooleanOptionalIndicates if benefit covers dependents
plan_idstring or nullOptionalBenefit plan ID
provider_idstring or nullOptionalBenefit provider ID

Update EOR Contract — request body — body data employee address

FieldTypePresenceDescription and constraints
$objectRootEmployee's address information
calling_codestringOptionalCountry calling code
citystringRequired within parentCity of residence
countrystringRequired within parentCountry of residence (can be country code or name)
phonestringOptionalPhone number
provincestringOptionalProvince of residence
statestringOptionalState of residence
streetstringRequired within parentStreet address
zipstringOptionalZIP/Postal code

Update EOR Contract — request body — body data quote additional fields

FieldTypePresenceDescription and constraints
$objectRootAdditional quote-specific information
employee_typestringOptionalType of employee
One of: Employee, Manager
qualificationsstringOptionalRequired qualifications
qualifications_german_translationstringOptionalGerman translation of qualifications
scope_german_translationstringOptionalGerman translation of scope

Update EOR Contract — request body — body data scope

FieldTypePresenceDescription and constraints
$JSONRootScope of work description, either as a plain string or as a reference to a scope template.
$ (oneOf 1)stringAlternativeMaximum length: 10000
Minimum length: 100
$ (oneOf 2)ModelAlternativeExpand Update EOR Contract — request body — body data scope Reference to a scope template or validation

Referenced models: Update EOR Contract — request body — body data scope Reference to a scope template or validation

Update EOR Contract — request body — body data scope Reference to a scope template or validation

FieldTypePresenceDescription and constraints
$objectRootReference to a scope template or validation.
scope_template_idstringOptionalScope template UUID.
Format: uuid
scope_validation_idstringOptionalScope validation UUID.
Format: uuid

Update EOR Contract — request body — body data work eligibility

FieldTypePresenceDescription and constraints
$objectRootWork eligibility documentation
file_namestringRequired within parentName of the work eligibility document file
keystringRequired within parentUnique identifier for the work eligibility document

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.