Deel: EOR contract schemas
58 Deel schemas with complete fields and constraints.
← EOR contract operations · All schemas
Create an EOR contract — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client | Model | Optional | Expand Create an EOR contract — 201 response body — data client Client information for the contract. |
compensation_details | Model | Optional | Expand Create an EOR contract — 201 response body — data compensation details |
costs | Model | Optional | Expand 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_at | string | Optional | Contract creation timestamp Format: date-time |
employee | Model | Optional | Expand Create an EOR contract — 201 response body — data employee |
employment | Model | Optional | Expand Create an EOR contract — 201 response body — data employment Employment contract specific details. |
health_plan | JSON | Optional | |
health_plan (anyOf 1) | Model | Alternative | Expand Create an EOR contract — 201 response body — data health plan id, name |
health_plan (anyOf 2) | null | Alternative | |
id | string | Optional | ID of the created contract quote. |
job_category | string | Optional | Job category assigned to the role. Present only for countries that use job categorisation. |
job_code | string | Optional | Country-specific occupation code, when applicable. |
job_title | string | Optional | Employee's job title |
seniority | Model | Optional | Expand Create an EOR contract — 201 response body — data seniority Seniority level of the employee |
status | string | Optional | Current 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 |
type | string | Optional | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client information for the contract. |
legal_entity | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Legal entity name |
Create an EOR contract — 201 response body — data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency of the salary |
salary | string | Optional | Gross annual salary |
variable_compensation | string | Optional | Variable compensation account or percentage |
variable_compensation_type | JSON | Optional | |
variable_compensation_type (anyOf 1) | string | Alternative | Type of variable compensation |
variable_compensation_type (anyOf 2) | null | Alternative | Type of variable compensation |
Create an EOR contract — 201 response body — data costs
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes. |
additional_data | Model | Optional | Expand Create an EOR contract — 201 response body — data costs additional data Supplementary notes and contextual information relevant to the cost quote. |
sections | array | Optional | Detailed and categorized cost sections including grouped and standalone items. |
sections[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item |
summary | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Supplementary notes and contextual information relevant to the cost quote. |
additional_notes | array | Optional | General conditions, assumptions, or fees that may apply to the quote. |
additional_notes[] | string | Each item | |
annual_notes | array | Optional | Notes or assumptions specifically relevant to annual cost calculations. |
annual_notes[] | string | Each item | |
monthly_notes | array | Optional | Notes or assumptions specifically relevant to monthly cost calculations. |
monthly_notes[] | string | Each item | |
once_off_notes | array | Optional | Notes regarding one-time costs or irregular payments in the quote. |
once_off_notes[] | string | Each item |
Create an EOR contract — 201 response body — data costs sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
groups | array | Optional | Collections of related costs grouped under a common label. |
groups[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item groups item |
is_summarized | boolean | Optional | Indicates whether the section is presented in summarized form. |
label | string | Optional | Display name for the cost section. |
name | string | Optional | Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN). |
standalone_items | array | Optional | Cost items that do not belong to regular groups, often irregular or one-off costs. |
standalone_items[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item standalone items item |
totals | array | Optional | Overall totals for the section, summing all groups and standalone items. |
totals[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
costs | array | Optional | Individual cost items within the group. |
costs[] | Model | Each item | Expand Create an EOR contract — 201 response body — data costs sections item groups item costs item |
has_breakdown | boolean | Optional | Indicates if the group contains multiple detailed cost items to be expanded. |
label | string | Optional | Display name for the group (e.g., Gross Salary, Employer Cost). |
name | string | Optional | Internal identifier for the group. |
totals | array | Optional | Aggregated totals for all items within the group. |
totals[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Optional | Name of the specific cost item (e.g., Salary, Meal Voucher). |
totals | array | Optional | Monthly and annual totals for the cost item in local and supporting currencies. |
totals[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | How often this cost occurs (e.g., monthly, annual, one-time). |
total | string | Optional | Total cost amount in local currency. |
total_supporting | string | Optional | Total cost amount in the supporting currency. |
Create an EOR contract — 201 response body — data costs sections item groups item totals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | How often the total is calculated (e.g., monthly, annual). |
total | string | Optional | Group total in local currency. |
total_supporting | string | Optional | Group total in supporting currency. |
Create an EOR contract — 201 response body — data costs sections item standalone items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
label | string | Optional | Display name for the standalone cost item. |
name | string | Optional | Internal identifier for the standalone cost item. |
totals | array | Optional | Monthly and annual totals for the standalone item in local and supporting currencies. |
totals[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | How often this cost occurs (e.g., monthly, annual, one-time). |
total | string | Optional | Standalone cost amount in local currency. |
total_supporting | string | Optional | Standalone cost amount in the supporting currency. |
Create an EOR contract — 201 response body — data costs sections item totals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | How often the total is calculated (e.g., monthly, annual). |
total | string | Optional | Total cost for the section in local currency. |
total_supporting | string | Optional | Total cost for the section in supporting currency. |
Create an EOR contract — 201 response body — data costs summary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Top-level overview of costs, including key totals and currency metadata. |
currency | string | Optional | Local currency code (e.g., BRL, PLN). |
exchange_rate | string | Optional | Exchange rate used to convert from local to supporting currency. |
salary | string | Optional | Annual gross salary in local currency. |
supporting_currency | string | Optional | Reference or secondary currency (e.g., USD) used for reporting totals. |
totals_formatted | array | Optional | Formatted summary totals in both local and supporting currencies. |
totals_formatted[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | Time period for the total (e.g., monthly, annual). |
title | string | Optional | Display title for the total (e.g., 'Monthly Total'). |
total | string | Optional | Formatted amount in local currency. |
total_supporting | string | Optional | Formatted amount in supporting currency. |
Create an EOR contract — 201 response body — data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | Employee's email |
first_name | string | Optional | Employee's first name |
last_name | string | Optional | Employee's last name |
legal_name | string | Optional | Employee's legal name |
Create an EOR contract — 201 response body — data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment contract specific details. |
calculated_holidays | string | Optional | Number of calculated holidays |
country | string | Optional | Country of employment |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | Employment end date Format: date-time |
end_date (anyOf 2) | null | Alternative | Employment end date Format: date-time |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | JSON | Alternative | |
probation_period (anyOf 1) (anyOf 1) | integer | Alternative | Number of probation days |
probation_period (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period (anyOf 2) | null | Alternative | Number of probation days |
scope_of_work | string | Optional | Scope of work description. |
start_date | string | Optional | Employment start date Format: date-time |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State or province of employment |
state (anyOf 2) | null | Alternative | State or province of employment |
time_off_type | string | Optional | Type of time off for the employee |
work_visa_required | boolean | Optional | If a work visa is required |
Create an EOR contract — 201 response body — data health plan id, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Health plan ID |
name | string | Optional | Health plan name |
Create an EOR contract — 201 response body — data seniority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Seniority level of the employee |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | Seniority level ID |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | Seniority level name |
Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Some countries require additional employee information for employment contracts. |
dob | string | Optional | Employee's date of birth. |
gender | string | Optional | Employee's gender. |
worker_type | string | Optional | Type of worker. One of: Skilled, Unskilled |
Create an EOR contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
benefits | array | Optional | |
benefits[] | Model | Each item | Expand Create an EOR contract — request body — body data benefits item |
client | Model | Required within parent | Expand Create an EOR contract — request body — body data client Client details for the contract. |
compensation_details | Model | Required within parent | Expand Create an EOR contract — request body — body data compensation details |
employee | Model | Required within parent | Expand Create an EOR contract — request body — body data employee |
employment | Model | Required within parent | Expand Create an EOR contract — request body — body data employment Employment contract specific details. |
health_plan_id | string | Optional | Healthcare plan id. You can see available healthcare plans in the country guide endpoint. |
is_team_manager | boolean | Optional | Italy only. Whether the role is responsible for managing a team. Required when job_category is provided. |
job_category | string | Optional | Italy 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_title | string | Required within parent | Employee's job title. |
pension | Model | Optional | Expand Create an EOR contract — request body — body data pension Some countries required a pension benefit. |
quote_additional_fields | JSON | Optional | Some countries require additional employee information for employment contracts. |
quote_additional_fields (oneOf 1) | Model | Alternative | Expand Create an EOR contract — request body — body / data / quote_additional_fields / worker_type: Skilled, Unskilled |
quote_additional_fields (oneOf 2) | null | Alternative | |
reports_to_job_title | string | Optional | Italy only. Job title of the person this role reports to. Required when job_category is provided. Maximum length: 255 Minimum length: 1 |
seniority | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of additional benefits to include in the calculation |
contribution | number | Optional | The 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_all | boolean | Optional | Flag indicating if benefit will fully cover the employee. |
cover_dependents | boolean | Optional | Flag indicating if benefit will cover dependents. Only needed if cover_all is set to true. |
plan_id | string | Optional | The ID of a benefits plan to include in the calculation. |
provider_id | string | Optional | The ID of a benefits provider to include in the calculation. |
Create an EOR contract — request body — body data client
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Client details for the contract. |
legal_entity | Model | Optional | Expand Create an EOR contract — request body — body data client legal entity |
team | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Legal entity reference for the client. |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | integer | Alternative | Format: int64 |
Create an EOR contract — request body — body data client team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Team identifying information. |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | integer | Alternative | Format: int64 |
Create an EOR contract — request body — body data compensation details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Required within parent | Salary currency. |
fixed_adjustments | array | Optional | |
fixed_adjustments[] | Model | Each item | Expand Create an EOR contract — request body — body data compensation details fixed adjustments item |
hourly_rate | number | Optional | Employee's hourly rate. Required only if contract is set as hourly. Format: double |
salary | number | Optional | Employee's gross annual salary. Required only if contract is salaried. Format: double |
signing_bonus | number or null | Optional | Signing bonus amount. Format: double |
signing_bonus_payout_type | JSON | Optional | Should be set only if signing_bonus is set. It defines when the bonus is paid. |
signing_bonus_payout_type (oneOf 1) | string | Alternative | Should 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) | null | Alternative | |
variable_compensation | number or null | Optional | Variable 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_date | string | Optional | Variable compensation effective date. Format: date |
variable_compensation_timeline | JSON | Optional | Variable compensation timeline. |
variable_compensation_timeline (oneOf 1) | string | Alternative | Variable compensation timeline. One of: ANNUALLY, BIANNUALLY, QUARTERLY, MONTHLY |
variable_compensation_timeline (oneOf 2) | null | Alternative | |
variable_compensation_title | string | Optional | Variable compensation title. |
variable_compensation_type | JSON | Optional | Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED. |
variable_compensation_type (oneOf 1) | string | Alternative | Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED. One of: PERCENTAGE, FIXED |
variable_compensation_type (oneOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Adjustment description. |
is_country_specific | boolean | Optional | Whether this adjustment is country-specific. |
is_recurring | boolean | Optional | Whether the adjustment is paid recurring monthly or one-time on employee's first payroll. |
name | string | Optional | Adjustment name. |
opt_out | boolean | Optional | Whether the adjustment is being opted out of. |
optional | boolean | Optional | Whether the adjustment is optional. |
rule_cost_id | string | Optional | Identifier of the rule cost associated with the adjustment. |
skipping_confirmation_text | string | Optional | Optional skipping confirmation text shown to the user. |
value | number | Optional | Adjustment value. Format: double |
Create an EOR contract — request body — body data employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (oneOf 1) | Model | Alternative | Expand Create an EOR contract — request body — body data employee address city, country, state, street, zip |
address (oneOf 2) | null | Alternative | |
email | string | Optional | Employee's email address. |
external_id | string | Optional | External identifier of the employee. |
first_name | string | Required within parent | Employee's first name. |
last_name | string | Required within parent | Employee's last name. |
nationality | string | Required within parent | Employee's nationality. |
pf_deductions | string | Optional | Employee'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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
city | string | Optional | City name. |
country | string | Optional | Country code. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string or null | Optional | State code. |
street | string | Optional | Street and number. |
zip | string | Optional | Zip code. |
Create an EOR contract — request body — body data employment
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employment contract specific details. |
country | string | Required within parent | Country code of employment. Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
employee_completed_past_probation | boolean | Optional | Whether the employee has previously passed the probation period. Default: false |
end_date | string or null | Optional | End date in ISO-8601 format (YYYY-MM-DD). Format: date |
holidays | number or null | Optional | Enter the number of holidays. Leave this field blank if you are choosing "STANDARD" time_off_type. Format: double |
is_hourly | boolean | Optional | Is the employee contract hourly instead of salaried? |
notice_period_after_probation | number or null | Optional | Notice period after probation required when type is CUSTOM. Format: double |
notice_period_after_probation_time_unit | string | Optional | Time unit of notice period after probation. One of: DAY, WEEK, MONTH |
notice_period_during_probation | number or null | Optional | Notice period during probation required when type is CUSTOM. Format: double |
notice_period_during_probation_time_unit | string | Optional | Time unit of notice period during probation. One of: DAY, WEEK, MONTH |
notice_period_type | string | Optional | Type of notice period. One of: STANDARD, CUSTOM |
probation_period | number or null | Optional | Number of probation days. Format: double |
probation_period_time_unit | string | Optional | Time unit of probation period. One of: DAY, WEEK, MONTH |
probation_period_type_for_definite | string | Optional | Type of probation period for definite contracts. One of: STANDARD, CUSTOM |
scope_of_work | Model | Required within parent | Expand 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_date | string | Optional | Seniority date Format: date |
sick_leave_days | integer | Optional | Number of sick leave days |
start_date | string | Required within parent | Start date in ISO-8601 format (YYYY-MM-DD). Format: date |
state | string or null | Optional | State code of the state/province where the this person will be employed. |
time_off_type | string | Optional | If 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 |
type | string | Optional | Is it a full-time contract or a part-time contract? One of: Full-time, Part-time |
work_hours_per_week | number | Optional | Employee's work hours per week. Required only if contract is set as hourly. Format: double |
work_visa_required | boolean | Required within parent | Do 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Scope of work; either a string with full text or an object referencing a template/validation UUID. |
$ (oneOf 1) | string | Alternative | Maximum length: 10000 Minimum length: 100 |
$ (oneOf 2) | Model | Alternative | Expand Create an EOR contract — request body — body data employment scope of work scope template id |
$ (oneOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
scope_template_id | string | Optional | Scope template UUID. Format: uuid |
Create an EOR contract — request body — body data employment scope of work scope validation id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
scope_validation_id | string | Optional | Scope validation UUID. Format: uuid |
Create an EOR contract — request body — body data pension
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Some countries required a pension benefit. |
contribution | string | Optional | Enter 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. |
id | string | Optional | Pension provider id. You can see available pension providers in the country guide endpoint. |
Create an EOR contract — request body — body data seniority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Seniority selection for the role. |
id | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Identifier for the seniority level (string or numeric ID). |
$ (oneOf 1) | string | Alternative | |
$ (oneOf 2) | integer | Alternative | Format: int64 |
Retrieve EOR Contract Details — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
calculated_holidays | JSON | Optional | |
calculated_holidays (anyOf 1) | string | Alternative | Calculated number of holidays as a string. |
calculated_holidays (anyOf 2) | null | Alternative | Calculated number of holidays as a string. |
can_adjust_on | JSON | Optional | Time frame when adjustments can be made. |
can_adjust_on (anyOf 1) | Model | Alternative | Expand Retrieve EOR Contract Details — 200 response body — can adjust on Time frame when adjustments can be made |
can_adjust_on (anyOf 2) | null | Alternative | |
can_remind_employee_to_sign | boolean | Optional | Whether reminders to sign the employee resignation can be sent to the employee or not. |
cancelled_at | JSON | Optional | |
cancelled_at (anyOf 1) | string | Alternative | The date and time when the contract was cancelled. Format: date-time |
cancelled_at (anyOf 2) | null | Alternative | The date and time when the contract was cancelled. Format: date-time |
client_signature | JSON | Optional | |
client_signature (anyOf 1) | string | Alternative | The signature of the client. |
client_signature (anyOf 2) | null | Alternative | The signature of the client. |
client_signed_at | JSON | Optional | |
client_signed_at (anyOf 1) | string | Alternative | The date and time when the client signed the contract. Format: date-time |
client_signed_at (anyOf 2) | null | Alternative | The date and time when the client signed the contract. Format: date-time |
compensation_type | JSON | Optional | Compensation type for the contract. |
compensation_type (anyOf 1) | string | Alternative | Compensation type for the contract. Known values: HOURLY, ANNUAL |
compensation_type (anyOf 2) | null | Alternative | |
completed_at | JSON | Optional | |
completed_at (anyOf 1) | string | Alternative | The date and time when the contract was completed. Format: date-time |
completed_at (anyOf 2) | null | Alternative | The date and time when the contract was completed. Format: date-time |
completion_date | JSON | Optional | |
completion_date (anyOf 1) | string | Alternative | The completion date of the contract. Format: date-time |
completion_date (anyOf 2) | null | Alternative | The completion date of the contract. Format: date-time |
completion_plain_date | JSON | Optional | |
completion_plain_date (anyOf 1) | string | Alternative | The completion date of the contract in plain contract. Format: date |
completion_plain_date (anyOf 2) | null | Alternative | The completion date of the contract in plain contract. Format: date |
contract_type | string | Optional | The type of contract. Known values: eor |
contractor_signature | JSON | Optional | |
contractor_signature (anyOf 1) | string | Alternative | The signature of the EOR entity representative. |
contractor_signature (anyOf 2) | null | Alternative | The signature of the EOR entity representative. |
contractor_signed_at | JSON | Optional | |
contractor_signed_at (anyOf 1) | string | Alternative | The date and time when the contractor signed the contract. Format: date-time |
contractor_signed_at (anyOf 2) | null | Alternative | The date and time when the contractor signed the contract. Format: date-time |
created_at | string | Optional | The date and time when the contract was created. Format: date-time |
creator | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — creator |
currency | string | Optional | The currency used in the contract. |
deposit_months | JSON | Optional | |
deposit_months (anyOf 1) | string | Alternative | Number of deposit months required. |
deposit_months (anyOf 2) | null | Alternative | Number of deposit months required. |
description | string | Optional | Contract description |
effective_date | string | Optional | The date and time when the contract is effective. Format: date-time |
effective_plain_date | string | Optional | The effective date in plain format. Format: date |
employee | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — employee Employee details |
employee_late_sign_start | JSON | Optional | |
employee_late_sign_start (anyOf 1) | string | Alternative | Date when employee signed late, if applicable. Format: date-time |
employee_late_sign_start (anyOf 2) | null | Alternative | Date when employee signed late, if applicable. Format: date-time |
employee_signed_at | JSON | Optional | |
employee_signed_at (anyOf 1) | string | Alternative | Date and time when the employee signed. Format: date-time |
employee_signed_at (anyOf 2) | null | Alternative | Date and time when the employee signed. Format: date-time |
employment_costs | JSON | Optional | Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes. |
employment_costs (anyOf 1) | Model | Alternative | Expand Create an EOR contract — 201 response body — data costs |
employment_costs (anyOf 2) | null | Alternative | |
employment_country | string | Optional | Two letter country code of the employment country. |
employment_state | JSON | Optional | |
employment_state (anyOf 1) | string | Alternative | The state of the employment. |
employment_state (anyOf 2) | null | Alternative | The state of the employment. |
employment_type | string | Optional | The type of employment. Known values: Full-time, Part-time |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The end date of the contract, if applicable. Format: date-time |
end_date (anyOf 2) | null | Alternative | The end date of the contract, if applicable. Format: date-time |
fixed_adjustment_ids | JSON | Optional | |
fixed_adjustment_ids (anyOf 1) | array | Alternative | List of fixed adjustment ids. |
fixed_adjustment_ids (anyOf 1)[] | string | Each item | |
fixed_adjustment_ids (anyOf 2) | null | Alternative | List of fixed adjustment ids. |
fixed_adjustment_ids (anyOf 2)[] | string | Each item | |
hiring_objective | JSON | Optional | Information about the hiring objective. |
hiring_objective (anyOf 1) | Model | Alternative | Expand Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective |
hiring_objective (anyOf 2) | null | Alternative | |
holidays | JSON | Optional | |
holidays (anyOf 1) | JSON | Alternative | |
holidays (anyOf 1) (anyOf 1) | integer | Alternative | Number of holidays for the contract. |
holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
holidays (anyOf 2) | null | Alternative | Number of holidays for the contract. |
hourly_rate | JSON | Optional | |
hourly_rate (anyOf 1) | string | Alternative | Hourly rate as a string to preserve decimal precision. |
hourly_rate (anyOf 2) | null | Alternative | Hourly rate as a string to preserve decimal precision. |
hris_profile_id | JSON | Optional | |
hris_profile_id (anyOf 1) | string | Alternative | The HRIS profile ID linked to this contract. Format: uuid |
hris_profile_id (anyOf 2) | null | Alternative | The HRIS profile ID linked to this contract. Format: uuid |
id | string | Optional | The unique identifier for the Deel contract. |
initial_effective_plain_date | string | Optional | The initial effective date in plain format. Format: date |
invited_client_email | JSON | Optional | |
invited_client_email (anyOf 1) | string | Alternative | The email address of the invited client. |
invited_client_email (anyOf 2) | null | Alternative | The email address of the invited client. |
is_early_invoice_enabled | boolean | Optional | Whether early invoicing is enabled or not. |
is_employee_onboarding_delayed | boolean | Optional | Determines if the invite for employee onboarding should be dispatch manually. |
is_foreign_currency_contract | boolean | Optional | Whether the contract uses foreign currency or not. |
is_onboarding_on_hold | boolean | Optional | Whether onboarding is currently on hold or not. |
job_title_name | JSON | Optional | |
job_title_name (anyOf 1) | string | Alternative | The contract's job title. |
job_title_name (anyOf 2) | null | Alternative | The contract's job title. |
last_quote_rejection | JSON | Optional | Timestamp of last quote rejection. |
last_quote_rejection (anyOf 1) | Model | Alternative | Expand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection |
last_quote_rejection (anyOf 2) | null | Alternative | |
monthly_employer_cost | string | Optional | Monthly cost to the employer. |
monthly_eor_management_fee_usd | string | Optional | Monthly EOR management fee in USD. |
name | string | Optional | Contract name |
notice_period_type | JSON | Optional | Type of notice period if applicable. |
notice_period_type (anyOf 1) | string | Alternative | Type of notice period if applicable. Known values: STANDARD, CUSTOM |
notice_period_type (anyOf 2) | null | Alternative | |
onboarding_step_duration | JSON | Optional | |
onboarding_step_duration (anyOf 1) | JSON | Alternative | |
onboarding_step_duration (anyOf 1) (anyOf 1) | integer | Alternative | Duration of onboarding steps in days. |
onboarding_step_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
onboarding_step_duration (anyOf 2) | null | Alternative | Duration of onboarding steps in days. |
original_start_date | string | Optional | The originally planned start date. Format: date-time |
payroll_type | string | Optional | Payroll frequency for the contract Known values: BIMONTHLY, MONTHLY, BIWEEKLY, WEEKLY, FOUR_WEEKLY, QUARTERLY |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | integer | Alternative | Number of days in the probation period. |
probation_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period_type_for_definite | JSON | Optional | Probation period type for definite contracts. |
probation_period_type_for_definite (anyOf 1) | string | Alternative | Probation period type for definite contracts. Known values: STANDARD, CUSTOM |
probation_period_type_for_definite (anyOf 2) | null | Alternative | |
salary | string | Optional | Annual salary as a string to preserve decimal precision. |
scope_of_work | string | Optional | Description of job scope and responsibilities. |
seniority | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — seniority |
sick_days | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — sick days Allowed sick days range. |
signed_date | JSON | Optional | |
signed_date (anyOf 1) | string | Alternative | The date and time when the contract was signed by both parties. Format: date-time |
signed_date (anyOf 2) | null | Alternative | The date and time when the contract was signed by both parties. Format: date-time |
signing_bonus | JSON | Optional | |
signing_bonus (anyOf 1) | string | Alternative | One-time bonus paid at contract sign. |
signing_bonus (anyOf 2) | null | Alternative | One-time bonus paid at contract sign. |
signing_bonus_payout_type | JSON | Optional | Defines when the signing bonus is paid. Set only when signing_bonus is present. |
signing_bonus_payout_type (anyOf 1) | string | Alternative | Defines 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) | null | Alternative | |
start_date | string | Optional | The start date of the contract. Format: date-time |
status | string | Optional | The 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 |
team | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — team |
time_off_type | string | Optional | Type of time off policy. Known values: STANDARD, SPECIFIC, PRORATED |
timezone | string | Optional | The timezone of the contract. |
updated_at | string | Optional | The date and time when the contract was last updated. Format: date-time |
variable_compensation_ids | array | Optional | List of variable compensation IDs. |
variable_compensation_ids[] | string | Each item | |
work_arrangement_type | JSON | Optional | Work arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified. |
work_arrangement_type (anyOf 1) | string | Alternative | Work arrangement type of the EOR contract (Deel Field Solutions classification). Null if unclassified. Known values: REMOTE, ONSITE, FIELD, HYBRID |
work_arrangement_type (anyOf 2) | null | Alternative | |
work_hours_per_week | string | Optional | Number of work hours per week. |
work_schedule_assignment_settings | string | Optional | Work schedule assignment setting. Known values: NOT_AVAILABLE, SPECIFIC_SCHEDULES, GENERAL_SCHEDULES, ONE_TIME_AMENDMENT |
work_visa | boolean | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time frame when adjustments can be made. |
end | string | Optional | End of the period when adjustments can be made. |
start | string | Optional | Start of the period when adjustments can be made. |
Retrieve EOR Contract Details — 200 response body — creator
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the contract creator. |
firstname | string | Optional | The first name of the contract creator. |
name | string | Optional | The name of the contract creator. |
Retrieve EOR Contract Details — 200 response body — employee
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee details |
email | string | Optional | The email of the employee. |
first_name | string | Optional | The first name of the employee. |
last_name | string | Optional | The last name of the employee. |
legal_name | string | Optional | The legal name of the employee. |
nationality | string | Optional | Two letter country code of the employee nationality. |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL to employee's picture. |
pic_url (anyOf 2) | null | Alternative | URL to employee's picture. |
Retrieve EOR Contract Details — 200 response body — hiring objective Information about the hiring objective
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the hiring objective. |
extra_info | JSON | Optional | |
extra_info (anyOf 1) | string | Alternative | |
extra_info (anyOf 2) | null | Alternative | |
type | string | Optional | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Timestamp of last quote rejection. |
created_at | string | Optional | Timestamp of when the rejection was made. |
rejected_by | Model | Optional | Expand Retrieve EOR Contract Details — 200 response body — last quote rejection Timestamp of last quote rejection rejected by Details of the person who rejected. |
rejection_message | JSON | Optional | |
rejection_message (anyOf 1) | string | Alternative | Optional message explaining the rejection. |
rejection_message (anyOf 2) | null | Alternative | Optional message explaining the rejection. |
rejection_reason | string | Optional | Reason 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_type | JSON | Optional | Type of rejection. |
rejection_type (anyOf 1) | string | Alternative | Type of rejection. Known values: CLIENT, EOR_AGENT |
rejection_type (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the person who rejected. |
name | string | Optional | Full name of the rejecting person. |
profile_public_id | string | Optional | Public identifier for the rejecting person's profile. Format: uuid |
Retrieve EOR Contract Details — 200 response body — seniority
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | number | Alternative | The unique identifier for the seniority level. Format: double |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | The name of the seniority level. |
Retrieve EOR Contract Details — 200 response body — sick days
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Allowed sick days range. |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum number of sick days allowed. |
max (anyOf 2) | null | Alternative | Maximum number of sick days allowed. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum number of sick days allowed. |
min (anyOf 2) | null | Alternative | Minimum number of sick days allowed. |
Retrieve EOR Contract Details — 200 response body — team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier for the team. |
name | string | Optional | The name of the team. |
Update EOR Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
oid | string | Required within parent | The unique identifier of the employee contract. |
scope_of_work | string | Optional | Scope of work description. |
status | string | Required within parent | Current 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_consultant_equipment_reimbursement | boolean | Optional | Allow equipment reimbursement for consultants |
benefits | array or null | Optional | Array of employee benefits |
benefits[] | Model | Each item | Expand Update EOR Contract — request body — body data benefits item |
contract_term_type | string | Optional | Type of contract term One of: DEFINITE, INDEFINITE |
currency | string | Optional | Currency code for salary and benefits |
employee_address | Model | Optional | Expand Update EOR Contract — request body — body data employee address Employee's address information |
employee_email | string | Required within parent | Employee's email address Format: email |
employee_first_name | string | Required within parent | Employee's first name |
employee_id | string | Optional | Employee's unique identifier |
employee_last_name | string | Required within parent | Employee's last name |
employee_nationality | string | Optional | Employee's nationality |
employment_country | string | Required within parent | Country of employment |
employment_state | string or null | Optional | State/Province of employment |
employment_type | string | Required within parent | Type of employment One of: Full-time, Part-time |
end_date | string or null | Optional | Employment end date Format: date |
hiring_objective | string | Optional | Objective for hiring One of: EXPANDING_TO_NEW_COUNTRY, TEMP_EOR_OPENING_ENTITY, ONE_OFF_HIRE, CONVERTING_CONTRACTOR, OTHER |
hiring_objective_extra_info | string or null | Optional | Additional information about hiring objective |
holidays | number or null | Optional | Number of holiday days per year Format: double Minimum: 0 |
hourly_rate | string or null | Optional | Hourly rate. Required when is_hourly is true. Must not be sent when is_hourly is false or omitted. |
is_auto_quote_validation_passed | boolean or null | Optional | Auto quote validation status |
is_hourly | boolean or null | Optional | Indicates if compensation is hourly |
is_resubmit | boolean or null | Optional | Indicates if this is a resubmission |
job_title | string | Required within parent | Job title (cannot be C-level position) |
medical_insurance | boolean | Optional | Medical insurance coverage |
notice_period_after_probation | number | Optional | Notice period after probation (days) Format: double Minimum: 0 |
notice_period_during_probation | number | Optional | Notice period during probation (days) Format: double Minimum: 0 |
notice_period_type | string | Optional | Type of notice period One of: STANDARD, CUSTOM |
probation_period | number or null | Optional | Probation period duration Format: double Minimum: 0 |
probation_period_type_for_definite | string | Optional | Unit of time for probation period One of: CUSTOM, STANDARD |
quote_additional_fields | Model | Optional | Expand Update EOR Contract — request body — body data quote additional fields Additional quote-specific information |
reason_for_fixed_term | JSON | Optional | Reason for fixed-term contract |
reason_for_fixed_term (oneOf 1) | string | Alternative | Reason 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) | null | Alternative | |
salary | string | Optional | Annual salary amount. Optional; must not be sent when is_hourly is true. |
schedule_id | string or null | Optional | Unique identifier for the employee's work schedule |
scope | Model | Optional | Expand 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_date | string | Optional | Employee seniority date Format: date |
seniority_id | number | Optional | Seniority level identifier Format: double |
sick_leave_days | number or null | Optional | Number of sick leave days per year Format: double Maximum: 90 Minimum: 0 |
signing_bonus | string or null | Optional | Signing bonus amount |
signing_bonus_payout_type | JSON | Optional | Determines when the signing bonus will be paid out Default: FIRST_CYCLE |
signing_bonus_payout_type (oneOf 1) | string | Alternative | Determines 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) | null | Alternative | |
start_date | string | Required within parent | Employment start date Format: date |
time_off_type | string | Optional | Type of time off One of: STANDARD, SPECIFIC, PRORATED |
work_arrangement | JSON | Optional | Work arrangement type |
work_arrangement (oneOf 1) | string | Alternative | Work arrangement type One of: REMOTE, ON_SITE_OR_HYBRID |
work_arrangement (oneOf 2) | null | Alternative | |
work_eligibility | Model | Optional | Expand Update EOR Contract — request body — body data work eligibility Work eligibility documentation |
work_hours_per_week | number | Optional | Working hours per week Format: double Maximum: 168 Minimum: 0 |
work_pension | boolean or null | Optional | Indicates if work pension is included |
work_visa | boolean or null | Optional | Indicates 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Benefit plan details |
contribution | number or null | Optional | Contribution amount Format: double Maximum: 9999999999999 Minimum: 0 |
cover_all | boolean | Optional | Indicates if benefit covers all |
cover_dependents | boolean | Optional | Indicates if benefit covers dependents |
plan_id | string or null | Optional | Benefit plan ID |
provider_id | string or null | Optional | Benefit provider ID |
Update EOR Contract — request body — body data employee address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Employee's address information |
calling_code | string | Optional | Country calling code |
city | string | Required within parent | City of residence |
country | string | Required within parent | Country of residence (can be country code or name) |
phone | string | Optional | Phone number |
province | string | Optional | Province of residence |
state | string | Optional | State of residence |
street | string | Required within parent | Street address |
zip | string | Optional | ZIP/Postal code |
Update EOR Contract — request body — body data quote additional fields
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional quote-specific information |
employee_type | string | Optional | Type of employee One of: Employee, Manager |
qualifications | string | Optional | Required qualifications |
qualifications_german_translation | string | Optional | German translation of qualifications |
scope_german_translation | string | Optional | German translation of scope |
Update EOR Contract — request body — body data scope
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Scope of work description, either as a plain string or as a reference to a scope template. |
$ (oneOf 1) | string | Alternative | Maximum length: 10000 Minimum length: 100 |
$ (oneOf 2) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to a scope template or validation. |
scope_template_id | string | Optional | Scope template UUID. Format: uuid |
scope_validation_id | string | Optional | Scope validation UUID. Format: uuid |
Update EOR Contract — request body — body data work eligibility
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Work eligibility documentation |
file_name | string | Required within parent | Name of the work eligibility document file |
key | string | Required within parent | Unique identifier for the work eligibility document |