Deel: EOR terminations schemas
16 Deel schemas with complete fields and constraints.
← EOR terminations operations · All schemas
Get termination — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Optional | Public contract oid |
desired_end_date | JSON | Optional | |
desired_end_date (anyOf 1) | string | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date-time |
desired_end_date (anyOf 2) | null | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date-time |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The definitive contract end date Format: date-time |
end_date (anyOf 2) | null | Alternative | The definitive contract end date Format: date-time |
id | string | Optional | |
request_data | JSON | Optional | |
request_data (anyOf 1) | Model | Alternative | Expand Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact |
request_data (anyOf 2) | null | Alternative |
Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_termination_reason_id | JSON | Optional | |
custom_termination_reason_id (anyOf 1) | string | Alternative | Custom termination reason ID. A custom termination reason can be added on Client HR module |
custom_termination_reason_id (anyOf 2) | null | Alternative | Custom termination reason ID. A custom termination reason can be added on Client HR module |
desired_end_date | JSON | Optional | |
desired_end_date (anyOf 1) | string | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date-time |
desired_end_date (anyOf 2) | null | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date-time |
eligible_for_rehire | JSON | Optional | Parameter to inform whether it would be possible for the client to hire the employee again |
eligible_for_rehire (anyOf 1) | string | Alternative | Parameter to inform whether it would be possible for the client to hire the employee again Known values: YES, NO, DONT_KNOW |
eligible_for_rehire (anyOf 2) | null | Alternative | |
eligible_for_rehire_reason | JSON | Optional | |
eligible_for_rehire_reason (anyOf 1) | string | Alternative | Describe if the option DONT_KNOW was selected on eligibleForRehire |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | Describe if the option DONT_KNOW was selected on eligibleForRehire |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The definitive contract end date Format: date-time |
end_date (anyOf 2) | null | Alternative | The definitive contract end date Format: date-time |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
reason_detail | JSON | Optional | |
reason_detail (anyOf 1) | string | Alternative | Optional field to describe the reason behind the resignation request |
reason_detail (anyOf 2) | null | Alternative | Optional field to describe the reason behind the resignation request |
termination_impact | JSON | Optional | Custom termination impact data if there is some configured on HR module |
termination_impact (anyOf 1) | Model | Alternative | Expand Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact termination impact description, id, title |
termination_impact (anyOf 2) | null | Alternative |
Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact termination impact description, id, title
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom termination impact data if there is some configured on HR module |
description | string | Optional | Termination impact description |
id | string | Optional | Format: uuid |
title | string | Optional | Termination impact title |
Request EOR Contract Resignation — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Get termination — response body |
Referenced models: Get termination — response body
Request EOR Contract Resignation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Request EOR Contract Resignation — request body — body data data |
Referenced models: Request EOR Contract Resignation — request body — body data data
Request EOR Contract Resignation — request body — body data data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_reason | JSON | Optional | An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY |
additional_reason (oneOf 1) | string | Alternative | An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY One of: MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL, MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER |
additional_reason (oneOf 2) | null | Alternative | |
attachments | array | Optional | Any document that is important for the request to terminate the contract |
attachments[] | Model | Each item | Expand Termination Request — request body — body data attachments item |
custom_termination_reason_id | string or null | Optional | Custom termination reason ID. A custom termination reason can be added on Client HR module Format: uuid |
desired_end_date | string | Optional | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Pattern: ^\d{4}-\d{2}-\d{2}$ |
eligible_for_rehire | JSON | Optional | Parameter to inform whether it would be possible for the client to hire the employee again |
eligible_for_rehire (oneOf 1) | string | Alternative | Parameter to inform whether it would be possible for the client to hire the employee again One of: YES, NO, DONT_KNOW |
eligible_for_rehire (oneOf 2) | null | Alternative | |
eligible_for_rehire_reason | string or null | Optional | Describe if the option DONT_KNOW was selected on eligibleForRehire Maximum length: 255 |
is_employee_staying_with_deel | boolean or null | Required within parent | Defines if employee will keep using Deel as provider |
is_sensitive | boolean | Optional | Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications. |
reason | Model | Required within parent | Expand Request EOR Contract Resignation — request body — body data data reason Reason why the contract is being terminated |
reason_detail | string | Optional | Optional field to describe the reason behind the resignation request Maximum length: 5000 |
severance_amount | string | Optional | The amount of severance needed |
severance_type | string | Optional | The type of severance selected by the client. It's an optional field One of: DAYS, WEEKS, MONTHS, CASH |
termination_impact_id | string | Optional | Termination impact data if there is some configured on HR module Format: uuid |
termination_notes | array | Optional | Additional notes can be provided regarding the termination for Deel, like questions and doubts Default: [] |
termination_notes[] | string | Each item | Maximum length: 5000 |
used_time_off | Model | Required within parent | Expand Request EOR Contract Resignation — request body — body data data used time off |
Referenced models: Request EOR Contract Resignation — request body — body data data reason, Termination Request — request body — body data attachments item, Request EOR Contract Resignation — request body — body data data used time off
Request EOR Contract Resignation — request body — body data data reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Reason why the contract is being terminated One of: EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, EMPLOYEE_FOUND_ANOTHER_JOB, EMPLOYEE_NOT_HAPPY_WITH_BENEFITS, EMPLOYEE_NOT_HAPPY_WITH_SALARY, EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE, EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE, EMPLOYEE_NOT_HAPPY_WITH_DEEL, EMPLOYEE_PROJECT_ENDED, EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER, EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS, EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE, WORKER_TYPE_CHANGE, DEEL_COLLECTIONS, EMPLOYEE_DID_NOT_TAKE_THE_OFFER, EMPLOYEE_PROVIDED_NO_REASON, OTHER_BUSINESS_REASONS |
Request EOR Contract Resignation — request body — body data data used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | string or null | Optional | Any additional details regarding time off that HRX should know |
is_deel_pto_confirmed | boolean | Optional | Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values. |
time_offs | array | Optional | All time-off used by the employee during contract period |
time_offs[] | Model | Each item | Expand Termination Request — request body — body data used time off time offs item |
Referenced models: Termination Request — request body — body data used time off time offs item
Termination Request — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_country_data | array | Optional | For some countries some data is needed to help Deel to process the termination. The questions comes from another endpoint to get the additional country data |
additional_country_data[] | Model | Each item | Expand Termination Request — request body — body data additional country data item |
additional_reason | JSON | Optional | An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL |
additional_reason (oneOf 1) | string | Alternative | An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL One of: DISSATISFIED_WITH_DEEL_SERVICE, DISSATISFIED_WITH_DEEL_PRICING, DISSATISFIED_WITH_DEEL_PRODUCT |
additional_reason (oneOf 2) | null | Alternative | |
additional_supporting_documents | array | Optional | Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. |
additional_supporting_documents[] | Model | Each item | Expand Termination Request — request body — body data attachments item |
attachments | array | Optional | Any document that is important for the request to terminate the contract |
attachments[] | Model | Each item | Expand Termination Request — request body — body data attachments item |
custom_termination_reason_id | string | Optional | Custom termination reason ID. A custom termination reason can be added on Client HR module Format: uuid |
desired_end_date | string | Optional | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Pattern: ^\d{4}-\d{2}-\d{2}$ |
eligible_for_rehire | JSON | Optional | Parameter to inform whether it would be possible for the client to hire the employee again |
eligible_for_rehire (oneOf 1) | string | Alternative | Parameter to inform whether it would be possible for the client to hire the employee again One of: YES, NO, DONT_KNOW |
eligible_for_rehire (oneOf 2) | null | Alternative | |
employee_notification_detail | string or null | Optional | If it's an termination contract ending and employee was already informed, the employee notification details should be provided Maximum length: 5000 Minimum length: 1 |
eor_country_data_id | string | Optional | The current country data id |
is_employee_notified | boolean | Required within parent | Defines if employee was informed by client or not before the termination |
is_sensitive | boolean | Optional | Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications. |
reason | Model | Required within parent | Expand Termination Request — request body — body data reason Reason why the contract is being terminated |
reason_detail | string | Required within parent | Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information Maximum length: 5000 Minimum length: 100 |
severance_amount | string | Optional | The amount of severance needed |
severance_type | string | Optional | The type of severance selected by the client. It's an optional field One of: DAYS, WEEKS, MONTHS, CASH |
termination_impact_id | string | Optional | Termination impact data if there is some configured on HR module Format: uuid |
termination_notes | array | Optional | Additional notes can be provided regarding the termination for Deel, like questions and doubts Default: [] |
termination_notes[] | string | Each item | Maximum length: 5000 |
used_time_off | Model | Required within parent | Expand Termination Request — request body — body data used time off |
Referenced models: Termination Request — request body — body data reason, Termination Request — request body — body data additional country data item, Termination Request — request body — body data attachments item, Termination Request — request body — body data used time off
Termination Request — request body — body data additional country data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
answer | boolean or null | Required within parent | |
question | string | Required within parent |
Termination Request — request body — body data attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
file_name | string | Optional | Pattern: \.(png|PNG|jpg|JPG|jpeg|JPEG|heic|HEIC|pdf|PDF)$ |
key | string | Required within parent |
Termination Request — request body — body data reason
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Reason why the contract is being terminated One of: DEEL_COLLECTIONS, STATUS_CHANGE, RELOCATION, COMPENSATION, RETIREMENT, JOB_ABANDONMENT, WORK_RELATED, PERSONAL, OTHER_OPPORTUNITY, NON_RENEWAL, PROBATION, ASSIGNMENT_ENDED, POSITION_ELIMINATION, FORCE_REDUCTION, DEATH, FOR_CAUSE, PERFORMANCE, MEDICAL, PERFORMANCE_ISSUES, ATTENDANCE_ISSUES, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE, ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, OFFER_WAS_REVOKED, EXITING_THE_MARKET, NO_LONGER_WISH_TO_WORK_WITH_DEEL, COMPANY_ACQUIRED, STEALING, MISCONDUCT, FALSIFYING, HARASSMENT, VIOLENCE, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE, STANDARD_RESELLER_PRACTICE, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, OTHER |
Termination Request — request body — body data used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_details | string or null | Optional | Any additional details regarding time off that HRX should know |
is_deel_pto_confirmed | boolean | Optional | Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values. |
time_offs | array | Optional | All time-off used by the employee during contract period |
time_offs[] | Model | Each item | Expand Termination Request — request body — body data used time off time offs item |
Referenced models: Termination Request — request body — body data used time off time offs item
Termination Request — request body — body data used time off time offs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
policy_type | Model | Optional | Expand Termination Request — request body — body data used time off time offs item policy type Time off policy type |
scheduled_until_end_date | string | Optional | Time off escheduled until contract end date |
tracking_periods | array | Optional | |
tracking_periods[] | Model | Each item | Expand Termination Request — request body — body data used time off time offs item tracking periods item |
unit | string | Required within parent | Time off unit One of: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR |
Referenced models: Termination Request — request body — body data used time off time offs item policy type, Termination Request — request body — body data used time off time offs item tracking periods item
Termination Request — request body — body data used time off time offs item policy type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Time off policy type One of: Vacation, Sick leave, Maternity leave, Paternity leave, Parental leave, Bereavement leave, Childcare leave, Civic/public duty leave, Personal leave, Adoption leave, Blood donation leave, Childbirth leave, Disability leave, Doctor's appointment leave, Family & domestic violence leave, Hajj leave, Marriage/wedding leave, Military leave, Moving leave, Pregnancy leave, Study leave, Volunteer leave, Unpaid leave, Paid leave, Other leave, RTT, Regional holiday, Breastfeeding leave, Advanced vacation, Supplementary Leave, Floating Holiday Allowance |
Termination Request — request body — body data used time off time offs item tracking periods item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Optional | Time off start period Format: date-time |
start_date | string | Optional | Time off end period Format: date-time |
used | string | Required within parent | Time off used in the period |