Skip to content

Deel: EOR hiring schemas

57 Deel schemas with complete fields and constraints.

← EOR hiring operations · All schemas

Cancel EOR Contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
cancellation_messagestringOptionalMessage for contract termination
cancellation_reasonstringRequired within parentReason for contract termination
One of: INTERNAL_DECISION, UNSATISFACTORY_EXPERIENCE, EXPLORING_ALTERNATIVE, OFFER_CHANGES

Delay EOR employee onboarding — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
contractOidstringOptionalContract OID
is_employee_onboarding_delayedbooleanOptionalCurrent onboarding delay status
successbooleanRequired within parentOperation success status

Delay EOR employee onboarding — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
is_employee_onboarding_delayedbooleanRequired within parentIndicates if the employee onboarding is delayed

Fetch EOR Contract form — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Fetch EOR Contract form — 200 response body — data

Referenced models: Fetch EOR Contract form — 200 response body — data

Fetch EOR Contract form — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
pagesarrayRequired within parentList of pages in the form.
pages[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item

Referenced models: Fetch EOR Contract form — 200 response body — data pages item

Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.probation_period` question.
probation_type_for_definiteModelRequired within parentExpand Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT probation type for definite
How the probation period is determined for definite (fixed-term) contracts. Possible values: STANDARD (fixed statutory period), SPECIFIC_CALCULATION (calculated from a rule), SPECIFIC_TO_DURATION_OF_CONTRACT (derived from contract length).
specific_calculation_rulesJSONOptionalCalculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types.
specific_calculation_rules (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific calculation rules time unit: DAY, WEEK, MONTH
specific_calculation_rules (anyOf 2)nullAlternative
specific_to_duration_of_contract_rulesJSONOptional
specific_to_duration_of_contract_rules (anyOf 1)arrayAlternativeRules mapping contract duration ranges to probation periods when probation_type_for_definite is SPECIFIC_TO_DURATION_OF_CONTRACT. Null for other types.
specific_to_duration_of_contract_rules (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific to duration of contract rules null item
specific_to_duration_of_contract_rules (anyOf 2)nullAlternativeRules mapping contract duration ranges to probation periods when probation_type_for_definite is SPECIFIC_TO_DURATION_OF_CONTRACT. Null for other types.
specific_to_duration_of_contract_rules (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific to duration of contract rules null item

Referenced models: Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT probation type for definite, Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific calculation rules time unit: DAY, WEEK, MONTH, Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific to duration of contract rules null item

Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT probation type for definite

FieldTypePresenceDescription and constraints
$stringRootHow the probation period is determined for definite (fixed-term) contracts. Possible values: STANDARD (fixed statutory period), SPECIFIC_CALCULATION (calculated from a rule), SPECIFIC_TO_DURATION_OF_CONTRACT (derived from contract length).
Known values: STANDARD, SPECIFIC_CALCULATION, SPECIFIC_TO_DURATION_OF_CONTRACT

Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific calculation rules time unit: DAY, WEEK, MONTH

FieldTypePresenceDescription and constraints
$objectRootCalculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types.
max_probation_for_definiteJSONOptional
max_probation_for_definite (anyOf 1)numberAlternativeMaximum probation duration (in the unit specified by time_unit).
Format: double
max_probation_for_definite (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_probation_type_for_definitestringOptionalThe formula used to derive the maximum probation period for a definite contract.
min_probation_for_definiteJSONOptional
min_probation_for_definite (anyOf 1)numberAlternativeMinimum probation duration (in the unit specified by time_unit).
Format: double
min_probation_for_definite (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time_unitstringOptionalTime unit for all probation durations in this object (DAY, WEEK, or MONTH).
Known values: DAY, WEEK, MONTH

Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT specific to duration of contract rules null item

FieldTypePresenceDescription and constraints
$objectRoot
employment_duration_typestringOptionalTime unit for the employment duration bounds (DAY, WEEK, MONTH, or YEAR).
Known values: DAY, WEEK, MONTH, YEAR
max_employment_durationJSONOptional
max_employment_duration (anyOf 1)JSONAlternative
max_employment_duration (anyOf 1) (anyOf 1)numberAlternativeUpper bound of the contract duration range. Null when unbounded.
Format: double
max_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_employment_duration (anyOf 2)nullAlternativeUpper bound of the contract duration range. Null when unbounded.
Format: double
min_employment_durationJSONOptional
min_employment_duration (anyOf 1)numberAlternativeLower bound of the contract duration range.
Format: double
min_employment_duration (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_probation_periodJSONOptional
min_probation_period (anyOf 1)numberAlternativeMinimum probation duration for contracts in this range.
Format: double
min_probation_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
probation_periodJSONOptional
probation_period (anyOf 1)numberAlternativeProbation duration for contracts in this range.
Format: double
probation_period (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time_unitstringOptionalTime unit for probation_period and min_probation_period (DAY, WEEK, or MONTH).
Known values: DAY, WEEK, MONTH

Fetch EOR Contract form — 200 response body — data pages item

FieldTypePresenceDescription and constraints
$objectRoot
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeWhether the entire page is disabled for the selected country.
is_disabled (anyOf 2)nullAlternativeWhether the entire page is disabled for the selected country.
sectionsarrayRequired within parentSections within the page.
sections[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item
titlestringRequired within parentTitle of the form page.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item

Fetch EOR Contract form — 200 response body — data pages item sections item

FieldTypePresenceDescription and constraints
$objectRoot
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeWhether the entire section is disabled.
is_disabled (anyOf 2)nullAlternativeWhether the entire section is disabled.
questionsarrayRequired within parentList of questions within the section.
questions[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section.
titlestringRequired within parentTitle of the section.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item

FieldTypePresenceDescription and constraints
$objectRoot
additional_infoJSONOptionalCountry-specific metadata for the question. The shape depends on the question key: `employment.start_date` → payroll scheduling info; `employment.end_date` → definite-contract configuration; `compensation_details.salary` → salary bounds; `employment.holidays` → PTO bounds; `employment.probation_period` → probation rules; `employment.notice_period_type` → notice period rules matrix.
additional_info (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value
additional_info (anyOf 2)nullAlternative
date_limitationJSONOptionalLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
date_limitation (anyOf 1)stringAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
Known values: BLOCK_PAST, BLOCK_FUTURE
date_limitation (anyOf 2)nullAlternative
default_valueModelOptionalExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
Default value to pre-fill in the form.
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeAdditional information to assist the user.
helper_text (anyOf 2)nullAlternativeAdditional information to assist the user.
is_disabledbooleanOptionalIf true, the field is disabled and cannot be edited.
is_multiple_selectionbooleanOptionalIndicates if the user can select multiple values.
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions.
is_rangebooleanOptionalSpecifies whether a date picker allows range selection.
is_requiredbooleanOptionalIndicates if the question is required.
keystringRequired within parentUnique key identifier for the question.
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum character length for text responses.
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum character length for text responses.
max_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value
Maximum value allowed.
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum character length for text responses.
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum character length for text responses.
min_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
Minimum value allowed.
must_request_validationbooleanOptionalWhether additional validation should be triggered for this field.
number_typestringOptionalUsed for number fields to define the unit or representation.
optionsJSONOptional
options (anyOf 1)arrayAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item
options (anyOf 2)nullAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item
questionsJSONOptional
questions (anyOf 1)arrayAlternativeFor Nested questions: the child questions within this group.
questions (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item
questions (anyOf 2)nullAlternativeFor Nested questions: the child questions within this group.
questions (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item
rulesJSONOptional
rules (anyOf 1)arrayAlternativeValidation rules for the question.
rules (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item
rules (anyOf 2)nullAlternativeValidation rules for the question.
rules (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item
sourceJSONOptionalDefines dynamic data source for the question.
source (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question
source (anyOf 2)nullAlternative
time_unitJSONOptional
time_unit (anyOf 1)stringAlternativeTime unit associated with numeric duration questions.
time_unit (anyOf 2)nullAlternativeTime unit associated with numeric duration questions.
titlestringRequired within parentTitle of the question.
typestringRequired within parentType of the question.
Known values: FreeText, Paragraph, SingleSelection, MultiSelection, Address, PhoneNumber, DocumentUpload, Number, Dropdown, DatePicker, Email, CustomDropdown, PresetDropdown, Nested
variant_idJSONOptional
variant_id (anyOf 1)stringAlternativeVariant identifier used to distinguish different renderings of the same key.
variant_id (anyOf 2)nullAlternativeVariant identifier used to distinguish different renderings of the same key.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item, Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item, Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value

FieldTypePresenceDescription and constraints
$JSONRootCountry-specific metadata for the question. The shape depends on the question key: `employment.start_date` → payroll scheduling info; `employment.end_date` → definite-contract configuration; `compensation_details.salary` → salary bounds; `employment.holidays` → PTO bounds; `employment.probation_period` → probation rules; `employment.notice_period_type` → notice period rules matrix.
$ (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value is same month payment country, min value buffer in days, payroll lock
$ (anyOf 2)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type
$ (anyOf 3)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week
$ (anyOf 4)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value max holidays, min holidays, part time holiday type, standard hours per week
$ (anyOf 5)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT
$ (anyOf 6)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value is same month payment country, min value buffer in days, payroll lock, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value max holidays, min holidays, part time holiday type, standard hours per week, Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `compensation_details.salary` question.
additional_paymentsarrayRequired within parentCountry-mandated irregular payments (e.g. 13th salary, profit sharing) that are included in the total employment cost.
additional_payments[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week additional payments item
max_salaryJSONRequired within parent
max_salary (anyOf 1)JSONAlternative
max_salary (anyOf 1) (anyOf 1)numberAlternativeMaximum allowable gross annual salary for this country. Null when no maximum salary is configured for the country.
Format: double
max_salary (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_salary (anyOf 2)nullAlternativeMaximum allowable gross annual salary for this country. Null when no maximum salary is configured for the country.
Format: double
min_salaryJSONRequired within parent
min_salary (anyOf 1)JSONAlternative
min_salary (anyOf 1) (anyOf 1)numberAlternativeMinimum allowable gross annual salary for this country. Null when no minimum salary is configured for the country.
Format: double
min_salary (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_salary (anyOf 2)nullAlternativeMinimum allowable gross annual salary for this country. Null when no minimum salary is configured for the country.
Format: double
part_time_holiday_typestringOptionalHow holiday pay is calculated for part-time employees (e.g. PRORATED, STANDARD).
standard_hours_per_weekJSONOptional
standard_hours_per_week (anyOf 1)numberAlternativeStandard working hours per week used as the full-time reference.
Format: double
standard_hours_per_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week additional payments item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week additional payments item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONOptional
amount (anyOf 1)JSONAlternative
amount (anyOf 1) (anyOf 1)numberAlternativeFixed amount of the payment (0 when it is percentage-based).
Format: double
amount (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amount (anyOf 2)nullAlternativeFixed amount of the payment (0 when it is percentage-based).
Format: double
how_its_calculatedJSONOptional
how_its_calculated (anyOf 1)stringAlternativeHuman-readable explanation of the calculation method.
how_its_calculated (anyOf 2)nullAlternativeHuman-readable explanation of the calculation method.
invoicing_monthsJSONOptional
invoicing_months (anyOf 1)arrayAlternativeMonths in which the payment is invoiced.
invoicing_months (anyOf 1)[]stringEach item
invoicing_months (anyOf 2)nullAlternativeMonths in which the payment is invoiced.
invoicing_months (anyOf 2)[]stringEach item
invoicing_typeJSONOptional
invoicing_type (anyOf 1)stringAlternativeHow the payment is invoiced (e.g. Single Month, Multiple Months).
invoicing_type (anyOf 2)nullAlternativeHow the payment is invoiced (e.g. Single Month, Multiple Months).
payment_local_nameJSONOptional
payment_local_name (anyOf 1)stringAlternativeLocal-language name of the additional payment.
payment_local_name (anyOf 2)nullAlternativeLocal-language name of the additional payment.
payment_namestringOptionalDisplay name of the additional payment.

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value is same month payment country, min value buffer in days, payroll lock

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.start_date` question.
is_same_month_payment_countrybooleanRequired within parentWhether this country processes payroll in the same month as the employment start date (true) or the following month (false).
min_value_buffer_in_daysJSONRequired within parent
min_value_buffer_in_days (anyOf 1)JSONAlternative
min_value_buffer_in_days (anyOf 1) (anyOf 1)integerAlternativeMinimum number of days from today before a start date can be selected. A value of 0 means the earliest available date is today (or the first upcoming payroll-eligible date). Null when no start date buffer is configured for the country.
min_value_buffer_in_days (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_value_buffer_in_days (anyOf 2)nullAlternativeMinimum number of days from today before a start date can be selected. A value of 0 means the earliest available date is today (or the first upcoming payroll-eligible date). Null when no start date buffer is configured for the country.
payroll_lockJSONRequired within parent
payroll_lock (anyOf 1)integerAlternativeDay of the month after which the start date can no longer be set in the current month (payroll lock day).
payroll_lock (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value max holidays, min holidays, part time holiday type, standard hours per week

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.holidays` question.
max_holidaysJSONOptional
max_holidays (anyOf 1)JSONAlternative
max_holidays (anyOf 1) (anyOf 1)numberAlternativeMaximum paid vacation days allowed. Null when there is no upper limit.
Format: double
max_holidays (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_holidays (anyOf 2)nullAlternativeMaximum paid vacation days allowed. Null when there is no upper limit.
Format: double
min_holidaysJSONRequired within parent
min_holidays (anyOf 1)numberAlternativeMinimum statutory paid vacation days for this country.
Format: double
min_holidays (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
part_time_holiday_typestringOptionalHow holiday entitlement is calculated for part-time employees (e.g. PRORATED, STANDARD).
standard_hours_per_weekJSONRequired within parent
standard_hours_per_week (anyOf 1)numberAlternativeStandard working hours per week used as the full-time reference.
Format: double
standard_hours_per_week (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.end_date` question.
maximum_limitation_in_monthsJSONOptional
maximum_limitation_in_months (anyOf 1)JSONAlternative
maximum_limitation_in_months (anyOf 1) (anyOf 1)integerAlternativeMaximum fixed-term contract duration in months. Null when there is no maximum limitation.
maximum_limitation_in_months (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maximum_limitation_in_months (anyOf 2)nullAlternativeMaximum fixed-term contract duration in months. Null when there is no maximum limitation.
min_value_buffer_in_daysJSONOptional
min_value_buffer_in_days (anyOf 1)JSONAlternative
min_value_buffer_in_days (anyOf 1) (anyOf 1)integerAlternativeMinimum fixed-term contract duration in days. Null when definite contracts are not allowed (type is NOT_ALLOWED). Represents the minimum gap between start_date and end_date.
min_value_buffer_in_days (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_value_buffer_in_days (anyOf 2)nullAlternativeMinimum fixed-term contract duration in days. Null when definite contracts are not allowed (type is NOT_ALLOWED). Represents the minimum gap between start_date and end_date.
typeModelRequired within parentExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type type
Definite-contract policy for this country. Possible values: NOT_ALLOWED (no fixed-term contracts), ALLOWED_WITHOUT_LIMITATION (fixed-term allowed without duration limit), ALLOWED_WITH_MAXIMUM_LIMITATION (fixed-term allowed up to a maximum duration).

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type type

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type type

FieldTypePresenceDescription and constraints
$stringRootDefinite-contract policy for this country. Possible values: NOT_ALLOWED (no fixed-term contracts), ALLOWED_WITHOUT_LIMITATION (fixed-term allowed without duration limit), ALLOWED_WITH_MAXIMUM_LIMITATION (fixed-term allowed up to a maximum duration).
Known values: NOT_ALLOWED, ALLOWED_WITHOUT_LIMITATION, ALLOWED_WITH_MAXIMUM_LIMITATION

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit

FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.notice_period_type` question.
notice_period_rule_typestringRequired within parentNotice-period rule type for the country (e.g. LIMITED_AGREEMENT, FIXED_AGREEMENT).
notice_period_settingsarrayRequired within parentNotice-period configuration, one entry per employment type and term combination.
notice_period_settings[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item
notice_period_time_unitstringRequired within parentPrimary display time unit for the notice period (DAY, WEEK, or MONTH).

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item

FieldTypePresenceDescription and constraints
$objectRoot
employment_termstringOptionalEmployment term this rule applies to.
Known values: DEFINITE, INDEFINITE
employment_typestringOptionalEmployment type this rule applies to.
Known values: FULL_TIME, PART_TIME
notice_period_after_probationModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item notice period after probation
Notice period minimum/maximum bounds and default for this segment.
notice_period_during_probationModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item notice period after probation
Notice period minimum/maximum bounds and default for this segment.
tenure_rulesarrayOptionalTenure-based notice period rules, used when the notice type is TENURE_BASED.
tenure_rules[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item tenure rules item
type_for_after_probationstringOptionalHow the notice period is determined after probation (e.g. NO_NOTICE_PERIOD, MIN_MAX_LIMITED, SPECIFIC, TENURE_BASED).
type_for_during_probationstringOptionalHow the notice period is determined during probation (e.g. NO_NOTICE_PERIOD, MIN_MAX_LIMITED, SPECIFIC, TENURE_BASED).

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item notice period after probation, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item tenure rules item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item notice period after probation

FieldTypePresenceDescription and constraints
$objectRootNotice period minimum/maximum bounds and default for this segment.
default_valueJSONOptional
default_value (anyOf 1)JSONAlternative
default_value (anyOf 1) (anyOf 1)integerAlternativeDefault notice period value. Null when there is no default.
default_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
default_value (anyOf 2)nullAlternativeDefault notice period value. Null when there is no default.
max_valueJSONOptional
max_value (anyOf 1)JSONAlternative
max_value (anyOf 1) (anyOf 1)integerAlternativeMaximum notice period value. Null when not applicable.
max_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_value (anyOf 2)nullAlternativeMaximum notice period value. Null when not applicable.
min_valueJSONOptional
min_value (anyOf 1)JSONAlternative
min_value (anyOf 1) (anyOf 1)integerAlternativeMinimum notice period value. Null when not applicable.
min_value (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_value (anyOf 2)nullAlternativeMinimum notice period value. Null when not applicable.
time_unitstringOptionalTime unit for the notice period values.
Known values: DAY, WEEK, MONTH

Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item tenure rules item

FieldTypePresenceDescription and constraints
$objectRoot
employment_duration_typestringOptionalTime unit for the employment-duration bounds.
Known values: DAY, WEEK, MONTH, YEAR
max_employment_durationJSONOptional
max_employment_duration (anyOf 1)JSONAlternative
max_employment_duration (anyOf 1) (anyOf 1)integerAlternativeUpper bound of the employment-duration range. Null when unbounded.
max_employment_duration (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_employment_duration (anyOf 2)nullAlternativeUpper bound of the employment-duration range. Null when unbounded.
min_employment_durationJSONOptional
min_employment_duration (anyOf 1)integerAlternativeLower bound of the employment-duration range.
min_employment_duration (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
notice_valueJSONOptional
notice_value (anyOf 1)integerAlternativeNotice period value for contracts in this tenure range.
notice_value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
time_unitstringOptionalTime unit for notice_value.
Known values: DAY, WEEK, MONTH

Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value

FieldTypePresenceDescription and constraints
$JSONRootMaximum value allowed.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value

FieldTypePresenceDescription and constraints
$JSONRootMinimum value allowed.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item

FieldTypePresenceDescription and constraints
$objectRoot
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeWhether this specific option is disabled for the selected country.
is_disabled (anyOf 2)nullAlternativeWhether this specific option is disabled for the selected country.
rulesJSONOptional
rules (anyOf 1)arrayAlternativeConditional rules that apply when this option is selected.
rules (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item
rules (anyOf 2)nullAlternativeConditional rules that apply when this option is selected.
rules (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item
titlestringOptionalDisplay text for the option.
valueJSONOptional
value (anyOf 1)stringAlternativeValue associated with the option.
value (anyOf 2)nullAlternativeValue associated with the option.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item

FieldTypePresenceDescription and constraints
$objectRootA rule that modifies another question based on this option being selected.

Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item

FieldTypePresenceDescription and constraints
$objectRootA single child question within a Nested parent.

Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item

FieldTypePresenceDescription and constraints
$objectRoot
date_limitationJSONOptional
date_limitation (anyOf 1)stringAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
date_limitation (anyOf 2)nullAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
default_valueModelOptionalExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
Default value to pre-fill in the form.
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeAdditional information to assist the user.
helper_text (anyOf 2)nullAlternativeAdditional information to assist the user.
is_disabledbooleanOptionalIf true, the field is disabled and cannot be edited.
is_multiple_selectionbooleanOptionalIndicates if the user can select multiple values.
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions.
is_rangebooleanOptionalSpecifies whether a date picker allows range selection.
is_requiredbooleanOptionalIndicates if the question is required.
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum character length for text responses.
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum character length for text responses.
max_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value
Maximum value allowed.
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum character length for text responses.
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum character length for text responses.
min_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
Minimum value allowed.
must_request_validationbooleanOptionalWhether additional validation should be triggered for this field.
number_typestringOptionalUsed for number fields to define the unit or representation.
optionsJSONOptional
options (anyOf 1)arrayAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 1)[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
options (anyOf 2)nullAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 2)[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
requiresarrayOptionalList of conditions that must be met for this rule to apply.
requires[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item
sourceJSONOptionalDefines dynamic data source for the question.
source (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question
source (anyOf 2)nullAlternative
titlestringOptionalTitle of the question.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item, Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item

Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item

FieldTypePresenceDescription and constraints
$objectRoot
compare_keyJSONOptional
compare_key (anyOf 1)stringAlternativeKey of the field to compare against.
compare_key (anyOf 2)nullAlternativeKey of the field to compare against.
keystringOptionalKey of the dependent field.
operatorJSONOptional
operator (anyOf 1)stringAlternativeComparison operator (e.g., 'eq', 'ne').
operator (anyOf 2)nullAlternativeComparison operator (e.g., 'eq', 'ne').
valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value
Expected value for the condition.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value

Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value

FieldTypePresenceDescription and constraints
$JSONRootExpected value for the condition.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative

Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question

FieldTypePresenceDescription and constraints
$objectRootDefines dynamic data source for the question.
definitionstringOptionalReference URL for API documentation.
descriptionstringOptionalDescription of the data source.
urlstringOptionalAPI endpoint providing dynamic options.

Fetch Start Date for EOR Contracts — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Fetch Start Date for EOR Contracts — 200 response body — data

Referenced models: Fetch Start Date for EOR Contracts — 200 response body — data

Fetch Start Date for EOR Contracts — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
first_payroll_lockJSONRequired within parent
first_payroll_lock (anyOf 1)integerAlternativeDay of month when payroll gets locked
first_payroll_lock (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_same_month_payment_countrybooleanRequired within parentWhether the employment country requires start date within the same month
min_start_datestringRequired within parentThe earliest possible employment start date
Format: date-time
start_date_bufferJSONRequired within parent
start_date_buffer (anyOf 1)integerAlternativeNumber of business days to buffer from today
start_date_buffer (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get EOR Additional Costs — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get EOR Additional Costs — 200 response body — data

Referenced models: Get EOR Additional Costs — 200 response body — data

Get EOR Additional Costs — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
allowancesarrayOptional
allowances[]ModelEach itemExpand Get EOR Additional Costs — 200 response body — data allowances item
non_statutoryarrayOptional
non_statutory[]ModelEach itemExpand Get EOR Additional Costs — 200 response body — data non statutory item

Referenced models: Get EOR Additional Costs — 200 response body — data allowances item, Get EOR Additional Costs — 200 response body — data non statutory item

Get EOR Additional Costs — 200 response body — data allowances item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringOptionalAllowance description.
is_recurringbooleanOptionalIndicates if the allowance is recurring.
namestringOptionalAllowance name.
optionalbooleanOptionalIndicates if the allowance is optional.
rule_cost_idstringOptionalUnique identifier for the allowance.
skipping_confirmation_textJSONOptional
skipping_confirmation_text (anyOf 1)stringAlternativeConfirmation text for opting out of the allowance.
skipping_confirmation_text (anyOf 2)nullAlternativeConfirmation text for opting out of the allowance.
use_contract_currencybooleanOptionalIndicates if the allowance uses the contract currency.
valueJSONOptional
value (anyOf 1)numberAlternativeAllowance value.
Format: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get EOR Additional Costs — 200 response body — data non statutory item

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency
descriptionstringOptionalAllowance description.
is_recurringbooleanOptionalIndicates if the allowance is recurring.
namestringOptionalAllowance name.
rule_cost_idstringOptionalUnique identifier for the allowance.
use_contract_currencybooleanOptionalIndicates if the allowance uses the contract currency.
valueJSONOptional
value (anyOf 1)numberAlternativeAllowance value.
Format: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve Benefits by Country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item

Referenced models: Retrieve Benefits by Country — 200 response body — data item

Retrieve Benefits by Country — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
descriptionstringRequired within parentThe description of the benefit.
is_discriminatorybooleanRequired within parentIndicates if the benefit is discriminatory.
is_mandatorybooleanRequired within parentIndicates if the benefit is mandatory.
namestringRequired within parentThe name of the benefit.
providersarrayRequired within parent
providers[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item providers item

Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item

Retrieve Benefits by Country — 200 response body — data item providers item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayRequired within parent
attachments[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item providers item attachments item
client_infoJSONOptional
client_info (anyOf 1)stringAlternativeClient information.
client_info (anyOf 2)nullAlternativeClient information.
contribution_optionsarrayRequired within parent
contribution_options[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item providers item contribution options item
countrystringRequired within parentCountry code.
currencystringRequired within parentCurrency.
employee_infoJSONOptional
employee_info (anyOf 1)stringAlternativeEmployee information.
employee_info (anyOf 2)nullAlternativeEmployee information.
home_page_urlstringRequired within parentThe home page URL of the benefit provider.
idstringRequired within parentID of the benefit provider.
Format: uuid
is_unisurebooleanRequired within parentIndicates if Unisure.
max_contributionJSONOptional
max_contribution (anyOf 1)JSONAlternative
max_contribution (anyOf 1) (anyOf 1)numberAlternativeMaximum contribution.
Format: double
max_contribution (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_contribution (anyOf 2)nullAlternativeMaximum contribution.
Format: double
min_contributionJSONOptional
min_contribution (anyOf 1)JSONAlternative
min_contribution (anyOf 1) (anyOf 1)numberAlternativeMinimum contribution.
Format: double
min_contribution (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_contribution (anyOf 2)nullAlternativeMinimum contribution.
Format: double
namestringRequired within parentThe name of the benefit provider.
plansarrayRequired within parent
plans[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item providers item plans item
typestringRequired within parentBenefit type.

Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item attachments item, Retrieve Benefits by Country — 200 response body — data item providers item contribution options item, Retrieve Benefits by Country — 200 response body — data item providers item plans item

Retrieve Benefits by Country — 200 response body — data item providers item attachments item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentThe unique ID of the attachment.
labelstringRequired within parentThe label of the attachment.
urlstringRequired within parentThe url of the attachment.

Retrieve Benefits by Country — 200 response body — data item providers item contribution options item

FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeAmount.
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentUnique ID of the contribution.

Retrieve Benefits by Country — 200 response body — data item providers item plans item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentsarrayRequired within parent
attachments[]ModelEach itemExpand Retrieve Benefits by Country — 200 response body — data item providers item attachments item
idstringRequired within parentThe unique ID of the plan.
namestringRequired within parentThe name of the plan.
priceJSONRequired within parent
price (anyOf 1)numberAlternativeThe price of the plan.
Format: double
price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve Benefits by Country — 200 response body — data item providers item attachments item

Retrieve detailed hiring guide for a country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data

Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data

Retrieve detailed hiring guide for a country — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCountry currency.
health_insuranceJSONOptional
health_insurance (anyOf 1)ModelAlternativeExpand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED
health_insurance (anyOf 2)nullAlternative
holidayModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data holiday
probationModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data probation
salaryModelOptionalExpand Retrieve detailed hiring guide for a country — 200 response body — data salary

Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED, Retrieve detailed hiring guide for a country — 200 response body — data holiday, Retrieve detailed hiring guide for a country — 200 response body — data probation, Retrieve detailed hiring guide for a country — 200 response body — data salary

Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED

FieldTypePresenceDescription and constraints
$objectRoot
providersarrayOptional
providers[]ModelEach itemExpand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item
statusstringOptionalHealth insurance status.
Known values: REQUIRED, ENABLED, DISABLED

Referenced models: Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item

Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalProvider ID.
namestringOptionalProvider name.

Retrieve detailed hiring guide for a country — 200 response body — data holiday

FieldTypePresenceDescription and constraints
$objectRoot
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum holidays.
max (anyOf 2)nullAlternativeMaximum holidays.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum holidays.
min (anyOf 2)nullAlternativeMinimum holidays.
mostCommonJSONOptional
mostCommon (anyOf 1)stringAlternativeMost common holiday period.
mostCommon (anyOf 2)nullAlternativeMost common holiday period.

Retrieve detailed hiring guide for a country — 200 response body — data probation

FieldTypePresenceDescription and constraints
$objectRoot
maxJSONOptional
max (anyOf 1)JSONAlternative
max (anyOf 1) (anyOf 1)numberAlternativeMaximum probation period.
Format: double
max (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max (anyOf 2)nullAlternativeMaximum probation period.
Format: double
minJSONOptional
min (anyOf 1)JSONAlternative
min (anyOf 1) (anyOf 1)numberAlternativeMinimum probation period.
Format: double
min (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min (anyOf 2)nullAlternativeMinimum probation period.
Format: double

Retrieve detailed hiring guide for a country — 200 response body — data salary

FieldTypePresenceDescription and constraints
$objectRoot
frequencystringOptionalFrequency of the salary payment.
Known values: monthly, quarterly, annually, specific_month, specific_date
maxJSONOptional
max (anyOf 1)stringAlternativeMaximum salary.
max (anyOf 2)nullAlternativeMaximum salary.
max_usdJSONOptional
max_usd (anyOf 1)stringAlternativeMaximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available.
max_usd (anyOf 2)nullAlternativeMaximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available.
minJSONOptional
min (anyOf 1)stringAlternativeMinimum salary.
min (anyOf 2)nullAlternativeMinimum salary.
min_usdJSONOptional
min_usd (anyOf 1)stringAlternativeMinimum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available.
min_usd (anyOf 2)nullAlternativeMinimum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available.

Sign EOR contract document — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Sign EOR contract document — 200 response body — data

Referenced models: Sign EOR contract document — 200 response body — data

Sign EOR contract document — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
client_job_titleJSONOptional
client_job_title (anyOf 1)stringAlternativeThe job title of the client if the document is signed.
client_job_title (anyOf 2)nullAlternativeThe job title of the client if the document is signed.
document_typestringRequired within parentThe type of document. Currently only FRAMEWORK_AGREEMENT is supported.
Known values: FRAMEWORK_AGREEMENT
eor_signatureJSONOptional
eor_signature (anyOf 1)stringAlternativeThe signature of the EOR if the document is signed.
eor_signature (anyOf 2)nullAlternativeThe signature of the EOR if the document is signed.
eor_signed_atJSONOptional
eor_signed_at (anyOf 1)stringAlternativeThe date and time the EOR signed the document if it is signed.
Format: date-time
eor_signed_at (anyOf 2)nullAlternativeThe date and time the EOR signed the document if it is signed.
Format: date-time
signatureJSONOptional
signature (anyOf 1)stringAlternativeThe signature of the client if the document is signed.
signature (anyOf 2)nullAlternativeThe signature of the client if the document is signed.
signed_atJSONOptional
signed_at (anyOf 1)stringAlternativeThe date and time the client signed the document if it is signed.
Format: date-time
signed_at (anyOf 2)nullAlternativeThe date and time the client signed the document if it is signed.
Format: date-time

Sign EOR contract document — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
client_job_titlestringRequired within parentThe job title of the client signing the document.
signaturestringRequired within parentThe signature of the client signing the document.

Update Employee Information for EOR Contract — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Update Employee Information for EOR Contract — 200 response body — data

Referenced models: Update Employee Information for EOR Contract — 200 response body — data

Update Employee Information for EOR Contract — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
employee_first_namestringOptionalThe first name of the contract employee.
employee_last_namestringOptionalThe last name of the contract employee.
idstringRequired 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_contract, waiting_for_employee_sign, awaiting_deposit_payment, rejected

Update Employee Information for EOR Contract — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
employee_first_namestringOptionalThe first name of the employee.
employee_last_namestringOptionalThe last name of the employee.

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.