Deel: Request contract resignation
Deel eorWorkerOffboarding.createEmployeeResignation: arguments, response, policy and SDK examples.
← EOR worker offboarding operations · Get started
Operation deel.eorworkeroffboarding_createemployeeresignation
Provider route: POST /eor/contracts/{contract_id}/offboarding/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["eorWorkerOffboarding"]["createEmployeeResignation"]>[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.eorWorkerOffboarding.createEmployeeResignation(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_worker_offboarding.create_employee_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.contract_id | string | Required within parent | |
body | object | Optional | |
body.data | object | Required within parent | |
body.data.additional_reason | JSON | Optional | An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY |
body.data.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 |
body.data.additional_reason (oneOf 2) | null | Alternative | |
body.data.attachments | JSON | Optional | This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents |
body.data.attachments (anyOf 1) | object | Alternative | Additional keys: not allowed |
body.data.attachments (anyOf 1).filename | string | Required within parent | Minimum length: 1 |
body.data.attachments (anyOf 1).content_type | string | Required within parent | Minimum length: 1 |
body.data.attachments (anyOf 1).content_base64 | string | Required within parent | |
body.data.attachments (anyOf 2) | array | Alternative | Minimum items: 1 |
body.data.attachments (anyOf 2)[] | object | Each item | Additional keys: not allowed |
body.data.attachments (anyOf 2)[].filename | string | Required within parent | Minimum length: 1 |
body.data.attachments (anyOf 2)[].content_type | string | Required within parent | Minimum length: 1 |
body.data.attachments (anyOf 2)[].content_base64 | string | Required within parent | |
body.data.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 Format: date |
body.data.eligible_for_rehire | JSON | Optional | Parameter to inform whether it would be possible for the client to hire the employee again |
body.data.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 |
body.data.eligible_for_rehire (oneOf 2) | null | Alternative | |
body.data.eligible_for_rehire_reason | string or null | Optional | Describe if the option DONT_KNOW was selected on eligible_for_rehire Maximum length: 255 |
body.data.is_employee_staying_with_deel | boolean or null | Required within parent | Defines if employee will keep using Deel as provider |
body.data.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. |
body.data.reason | string | Required within parent | 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 |
body.data.reason_detail | string | Optional | Optional field to describe the reason behind the resignation request Maximum length: 5000 |
body.data.severance_amount | string | Optional | The amount of severance needed |
body.data.severance_type | string | Optional | The type of severance selected by the client. It’s an optional field One of: DAYS, WEEKS, MONTHS, CASH |
body.data.termination_notes | array | Optional | Additional notes can be provided regarding the termination for Deel, like questions and doubts Default: [] |
body.data.termination_notes[] | string | Each item | Maximum length: 5000 |
body.data.used_time_off | Model | Required within parent | Expand Request contract resignation — request body — body data used time off |
Referenced models: Request contract resignation — request body — body data used time off
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 contract resignation — 201 response body |
Referenced models: Request contract resignation — 201 response body
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Request contract resignation — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Request contract resignation — 201 response body — data |
Referenced models: Request contract resignation — 201 response body — data
Request contract resignation — request body — body data used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
off_platform_used_time_off | JSON | Optional | Required when tracking_type is OFF_PLATFORM, null otherwise |
off_platform_used_time_off (oneOf 1) | Model | Alternative | Expand Request contract resignation — request body — body / data / used_time_off / off_platform_used_time_off / entitlement_unit: BUSINESS DAY, CALENDAR DAY, HOUR, WEEK, MONTH, YEAR |
off_platform_used_time_off (oneOf 2) | null | Alternative | |
tracking_type | string | Optional | Type of time off tracking - whether it's tracked on Deel platform or off platform One of: ON_PLATFORM, OFF_PLATFORM |
Request contract resignation — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Optional | The unique identifier of the employee contract. |
created_at | string | Optional | The date and time the offboarding request was created Format: date-time |
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 |
documents | Model | Optional | Expand Request contract resignation — 201 response body — data documents Document management structure for termination workflow including review processes and supporting documents |
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 | The unique identifier of the offboarding request Format: uuid |
is_sensitive | boolean | Optional | Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team. |
request_data | JSON | Optional | |
request_data (anyOf 1) | Model | Alternative | Expand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off |
request_data (anyOf 2) | null | Alternative | |
updated_at | string | Optional | The date and time the offboarding request was updated Format: date-time |
Referenced models: Request contract resignation — 201 response body — data documents, Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
Request contract resignation — request body — body / data / used_time_off / off_platform_used_time_off / entitlement_unit: BUSINESS DAY, CALENDAR DAY, HOUR, WEEK, MONTH, YEAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Required when tracking_type is OFF_PLATFORM, null otherwise |
entitlement_unit | string | Required within parent | Unit of measurement for the time off entitlements One of: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR |
entitlements | array | Required within parent | Array of time off entitlements for different tracking periods |
entitlements[] | object | Each item | |
entitlements[].tracking_period | string | Required within parent | Start date of the tracking period Format: date |
entitlements[].tracking_period_end_date | string | Required within parent | End date of the tracking period Format: date |
entitlements[].used | string | Required within parent | Amount of time off used in the period |
total_scheduled | string | Required within parent | Total amount of time off scheduled until the end date |
Request contract resignation — 201 response body — data documents
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Document management structure for termination workflow including review processes and supporting documents |
offboarding | array | Required within parent | Document set shared that requires client or employee review |
offboarding[] | Model | Each item | Expand Create client sign off — 200 response body — data documents offboarding item |
supporting | array | Required within parent | |
supporting[] | Model | Each item | Expand Create client sign off — 200 response body — data documents supporting item |
Referenced models: Create client sign off — 200 response body — data documents supporting item, Create client sign off — 200 response body — data documents offboarding item
Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 |
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 |
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 eligible_for_rehire |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | Describe if the option DONT_KNOW was selected on eligible_for_rehire |
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 | Model | Optional | Expand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason The reason for the termination |
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 |
used_time_off | Model | Optional | Expand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off Time-off usage data including policy information and tracking periods |
Referenced models: Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off, Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason
Create client sign off — 200 response body — data documents supporting item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the file was created Format: date-time |
id | string | Required within parent | The unique identifier of the file |
is_additional_supporting_document | boolean | Required within parent | Indicates if this is an additional supporting document added after the initial submission |
name | string | Required within parent | The name of the file |
type | string | Required within parent | The type/extension of the file |
updated_at | string | Required within parent | The date and time the file was updated Format: date-time |
Create client sign off — 200 response body — data documents offboarding item files item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the file was created Format: date-time |
id | string | Required within parent | The unique identifier of the file |
name | string | Required within parent | The name of the file |
type | string | Required within parent | The type/extension of the file |
updated_at | string | Optional | The date and time the file was updated Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorworkeroffboarding_createemployeeresignation. Catalog operation: eorworkeroffboarding_createemployeeresignation. 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:write"]
Pinned headers: {"X-Version": "2026-01-01"}