Deel: EOR hiring schemas
57 Deel schemas with complete fields and constraints.
← EOR hiring operations · All schemas
Cancel EOR Contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cancellation_message | string | Optional | Message for contract termination |
cancellation_reason | string | Required within parent | Reason for contract termination One of: INTERNAL_DECISION, UNSATISFACTORY_EXPERIENCE, EXPLORING_ALTERNATIVE, OFFER_CHANGES |
Delay EOR employee onboarding — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contractOid | string | Optional | Contract OID |
is_employee_onboarding_delayed | boolean | Optional | Current onboarding delay status |
success | boolean | Required within parent | Operation success status |
Delay EOR employee onboarding — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_employee_onboarding_delayed | boolean | Required within parent | Indicates if the employee onboarding is delayed |
Fetch EOR Contract form — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pages | array | Required within parent | List of pages in the form. |
pages[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.probation_period` question. |
probation_type_for_definite | Model | Required within parent | Expand 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_rules | JSON | Optional | Calculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types. |
specific_calculation_rules (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
specific_to_duration_of_contract_rules | JSON | Optional | |
specific_to_duration_of_contract_rules (anyOf 1) | array | Alternative | Rules 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)[] | Model | Each item | Expand 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) | null | Alternative | Rules 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)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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). 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Calculation rules when probation_type_for_definite is SPECIFIC_CALCULATION. Null for other types. |
max_probation_for_definite | JSON | Optional | |
max_probation_for_definite (anyOf 1) | number | Alternative | Maximum probation duration (in the unit specified by time_unit). Format: double |
max_probation_for_definite (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_probation_type_for_definite | string | Optional | The formula used to derive the maximum probation period for a definite contract. |
min_probation_for_definite | JSON | Optional | |
min_probation_for_definite (anyOf 1) | number | Alternative | Minimum probation duration (in the unit specified by time_unit). Format: double |
min_probation_for_definite (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
time_unit | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_duration_type | string | Optional | Time unit for the employment duration bounds (DAY, WEEK, MONTH, or YEAR). Known values: DAY, WEEK, MONTH, YEAR |
max_employment_duration | JSON | Optional | |
max_employment_duration (anyOf 1) | JSON | Alternative | |
max_employment_duration (anyOf 1) (anyOf 1) | number | Alternative | Upper bound of the contract duration range. Null when unbounded. Format: double |
max_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_employment_duration (anyOf 2) | null | Alternative | Upper bound of the contract duration range. Null when unbounded. Format: double |
min_employment_duration | JSON | Optional | |
min_employment_duration (anyOf 1) | number | Alternative | Lower bound of the contract duration range. Format: double |
min_employment_duration (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_probation_period | JSON | Optional | |
min_probation_period (anyOf 1) | number | Alternative | Minimum probation duration for contracts in this range. Format: double |
min_probation_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
probation_period | JSON | Optional | |
probation_period (anyOf 1) | number | Alternative | Probation duration for contracts in this range. Format: double |
probation_period (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
time_unit | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Whether the entire page is disabled for the selected country. |
is_disabled (anyOf 2) | null | Alternative | Whether the entire page is disabled for the selected country. |
sections | array | Required within parent | Sections within the page. |
sections[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Whether the entire section is disabled. |
is_disabled (anyOf 2) | null | Alternative | Whether the entire section is disabled. |
questions | array | Required within parent | List of questions within the section. |
questions[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item |
subtitle | string | Optional | Additional information shown at the top of the section. |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_info | JSON | Optional | Country-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) | Model | Alternative | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value |
additional_info (anyOf 2) | null | Alternative | |
date_limitation | JSON | Optional | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now. |
date_limitation (anyOf 1) | string | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now. Known values: BLOCK_PAST, BLOCK_FUTURE |
date_limitation (anyOf 2) | null | Alternative | |
default_value | Model | Optional | Expand 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_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Additional information to assist the user. |
helper_text (anyOf 2) | null | Alternative | Additional information to assist the user. |
is_disabled | boolean | Optional | If true, the field is disabled and cannot be edited. |
is_multiple_selection | boolean | Optional | Indicates if the user can select multiple values. |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions. |
is_range | boolean | Optional | Specifies whether a date picker allows range selection. |
is_required | boolean | Optional | Indicates if the question is required. |
key | string | Required within parent | Unique key identifier for the question. |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum character length for text responses. |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum character length for text responses. |
max_value | Model | Optional | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value Maximum value allowed. |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum character length for text responses. |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum character length for text responses. |
min_value | Model | Optional | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value Minimum value allowed. |
must_request_validation | boolean | Optional | Whether additional validation should be triggered for this field. |
number_type | string | Optional | Used for number fields to define the unit or representation. |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 1)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 2)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item |
questions | JSON | Optional | |
questions (anyOf 1) | array | Alternative | For Nested questions: the child questions within this group. |
questions (anyOf 1)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item |
questions (anyOf 2) | null | Alternative | For Nested questions: the child questions within this group. |
questions (anyOf 2)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item |
rules | JSON | Optional | |
rules (anyOf 1) | array | Alternative | Validation rules for the question. |
rules (anyOf 1)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item |
rules (anyOf 2) | null | Alternative | Validation rules for the question. |
rules (anyOf 2)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item |
source | JSON | Optional | Defines dynamic data source for the question. |
source (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
time_unit | JSON | Optional | |
time_unit (anyOf 1) | string | Alternative | Time unit associated with numeric duration questions. |
time_unit (anyOf 2) | null | Alternative | Time unit associated with numeric duration questions. |
title | string | Required within parent | Title of the question. |
type | string | Required within parent | Type of the question. Known values: FreeText, Paragraph, SingleSelection, MultiSelection, Address, PhoneNumber, DocumentUpload, Number, Dropdown, DatePicker, Email, CustomDropdown, PresetDropdown, Nested |
variant_id | JSON | Optional | |
variant_id (anyOf 1) | string | Alternative | Variant identifier used to distinguish different renderings of the same key. |
variant_id (anyOf 2) | null | Alternative | Variant 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `compensation_details.salary` question. |
additional_payments | array | Required within parent | Country-mandated irregular payments (e.g. 13th salary, profit sharing) that are included in the total employment cost. |
additional_payments[] | Model | Each item | Expand 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_salary | JSON | Required within parent | |
max_salary (anyOf 1) | JSON | Alternative | |
max_salary (anyOf 1) (anyOf 1) | number | Alternative | Maximum 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_salary (anyOf 2) | null | Alternative | Maximum allowable gross annual salary for this country. Null when no maximum salary is configured for the country. Format: double |
min_salary | JSON | Required within parent | |
min_salary (anyOf 1) | JSON | Alternative | |
min_salary (anyOf 1) (anyOf 1) | number | Alternative | Minimum 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_salary (anyOf 2) | null | Alternative | Minimum allowable gross annual salary for this country. Null when no minimum salary is configured for the country. Format: double |
part_time_holiday_type | string | Optional | How holiday pay is calculated for part-time employees (e.g. PRORATED, STANDARD). |
standard_hours_per_week | JSON | Optional | |
standard_hours_per_week (anyOf 1) | number | Alternative | Standard working hours per week used as the full-time reference. Format: double |
standard_hours_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Optional | |
amount (anyOf 1) | JSON | Alternative | |
amount (anyOf 1) (anyOf 1) | number | Alternative | Fixed amount of the payment (0 when it is percentage-based). Format: double |
amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount (anyOf 2) | null | Alternative | Fixed amount of the payment (0 when it is percentage-based). Format: double |
how_its_calculated | JSON | Optional | |
how_its_calculated (anyOf 1) | string | Alternative | Human-readable explanation of the calculation method. |
how_its_calculated (anyOf 2) | null | Alternative | Human-readable explanation of the calculation method. |
invoicing_months | JSON | Optional | |
invoicing_months (anyOf 1) | array | Alternative | Months in which the payment is invoiced. |
invoicing_months (anyOf 1)[] | string | Each item | |
invoicing_months (anyOf 2) | null | Alternative | Months in which the payment is invoiced. |
invoicing_months (anyOf 2)[] | string | Each item | |
invoicing_type | JSON | Optional | |
invoicing_type (anyOf 1) | string | Alternative | How the payment is invoiced (e.g. Single Month, Multiple Months). |
invoicing_type (anyOf 2) | null | Alternative | How the payment is invoiced (e.g. Single Month, Multiple Months). |
payment_local_name | JSON | Optional | |
payment_local_name (anyOf 1) | string | Alternative | Local-language name of the additional payment. |
payment_local_name (anyOf 2) | null | Alternative | Local-language name of the additional payment. |
payment_name | string | Optional | Display 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.start_date` question. |
is_same_month_payment_country | boolean | Required within parent | Whether this country processes payroll in the same month as the employment start date (true) or the following month (false). |
min_value_buffer_in_days | JSON | Required within parent | |
min_value_buffer_in_days (anyOf 1) | JSON | Alternative | |
min_value_buffer_in_days (anyOf 1) (anyOf 1) | integer | Alternative | Minimum 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value_buffer_in_days (anyOf 2) | null | Alternative | Minimum 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_lock | JSON | Required within parent | |
payroll_lock (anyOf 1) | integer | Alternative | Day of the month after which the start date can no longer be set in the current month (payroll lock day). |
payroll_lock (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.holidays` question. |
max_holidays | JSON | Optional | |
max_holidays (anyOf 1) | JSON | Alternative | |
max_holidays (anyOf 1) (anyOf 1) | number | Alternative | Maximum paid vacation days allowed. Null when there is no upper limit. Format: double |
max_holidays (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_holidays (anyOf 2) | null | Alternative | Maximum paid vacation days allowed. Null when there is no upper limit. Format: double |
min_holidays | JSON | Required within parent | |
min_holidays (anyOf 1) | number | Alternative | Minimum statutory paid vacation days for this country. Format: double |
min_holidays (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
part_time_holiday_type | string | Optional | How holiday entitlement is calculated for part-time employees (e.g. PRORATED, STANDARD). |
standard_hours_per_week | JSON | Required within parent | |
standard_hours_per_week (anyOf 1) | number | Alternative | Standard working hours per week used as the full-time reference. Format: double |
standard_hours_per_week (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.end_date` question. |
maximum_limitation_in_months | JSON | Optional | |
maximum_limitation_in_months (anyOf 1) | JSON | Alternative | |
maximum_limitation_in_months (anyOf 1) (anyOf 1) | integer | Alternative | Maximum fixed-term contract duration in months. Null when there is no maximum limitation. |
maximum_limitation_in_months (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maximum_limitation_in_months (anyOf 2) | null | Alternative | Maximum fixed-term contract duration in months. Null when there is no maximum limitation. |
min_value_buffer_in_days | JSON | Optional | |
min_value_buffer_in_days (anyOf 1) | JSON | Alternative | |
min_value_buffer_in_days (anyOf 1) (anyOf 1) | integer | Alternative | Minimum 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value_buffer_in_days (anyOf 2) | null | Alternative | Minimum 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. |
type | Model | Required within parent | Expand 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). |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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). 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.notice_period_type` question. |
notice_period_rule_type | string | Required within parent | Notice-period rule type for the country (e.g. LIMITED_AGREEMENT, FIXED_AGREEMENT). |
notice_period_settings | array | Required within parent | Notice-period configuration, one entry per employment type and term combination. |
notice_period_settings[] | Model | Each item | Expand 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_unit | string | Required within parent | Primary display time unit for the notice period (DAY, WEEK, or 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_term | string | Optional | Employment term this rule applies to. Known values: DEFINITE, INDEFINITE |
employment_type | string | Optional | Employment type this rule applies to. Known values: FULL_TIME, PART_TIME |
notice_period_after_probation | Model | Optional | Expand 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_probation | Model | Optional | Expand 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_rules | array | Optional | Tenure-based notice period rules, used when the notice type is TENURE_BASED. |
tenure_rules[] | Model | Each item | Expand 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_probation | string | Optional | How the notice period is determined after probation (e.g. NO_NOTICE_PERIOD, MIN_MAX_LIMITED, SPECIFIC, TENURE_BASED). |
type_for_during_probation | string | Optional | How 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Notice period minimum/maximum bounds and default for this segment. |
default_value | JSON | Optional | |
default_value (anyOf 1) | JSON | Alternative | |
default_value (anyOf 1) (anyOf 1) | integer | Alternative | Default notice period value. Null when there is no default. |
default_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
default_value (anyOf 2) | null | Alternative | Default notice period value. Null when there is no default. |
max_value | JSON | Optional | |
max_value (anyOf 1) | JSON | Alternative | |
max_value (anyOf 1) (anyOf 1) | integer | Alternative | Maximum notice period value. Null when not applicable. |
max_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_value (anyOf 2) | null | Alternative | Maximum notice period value. Null when not applicable. |
min_value | JSON | Optional | |
min_value (anyOf 1) | JSON | Alternative | |
min_value (anyOf 1) (anyOf 1) | integer | Alternative | Minimum notice period value. Null when not applicable. |
min_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value (anyOf 2) | null | Alternative | Minimum notice period value. Null when not applicable. |
time_unit | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employment_duration_type | string | Optional | Time unit for the employment-duration bounds. Known values: DAY, WEEK, MONTH, YEAR |
max_employment_duration | JSON | Optional | |
max_employment_duration (anyOf 1) | JSON | Alternative | |
max_employment_duration (anyOf 1) (anyOf 1) | integer | Alternative | Upper bound of the employment-duration range. Null when unbounded. |
max_employment_duration (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_employment_duration (anyOf 2) | null | Alternative | Upper bound of the employment-duration range. Null when unbounded. |
min_employment_duration | JSON | Optional | |
min_employment_duration (anyOf 1) | integer | Alternative | Lower bound of the employment-duration range. |
min_employment_duration (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
notice_value | JSON | Optional | |
notice_value (anyOf 1) | integer | Alternative | Notice period value for contracts in this tenure range. |
notice_value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
time_unit | string | Optional | Time 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Maximum value allowed. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Minimum value allowed. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Whether this specific option is disabled for the selected country. |
is_disabled (anyOf 2) | null | Alternative | Whether this specific option is disabled for the selected country. |
rules | JSON | Optional | |
rules (anyOf 1) | array | Alternative | Conditional rules that apply when this option is selected. |
rules (anyOf 1)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item |
rules (anyOf 2) | null | Alternative | Conditional rules that apply when this option is selected. |
rules (anyOf 2)[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item options null item rules null item |
title | string | Optional | Display text for the option. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value associated with the option. |
value (anyOf 2) | null | Alternative | Value 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
date_limitation | JSON | Optional | |
date_limitation (anyOf 1) | string | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now. |
date_limitation (anyOf 2) | null | Alternative | Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now. |
default_value | Model | Optional | Expand 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_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Additional information to assist the user. |
helper_text (anyOf 2) | null | Alternative | Additional information to assist the user. |
is_disabled | boolean | Optional | If true, the field is disabled and cannot be edited. |
is_multiple_selection | boolean | Optional | Indicates if the user can select multiple values. |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions. |
is_range | boolean | Optional | Specifies whether a date picker allows range selection. |
is_required | boolean | Optional | Indicates if the question is required. |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum character length for text responses. |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum character length for text responses. |
max_value | Model | Optional | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value Maximum value allowed. |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum character length for text responses. |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum character length for text responses. |
min_value | Model | Optional | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value Minimum value allowed. |
must_request_validation | boolean | Optional | Whether additional validation should be triggered for this field. |
number_type | string | Optional | Used for number fields to define the unit or representation. |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 1)[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions. Value may be of any type. |
options (anyOf 2)[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item |
requires | array | Optional | List of conditions that must be met for this rule to apply. |
requires[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item |
source | JSON | Optional | Defines dynamic data source for the question. |
source (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
title | string | Optional | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compare_key | JSON | Optional | |
compare_key (anyOf 1) | string | Alternative | Key of the field to compare against. |
compare_key (anyOf 2) | null | Alternative | Key of the field to compare against. |
key | string | Optional | Key of the dependent field. |
operator | JSON | Optional | |
operator (anyOf 1) | string | Alternative | Comparison operator (e.g., 'eq', 'ne'). |
operator (anyOf 2) | null | Alternative | Comparison operator (e.g., 'eq', 'ne'). |
value | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Expected value for the condition. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines dynamic data source for the question. |
definition | string | Optional | Reference URL for API documentation. |
description | string | Optional | Description of the data source. |
url | string | Optional | API endpoint providing dynamic options. |
Fetch Start Date for EOR Contracts — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_payroll_lock | JSON | Required within parent | |
first_payroll_lock (anyOf 1) | integer | Alternative | Day of month when payroll gets locked |
first_payroll_lock (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_same_month_payment_country | boolean | Required within parent | Whether the employment country requires start date within the same month |
min_start_date | string | Required within parent | The earliest possible employment start date Format: date-time |
start_date_buffer | JSON | Required within parent | |
start_date_buffer (anyOf 1) | integer | Alternative | Number of business days to buffer from today |
start_date_buffer (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get EOR Additional Costs — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowances | array | Optional | |
allowances[] | Model | Each item | Expand Get EOR Additional Costs — 200 response body — data allowances item |
non_statutory | array | Optional | |
non_statutory[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Optional | Allowance description. |
is_recurring | boolean | Optional | Indicates if the allowance is recurring. |
name | string | Optional | Allowance name. |
optional | boolean | Optional | Indicates if the allowance is optional. |
rule_cost_id | string | Optional | Unique identifier for the allowance. |
skipping_confirmation_text | JSON | Optional | |
skipping_confirmation_text (anyOf 1) | string | Alternative | Confirmation text for opting out of the allowance. |
skipping_confirmation_text (anyOf 2) | null | Alternative | Confirmation text for opting out of the allowance. |
use_contract_currency | boolean | Optional | Indicates if the allowance uses the contract currency. |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Allowance value. Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get EOR Additional Costs — 200 response body — data non statutory item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency |
description | string | Optional | Allowance description. |
is_recurring | boolean | Optional | Indicates if the allowance is recurring. |
name | string | Optional | Allowance name. |
rule_cost_id | string | Optional | Unique identifier for the allowance. |
use_contract_currency | boolean | Optional | Indicates if the allowance uses the contract currency. |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Allowance value. Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve Benefits by Country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
description | string | Required within parent | The description of the benefit. |
is_discriminatory | boolean | Required within parent | Indicates if the benefit is discriminatory. |
is_mandatory | boolean | Required within parent | Indicates if the benefit is mandatory. |
name | string | Required within parent | The name of the benefit. |
providers | array | Required within parent | |
providers[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item attachments item |
client_info | JSON | Optional | |
client_info (anyOf 1) | string | Alternative | Client information. |
client_info (anyOf 2) | null | Alternative | Client information. |
contribution_options | array | Required within parent | |
contribution_options[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item contribution options item |
country | string | Required within parent | Country code. |
currency | string | Required within parent | Currency. |
employee_info | JSON | Optional | |
employee_info (anyOf 1) | string | Alternative | Employee information. |
employee_info (anyOf 2) | null | Alternative | Employee information. |
home_page_url | string | Required within parent | The home page URL of the benefit provider. |
id | string | Required within parent | ID of the benefit provider. Format: uuid |
is_unisure | boolean | Required within parent | Indicates if Unisure. |
max_contribution | JSON | Optional | |
max_contribution (anyOf 1) | JSON | Alternative | |
max_contribution (anyOf 1) (anyOf 1) | number | Alternative | Maximum contribution. Format: double |
max_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_contribution (anyOf 2) | null | Alternative | Maximum contribution. Format: double |
min_contribution | JSON | Optional | |
min_contribution (anyOf 1) | JSON | Alternative | |
min_contribution (anyOf 1) (anyOf 1) | number | Alternative | Minimum contribution. Format: double |
min_contribution (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_contribution (anyOf 2) | null | Alternative | Minimum contribution. Format: double |
name | string | Required within parent | The name of the benefit provider. |
plans | array | Required within parent | |
plans[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item plans item |
type | string | Required within parent | Benefit 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | The unique ID of the attachment. |
label | string | Required within parent | The label of the attachment. |
url | string | Required within parent | The url of the attachment. |
Retrieve Benefits by Country — 200 response body — data item providers item contribution options item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Amount. Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id | string | Required within parent | Unique ID of the contribution. |
Retrieve Benefits by Country — 200 response body — data item providers item plans item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | |
attachments[] | Model | Each item | Expand Retrieve Benefits by Country — 200 response body — data item providers item attachments item |
id | string | Required within parent | The unique ID of the plan. |
name | string | Required within parent | The name of the plan. |
price | JSON | Required within parent | |
price (anyOf 1) | number | Alternative | The price of the plan. Format: double |
price (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Country currency. |
health_insurance | JSON | Optional | |
health_insurance (anyOf 1) | Model | Alternative | Expand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED |
health_insurance (anyOf 2) | null | Alternative | |
holiday | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data holiday |
probation | Model | Optional | Expand Retrieve detailed hiring guide for a country — 200 response body — data probation |
salary | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
providers | array | Optional | |
providers[] | Model | Each item | Expand Retrieve detailed hiring guide for a country — 200 response body — data / health_insurance / status: REQUIRED, ENABLED, DISABLED providers item |
status | string | Optional | Health 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Provider ID. |
name | string | Optional | Provider name. |
Retrieve detailed hiring guide for a country — 200 response body — data holiday
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum holidays. |
max (anyOf 2) | null | Alternative | Maximum holidays. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum holidays. |
min (anyOf 2) | null | Alternative | Minimum holidays. |
mostCommon | JSON | Optional | |
mostCommon (anyOf 1) | string | Alternative | Most common holiday period. |
mostCommon (anyOf 2) | null | Alternative | Most common holiday period. |
Retrieve detailed hiring guide for a country — 200 response body — data probation
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
max | JSON | Optional | |
max (anyOf 1) | JSON | Alternative | |
max (anyOf 1) (anyOf 1) | number | Alternative | Maximum probation period. Format: double |
max (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max (anyOf 2) | null | Alternative | Maximum probation period. Format: double |
min | JSON | Optional | |
min (anyOf 1) | JSON | Alternative | |
min (anyOf 1) (anyOf 1) | number | Alternative | Minimum probation period. Format: double |
min (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min (anyOf 2) | null | Alternative | Minimum probation period. Format: double |
Retrieve detailed hiring guide for a country — 200 response body — data salary
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
frequency | string | Optional | Frequency of the salary payment. Known values: monthly, quarterly, annually, specific_month, specific_date |
max | JSON | Optional | |
max (anyOf 1) | string | Alternative | Maximum salary. |
max (anyOf 2) | null | Alternative | Maximum salary. |
max_usd | JSON | Optional | |
max_usd (anyOf 1) | string | Alternative | Maximum 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) | null | Alternative | Maximum salary in USD at the mid-market exchange rate. Only returned when include_usd_values is true and an exchange rate is available. |
min | JSON | Optional | |
min (anyOf 1) | string | Alternative | Minimum salary. |
min (anyOf 2) | null | Alternative | Minimum salary. |
min_usd | JSON | Optional | |
min_usd (anyOf 1) | string | Alternative | Minimum 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) | null | Alternative | Minimum 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_job_title | JSON | Optional | |
client_job_title (anyOf 1) | string | Alternative | The job title of the client if the document is signed. |
client_job_title (anyOf 2) | null | Alternative | The job title of the client if the document is signed. |
document_type | string | Required within parent | The type of document. Currently only FRAMEWORK_AGREEMENT is supported. Known values: FRAMEWORK_AGREEMENT |
eor_signature | JSON | Optional | |
eor_signature (anyOf 1) | string | Alternative | The signature of the EOR if the document is signed. |
eor_signature (anyOf 2) | null | Alternative | The signature of the EOR if the document is signed. |
eor_signed_at | JSON | Optional | |
eor_signed_at (anyOf 1) | string | Alternative | The date and time the EOR signed the document if it is signed. Format: date-time |
eor_signed_at (anyOf 2) | null | Alternative | The date and time the EOR signed the document if it is signed. Format: date-time |
signature | JSON | Optional | |
signature (anyOf 1) | string | Alternative | The signature of the client if the document is signed. |
signature (anyOf 2) | null | Alternative | The signature of the client if the document is signed. |
signed_at | JSON | Optional | |
signed_at (anyOf 1) | string | Alternative | The date and time the client signed the document if it is signed. Format: date-time |
signed_at (anyOf 2) | null | Alternative | The date and time the client signed the document if it is signed. Format: date-time |
Sign EOR contract document — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
client_job_title | string | Required within parent | The job title of the client signing the document. |
signature | string | Required within parent | The signature of the client signing the document. |
Update Employee Information for EOR Contract — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_first_name | string | Optional | The first name of the contract employee. |
employee_last_name | string | Optional | The last name of the contract employee. |
id | 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_contract, waiting_for_employee_sign, awaiting_deposit_payment, rejected |
Update Employee Information for EOR Contract — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
employee_first_name | string | Optional | The first name of the employee. |
employee_last_name | string | Optional | The last name of the employee. |