Deel: Request EOR Contract Resignation
Deel eorTerminations.createResignation: arguments, response, policy and SDK examples.
← EOR terminations operations · Get started
Operation deel.eorterminations_createresignation
Provider route: POST /eor/{oid}/terminations/resignation. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorTerminations"]["createResignation"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.eorTerminations.createResignation(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.eor_terminations.create_resignation(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.oid | string | Required within parent | |
body | object | Optional | |
body.data | Model | Required within parent | Expand Request EOR Contract Resignation — request body — body data |
Referenced models: Request EOR Contract Resignation — request body — body data
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Request EOR Contract Resignation — 200 response body |
Referenced models: Request EOR Contract Resignation — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
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 — 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 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
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 |
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 |
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 |
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 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
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 |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorterminations_createresignation. Catalog operation: eorterminations_createresignation. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["contracts:read", "contracts:write"]
Pinned headers: {"X-Version": "2026-01-01"}