Deel: EOR schemas
16 Deel schemas with complete fields and constraints.
← EOR operations · All schemas
Get additional information — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get additional information — 200 response body — data Only fields with a saved value are included. Keys not listed above are country/state-specific additional information fields, keyed the same way as the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys). |
Referenced models: Get additional information — 200 response body — data
Get additional information — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Only fields with a saved value are included. Keys not listed above are country/state-specific additional information fields, keyed the same way as the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys). |
city | string | Optional | City |
dob | string | Optional | Date of birth (ISO 8601 date) |
is_compliance_access_allowed | boolean | Optional | Worker access to compliance documents |
is_payslip_access_allowed | boolean | Optional | Worker access to payslips |
phone | string | Optional | Worker phone |
state | string | Optional | State/province |
street | string | Optional | Street |
tax_residence | string | Optional | Worker tax residence |
zip_code | string | Optional | Zipcode/Post code |
Get amendment data points configuration by country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get amendment data points configuration by country — 200 response body — data |
has_more | boolean | Required within parent | Whether more pages are available |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Opaque cursor to pass as the cursor query param to fetch the next page. null when on the last page. |
next_cursor (anyOf 2) | null | Alternative | Opaque cursor to pass as the cursor query param to fetch the next page. null when on the last page. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of countries with amendment settings in the database |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Get amendment data points configuration by country — 200 response body — data
Get amendment data points configuration by country — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
settings | array | Required within parent | List of countries with their amendment data points configuration |
settings[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item
Get amendment data points configuration by country — 200 response body — data settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | ISO 3166-1 alpha-2 country code |
created_at | JSON | Required within parent | |
created_at (anyOf 1) | string | Alternative | Timestamp when the country settings row was created. null when no DB row exists. Format: date-time |
created_at (anyOf 2) | null | Alternative | Timestamp when the country settings row was created. null when no DB row exists. Format: date-time |
data_points | array | Required within parent | Amendment data points configured for this country |
data_points[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item |
id | JSON | Required within parent | |
id (anyOf 1) | string | Alternative | Database record ID for this country's settings. null when no settings row exists and defaults are returned. Format: uuid |
id (anyOf 2) | null | Alternative | Database record ID for this country's settings. null when no settings row exists and defaults are returned. Format: uuid |
updated_at | JSON | Required within parent | |
updated_at (anyOf 1) | string | Alternative | Timestamp when the country settings row was last updated. null when no DB row exists. Format: date-time |
updated_at (anyOf 2) | null | Alternative | Timestamp when the country settings row was last updated. null when no DB row exists. Format: date-time |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item data points item
Get amendment data points configuration by country — 200 response body — data settings item data points item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_enabled | boolean | Required within parent | Whether at least one amendment item within this data point is enabled |
item | Model | Required within parent | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item item Data point identifier |
metadata | Model | Optional | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item metadata Additional configuration for the data point. Present only for CUSTOM. |
types | array | Required within parent | Processing type configuration per amendment item within this data point |
types[] | Model | Each item | Expand Get amendment data points configuration by country — 200 response body — data settings item data points item types item |
Referenced models: Get amendment data points configuration by country — 200 response body — data settings item data points item item, Get amendment data points configuration by country — 200 response body — data settings item data points item metadata, Get amendment data points configuration by country — 200 response body — data settings item data points item types item
Get amendment data points configuration by country — 200 response body — data settings item data points item item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Data point identifier Known values: SALARY, START_DATE, END_DATE, HOLIDAYS, SCOPE, JOB_TITLE, VARIABLE_COMPENSATIONS, CUSTOM, CURRENCY, TIME_OFF_TYPE, FIXED_ALLOWANCES, PROBATION_PERIOD, SENIORITY_ID, WORK_HOURS_PER_WEEK, EMPLOYMENT_STATE, EMPLOYMENT_TYPE, EMPLOYEE_NATIONALITY, NOTICE_PERIOD_DURING_PROBATION, NOTICE_PERIOD_AFTER_PROBATION, NOTICE_PERIOD_TYPE, WORK_SCHEDULE, HOURLY_RATE, SENIORITY_DATE, JOB_CATEGORY, JOB_CODE |
Get amendment data points configuration by country — 200 response body — data settings item data points item metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional configuration for the data point. Present only for CUSTOM. |
possible_options | array | Optional | Allowed subject values for a custom amendment item |
possible_options[] | string | Each item | Known values: START_DATE, END_DATE, BENEFITS, PROBATION_PERIOD, VARIABLE_COMPENSATIONS, INCENTIVE_PLAN, SALARY, FIXED_ALLOWANCES, JOB_TITLE, SENIORITY_ID, SENIORITY_DATE, JOB_CODE, JOB_CATEGORY, JOB_SCOPE, EMPLOYMENT_TYPE, PERSONAL_DATA, OTHER |
Get amendment data points configuration by country — 200 response body — data settings item data points item types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amendment_item | string | Required within parent | Amendment item identifier |
type | string | Required within parent | Processing type. AUTOMATED means no explicit configuration — processed automatically. Known values: AUTOMATED, INSTANT, LEGAL, NO_AUTOMATION, DISABLED_AMENDMENTS |
Get employee agreement draft preview — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get employee agreement draft preview — 200 response body — data |
Referenced models: Get employee agreement draft preview — 200 response body — data
Get employee agreement draft preview — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_processing | boolean | Optional | True while generation is in progress; false when the url is ready. |
task_id | string | Optional | Async task ID. Use this in subsequent requests to poll. |
url | string | Optional | Signed URL to download the draft PDF. Valid for 15 minutes. Present only when is_processing is false. |
Modify bank account for an EOR employee — eor modify Bank Account For An Eor Employee — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Modify bank account for an EOR employee — eor modify Bank Account For An Eor Employee — 201 response body — data |
Referenced models: Modify bank account for an EOR employee — eor modify Bank Account For An Eor Employee — 201 response body — data
Modify bank account for an EOR employee — eor modify Bank Account For An Eor Employee — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Date and time when bank account was created Format: date-time |
id | string | Optional | The unique identifier of the bank account. |
status | string | Optional | Bank Account status Known values: NEW, PENDING, APPROVED, FAILED |
updated_at | string | Optional | Date and time when bank account was last updated Format: date-time |
Reject an EOR quote — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Reject an EOR quote — 200 response body — data |
Referenced models: Reject an EOR quote — 200 response body — data
Reject an EOR quote — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The unique identifier of the EOR contract whose quote was rejected. |
id (anyOf 2) | null | Alternative | The unique identifier of the EOR contract whose quote was rejected. |
rejection_reason | JSON | Optional | |
rejection_reason (anyOf 1) | string | Alternative | The reason recorded for the latest quote rejection. |
rejection_reason (anyOf 2) | null | Alternative | The reason recorded for the latest quote rejection. |
status | JSON | Optional | |
status (anyOf 1) | string | Alternative | The status of the contract after the rejection. |
status (anyOf 2) | null | Alternative | The status of the contract after the rejection. |
Reject an EOR quote — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Optional | Optional free-text explanation accompanying the rejection. Maximum length: 2000 |
reason | string | Required within parent | The reason for rejecting the quote. One of: TOO_EXPENSIVE, DECIDED_AGAINST_EMPLOYING_EOR, TEST_QUOTE, NOT_SATISFIED_WITH_DEEL, INACCURATE_INFO_JOB_TITLE, INACCURATE_INFO_JOB_DESCRIPTION, INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK, COMPLIANCE_RESTRICTIONS, OTHER |