Skip to content

Deel: EOR schemas

16 Deel schemas with complete fields and constraints.

← EOR operations · All schemas

Get additional information — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRootOnly 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).
citystringOptionalCity
dobstringOptionalDate of birth (ISO 8601 date)
is_compliance_access_allowedbooleanOptionalWorker access to compliance documents
is_payslip_access_allowedbooleanOptionalWorker access to payslips
phonestringOptionalWorker phone
statestringOptionalState/province
streetstringOptionalStreet
tax_residencestringOptionalWorker tax residence
zip_codestringOptionalZipcode/Post code

Get amendment data points configuration by country — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get amendment data points configuration by country — 200 response body — data
has_morebooleanRequired within parentWhether more pages are available
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeOpaque cursor to pass as the cursor query param to fetch the next page. null when on the last page.
next_cursor (anyOf 2)nullAlternativeOpaque cursor to pass as the cursor query param to fetch the next page. null when on the last page.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of countries with amendment settings in the database
total_count (anyOf 2)stringAlternativePattern: ^-?[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

FieldTypePresenceDescription and constraints
$objectRoot
settingsarrayRequired within parentList of countries with their amendment data points configuration
settings[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentISO 3166-1 alpha-2 country code
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeTimestamp when the country settings row was created. null when no DB row exists.
Format: date-time
created_at (anyOf 2)nullAlternativeTimestamp when the country settings row was created. null when no DB row exists.
Format: date-time
data_pointsarrayRequired within parentAmendment data points configured for this country
data_points[]ModelEach itemExpand Get amendment data points configuration by country — 200 response body — data settings item data points item
idJSONRequired within parent
id (anyOf 1)stringAlternativeDatabase record ID for this country's settings. null when no settings row exists and defaults are returned.
Format: uuid
id (anyOf 2)nullAlternativeDatabase record ID for this country's settings. null when no settings row exists and defaults are returned.
Format: uuid
updated_atJSONRequired within parent
updated_at (anyOf 1)stringAlternativeTimestamp when the country settings row was last updated. null when no DB row exists.
Format: date-time
updated_at (anyOf 2)nullAlternativeTimestamp 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

FieldTypePresenceDescription and constraints
$objectRoot
is_enabledbooleanRequired within parentWhether at least one amendment item within this data point is enabled
itemModelRequired within parentExpand Get amendment data points configuration by country — 200 response body — data settings item data points item item
Data point identifier
metadataModelOptionalExpand 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.
typesarrayRequired within parentProcessing type configuration per amendment item within this data point
types[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$stringRootData 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

FieldTypePresenceDescription and constraints
$objectRootAdditional configuration for the data point. Present only for CUSTOM.
possible_optionsarrayOptionalAllowed subject values for a custom amendment item
possible_options[]stringEach itemKnown 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

FieldTypePresenceDescription and constraints
$objectRoot
amendment_itemstringRequired within parentAmendment item identifier
typestringRequired within parentProcessing 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
is_processingbooleanOptionalTrue while generation is in progress; false when the url is ready.
task_idstringOptionalAsync task ID. Use this in subsequent requests to poll.
urlstringOptionalSigned 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalDate and time when bank account was created
Format: date-time
idstringOptionalThe unique identifier of the bank account.
statusstringOptionalBank Account status
Known values: NEW, PENDING, APPROVED, FAILED
updated_atstringOptionalDate and time when bank account was last updated
Format: date-time

Reject an EOR quote — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)stringAlternativeThe unique identifier of the EOR contract whose quote was rejected.
id (anyOf 2)nullAlternativeThe unique identifier of the EOR contract whose quote was rejected.
rejection_reasonJSONOptional
rejection_reason (anyOf 1)stringAlternativeThe reason recorded for the latest quote rejection.
rejection_reason (anyOf 2)nullAlternativeThe reason recorded for the latest quote rejection.
statusJSONOptional
status (anyOf 1)stringAlternativeThe status of the contract after the rejection.
status (anyOf 2)nullAlternativeThe status of the contract after the rejection.

Reject an EOR quote — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
messagestringOptionalOptional free-text explanation accompanying the rejection.
Maximum length: 2000
reasonstringRequired within parentThe 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.