Skip to content

Deel: EOR terminations schemas

16 Deel schemas with complete fields and constraints.

← EOR terminations operations · All schemas

Get termination — response body

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalPublic contract oid
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
idstringOptional
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand 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)nullAlternative

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRoot
custom_termination_reason_idJSONOptional
custom_termination_reason_id (anyOf 1)stringAlternativeCustom termination reason ID. A custom termination reason can be added on Client HR module
custom_termination_reason_id (anyOf 2)nullAlternativeCustom termination reason ID. A custom termination reason can be added on Client HR module
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
eligible_for_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (anyOf 1)stringAlternativeParameter 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)nullAlternative
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeDescribe if the option DONT_KNOW was selected on eligibleForRehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligibleForRehire
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
reasonJSONOptional
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
reason_detailJSONOptional
reason_detail (anyOf 1)stringAlternativeOptional field to describe the reason behind the resignation request
reason_detail (anyOf 2)nullAlternativeOptional field to describe the reason behind the resignation request
termination_impactJSONOptionalCustom termination impact data if there is some configured on HR module
termination_impact (anyOf 1)ModelAlternativeExpand 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)nullAlternative

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRootCustom termination impact data if there is some configured on HR module
descriptionstringOptionalTermination impact description
idstringOptionalFormat: uuid
titlestringOptionalTermination impact title

Request EOR Contract Resignation — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get termination — response body

Referenced models: Get termination — response body

Request EOR Contract Resignation — request body — body data

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

FieldTypePresenceDescription and constraints
$objectRoot
additional_reasonJSONOptionalAn additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY
additional_reason (oneOf 1)stringAlternativeAn 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)nullAlternative
attachmentsarrayOptionalAny document that is important for the request to terminate the contract
attachments[]ModelEach itemExpand Termination Request — request body — body data attachments item
custom_termination_reason_idstring or nullOptionalCustom termination reason ID. A custom termination reason can be added on Client HR module
Format: uuid
desired_end_datestringOptionalThe 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_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (oneOf 1)stringAlternativeParameter 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)nullAlternative
eligible_for_rehire_reasonstring or nullOptionalDescribe if the option DONT_KNOW was selected on eligibleForRehire
Maximum length: 255
is_employee_staying_with_deelboolean or nullRequired within parentDefines if employee will keep using Deel as provider
is_sensitivebooleanOptionalDefines 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.
reasonModelRequired within parentExpand Request EOR Contract Resignation — request body — body data data reason
Reason why the contract is being terminated
reason_detailstringOptionalOptional field to describe the reason behind the resignation request
Maximum length: 5000
severance_amountstringOptionalThe amount of severance needed
severance_typestringOptionalThe type of severance selected by the client. It's an optional field
One of: DAYS, WEEKS, MONTHS, CASH
termination_impact_idstringOptionalTermination impact data if there is some configured on HR module
Format: uuid
termination_notesarrayOptionalAdditional notes can be provided regarding the termination for Deel, like questions and doubts
Default: []
termination_notes[]stringEach itemMaximum length: 5000
used_time_offModelRequired within parentExpand 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

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

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsstring or nullOptionalAny additional details regarding time off that HRX should know
is_deel_pto_confirmedbooleanOptionalDefines 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_offsarrayOptionalAll time-off used by the employee during contract period
time_offs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
additional_country_dataarrayOptionalFor 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[]ModelEach itemExpand Termination Request — request body — body data additional country data item
additional_reasonJSONOptionalAn additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL
additional_reason (oneOf 1)stringAlternativeAn 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)nullAlternative
additional_supporting_documentsarrayOptionalAny proof such as correspondence, documentation of previous warnings or attendance records for the reason select above.
additional_supporting_documents[]ModelEach itemExpand Termination Request — request body — body data attachments item
attachmentsarrayOptionalAny document that is important for the request to terminate the contract
attachments[]ModelEach itemExpand Termination Request — request body — body data attachments item
custom_termination_reason_idstringOptionalCustom termination reason ID. A custom termination reason can be added on Client HR module
Format: uuid
desired_end_datestringOptionalThe 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_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (oneOf 1)stringAlternativeParameter 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)nullAlternative
employee_notification_detailstring or nullOptionalIf 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_idstringOptionalThe current country data id
is_employee_notifiedbooleanRequired within parentDefines if employee was informed by client or not before the termination
is_sensitivebooleanOptionalDefines 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.
reasonModelRequired within parentExpand Termination Request — request body — body data reason
Reason why the contract is being terminated
reason_detailstringRequired within parentField 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_amountstringOptionalThe amount of severance needed
severance_typestringOptionalThe type of severance selected by the client. It's an optional field
One of: DAYS, WEEKS, MONTHS, CASH
termination_impact_idstringOptionalTermination impact data if there is some configured on HR module
Format: uuid
termination_notesarrayOptionalAdditional notes can be provided regarding the termination for Deel, like questions and doubts
Default: []
termination_notes[]stringEach itemMaximum length: 5000
used_time_offModelRequired within parentExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
answerboolean or nullRequired within parent
questionstringRequired within parent

Termination Request — request body — body data attachments item

FieldTypePresenceDescription and constraints
$objectRoot
file_namestringOptionalPattern: \.(png|PNG|jpg|JPG|jpeg|JPEG|heic|HEIC|pdf|PDF)$
keystringRequired within parent

Termination Request — request body — body data reason

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

FieldTypePresenceDescription and constraints
$objectRoot
additional_detailsstring or nullOptionalAny additional details regarding time off that HRX should know
is_deel_pto_confirmedbooleanOptionalDefines 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_offsarrayOptionalAll time-off used by the employee during contract period
time_offs[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
policy_typeModelOptionalExpand Termination Request — request body — body data used time off time offs item policy type
Time off policy type
scheduled_until_end_datestringOptionalTime off escheduled until contract end date
tracking_periodsarrayOptional
tracking_periods[]ModelEach itemExpand Termination Request — request body — body data used time off time offs item tracking periods item
unitstringRequired within parentTime 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

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

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringOptionalTime off start period
Format: date-time
start_datestringOptionalTime off end period
Format: date-time
usedstringRequired within parentTime off used in the period

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.