Deel: EOR project assignment schemas
8 Deel schemas with complete fields and constraints.
← EOR project assignment operations · All schemas
Accept EOR project assignment as client — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
version | string | Optional | This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned. Maximum length: 20 Minimum length: 20 |
Fetch Project Assignment Checkin Questionnaire Data — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | Timestamp indicating when the resource was created (ISO 8601). Format: date-time |
id | string | Required within parent | Unique identifier of the resource Format: uuid |
sections | array | Required within parent | Sections of questions |
sections[] | Model | Each item | Expand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item |
updated_at | string | Required within parent | Timestamp indicating when the resource was last updated (ISO 8601). Format: date-time |
Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data 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 Project Assignment Checkin Questionnaire Data — 200 response body — data 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 Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions. |
is_required | boolean | Optional | Indicates if the question is required. |
key | string | Required within parent | Unique key identifier for the question. |
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 |
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 |
Referenced models: 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 Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Default value to pre-fill in the form. |
$ (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 Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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. |
Submit Project Assignment Checkin Questionnaire Data — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Form submission payload containing respondent type, question answers, and optional version. |
questions_with_answers | object | Required within parent | Map of question IDs to their corresponding answers. Additional keys: see wildcard field |
questions_with_answers.* | string | Additional keys | Minimum length: 1 |
type | string | Required within parent | Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'. One of: EMPLOYEE, CLIENT |
version | string | Optional | Optional version identifier of the form or schema. Maximum length: 20 |