Deel: Get termination
Deel eorTerminations.getTermination: arguments, response, policy and SDK examples.
← EOR terminations operations · Get started
Operation deel.eorterminations_gettermination
Provider route: GET /eor/{oid}/terminations/{terminationId}. 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"]["getTermination"]>[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.getTermination(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.get_termination(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 | |
path.terminationId | string | Required within parent |
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 Get termination — response body |
Referenced models: Get termination — response body
Schemas
Section titled “Schemas”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 |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_termination_reason_id | JSON | Optional | |
custom_termination_reason_id (anyOf 1) | string | Alternative | Custom termination reason ID. A custom termination reason can be added on Client HR module |
custom_termination_reason_id (anyOf 2) | null | Alternative | Custom termination reason ID. A custom termination reason can be added on Client HR module |
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 |
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 eligibleForRehire |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | Describe if the option DONT_KNOW was selected on eligibleForRehire |
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 | JSON | Optional | |
reason (anyOf 1) | string | Alternative | |
reason (anyOf 2) | null | Alternative | |
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 |
termination_impact | JSON | Optional | Custom termination impact data if there is some configured on HR module |
termination_impact (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 termination impact description, id, title |
termination_impact (anyOf 2) | null | Alternative |
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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorterminations_gettermination. Catalog operation: eorterminations_gettermination. 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"]
Pinned headers: {"X-Version": "2026-01-01"}