Deel: Initiate EOR contract termination request

← eor_terminations operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation deel.eorterminations_createoffboardingtermination

Provider route: POST /eor/contracts/{contract_id}/offboarding/termination. Alter supplies the connection’s credentials and routing.

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"]["createOffboardingTermination"]>[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.createOffboardingTermination(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_offboarding_termination(arguments)
        result = await call.wait()
        return result.body_json()

Input

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 NO_LONGER_WISH_TO_WORK_WITH_DEEL
body.data.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
body.data.additional_reason (oneOf 2)	null	Alternative
body.data.additional_supporting_documents	JSON	Optional	This field allows for uploading multiple files at once. Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents.
body.data.additional_supporting_documents (anyOf 1)	object	Alternative	Additional keys: not allowed
body.data.additional_supporting_documents (anyOf 1).filename	string	Required within parent	Minimum length: 1
body.data.additional_supporting_documents (anyOf 1).content_type	string	Required within parent	Minimum length: 1
body.data.additional_supporting_documents (anyOf 1).content_base64	string	Required within parent
body.data.additional_supporting_documents (anyOf 2)	array	Alternative	Minimum items: 1
body.data.additional_supporting_documents (anyOf 2)[]	object	Each item	Additional keys: not allowed
body.data.additional_supporting_documents (anyOf 2)[].filename	string	Required within parent	Minimum length: 1
body.data.additional_supporting_documents (anyOf 2)[].content_type	string	Required within parent	Minimum length: 1
body.data.additional_supporting_documents (anyOf 2)[].content_base64	string	Required within parent
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 of the contract. If the date is not provided, Deel HRX team will select the nearest possible date. 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.employee_notification_detail	string or null	Optional	If it’s an termination contract ending and employee was already informed, should detail the notification to the employee Maximum length: 5000 Minimum length: 1
body.data.is_employee_notified	boolean	Required within parent	Defines if employee was informed by client or not before the termination
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: 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
body.data.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
body.data.required_information	array	Optional	For some countries some data is needed to help to process the termination. The questions comes from another endpoint to get the required information. See GET /eor/:oid/offboarding/required-information to get the questions.
body.data.required_information[]	object	Each item
body.data.required_information[].answer	boolean or null	Required within parent	The answer to the question
body.data.required_information[].question	string	Required within parent	The question to be answered
body.data.severance_amount	integer	Optional	The amount of severance needed Minimum: 0
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_impact_id	string	Optional	Termination impact data if there is some configured on HR module Format: uuid
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

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

Policy, approvals and errors

SDK function policy ID: deel.eorterminations_createoffboardingtermination. Catalog operation: eorterminations_createoffboardingtermination. 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"}

Official provider source