Deel: Forms schemas
14 Deel schemas with complete fields and constraints.
← Forms operations · All schemas
Fetch multiple EOR Contract forms — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of quote forms for the requested countries. |
data[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more results available beyond the current page. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | Cursor for fetching the next page of results. Null if no more results. |
next_cursor (anyOf 2) | null | Alternative | Cursor for fetching the next page of results. Null if no more results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of countries in the request. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item
Fetch multiple EOR Contract forms — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | Two-letter country code in ISO 3166-1 alpha-2 format Pattern: ^[A-Z]{2}$ |
pages | array | Required within parent | List of pages in the form. |
pages[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item pages item |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State or province code if applicable |
state (anyOf 2) | null | Alternative | State or province code if applicable |
Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item pages item
Fetch multiple EOR Contract forms — 200 response body — data item pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sections | array | Required within parent | Sections within the page. |
sections[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item |
title | string | Required within parent | Title of the form page. |
Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item
Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
questions | array | Required within parent | List of questions within the section. |
questions[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item 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 multiple EOR Contract forms — 200 response body — data item pages item sections item questions item
Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item questions 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. |
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 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 |
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 | |
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 |
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
Fetch multiple EOR Contract forms — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_duration_in_days | integer | Optional | The contract duration in days for definite contracts. Minimum: 1 |
countries | array | Required within parent | Array of countries for which to fetch quote forms. Maximum 10 countries per request. |
countries[] | Model | Each item | Expand Fetch multiple EOR Contract forms — request body — body data countries item |
start_date | string | Optional | The selected start date of the contract in ISO 8601 formatted date string. Format: date |
work_hours_per_week | integer | Optional | The selected number of work hours per week. Maximum: 168 Minimum: 1 |
Referenced models: Fetch multiple EOR Contract forms — request body — body data countries item
Fetch multiple EOR Contract forms — request body — body data countries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Required within parent | Two-letter country code in ISO 3166-1 alpha-2 format Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string | Optional | The selected state code of the contract. This is only required for countries that specify it. |
Get worker additional fields for (EOR) — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of field configuration objects |
data[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item
Get worker additional fields for (EOR) — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | array | Required within parent | Array of field dependencies that determine when this field should be displayed |
dependencies[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item |
is_required | boolean | Required within parent | Indicates if the field is required |
key | string | Required within parent | Unique identifier for the field |
required_by | string | Optional | Indicates when the field is required (e.g., sign_up, contract_signing) |
type | string | Required within parent | Data type of the field |
ui_guide | Model | Required within parent | Expand Get worker additional fields for (EOR) — 200 response body — data item ui guide UI guidelines for rendering the field |
validation | array | Required within parent | Array of validation rules to apply to the field input |
validation[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item validation item |
values_allowed | array | Optional | List of allowed values for select fields |
values_allowed[] | string | Each item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item validation item, Get worker additional fields for (EOR) — 200 response body — data item dependencies item, Get worker additional fields for (EOR) — 200 response body — data item ui guide
Get worker additional fields for (EOR) — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Unique identifier for the dependant field |
value | Model | Required within parent | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value Value expected from dependant in order to display field. Can be a plain value or an object with an operator. |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Value expected from dependant in order to display field. Can be a plain value or an object with an operator. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | Model | Alternative | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value |
$ (anyOf 3) | array | Alternative | |
$ (anyOf 3)[] | string | Each item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
op | string | Required within parent | Comparison operator (e.g., gt, gte, lt, lte, eq, neq) |
value | Model | Required within parent | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
Get worker additional fields for (EOR) — 200 response body — data item ui guide
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | UI guidelines for rendering the field |
description | string | Required within parent | Additional description for the field UI |
field_type | string | Required within parent | Type of the input field in the UI |
helper_text | string | Optional | Helper text to guide user input |
label | string | Required within parent | The primary label for the field |
local_label | string | Optional | Localized version of the field label |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | Display order of the field in the UI |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get worker additional fields for (EOR) — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Validation rules for the field |
error_message | string | Required within parent | Error message shown if the validation fails |
type | string | Required within parent | Type of the validation |
value | string | Optional | Value to be used in the validation according to the type |