Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.oidstringRequired within parent
bodyobjectOptional
body.dataModelRequired within parentExpand Request EOR Contract Resignation — request body — body data

Referenced models: Request EOR Contract Resignation — request body — body data

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Request EOR Contract Resignation — 200 response body

Referenced models: Request EOR Contract Resignation — 200 response body

2 more schemas are linked from the tables above, on the schema pages.

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 — 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 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

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

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
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
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 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

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
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

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"}

Official provider source

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.