Deel: Submit employee resignation PTO review
Deel eorOffboarding.reviewEoroffboardingPto: arguments, response, policy and SDK examples.
← EOR offboarding operations · Get started
Operation deel.eoroffboarding_revieweoroffboardingpto
Provider route: POST /eor/contracts/{contract_id}/offboarding/resignations/review-pto. 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["eorOffboarding"]["reviewEoroffboardingPto"]>[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.eorOffboarding.reviewEoroffboardingPto(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_offboarding.review_eoroffboarding_pto(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 | Model | Optional | Expand Submit employee resignation PTO review — request body — body data |
Referenced models: Submit employee resignation PTO review — 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 contract resignation — 201 response body |
Referenced models: Request contract resignation — 201 response body
Schemas
Section titled “Schemas”9 more schemas are linked from the tables above, on the schema pages.
Submit employee resignation PTO review — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
decline_reason | string | Optional | Reason for declining the resignation request One of: NOT_AGREE_WITH_END_DATE, NOT_A_RESIGNATION_BUT_TERMINATION, EMPLOYEE_UNDER_REVIEW_OR_INVESTIGATION_FOR_DISCIPLINARY_ACTIONS, OTHER |
decline_reason_detail | string | Optional | Detailed explanation for declining the resignation request Maximum length: 2000 Minimum length: 150 |
has_client_accepted_resignation_request | boolean | Optional | Indicates whether the client has accepted the resignation request |
severance_amount | string | Optional | Amount of severance offered to the employee |
severance_type | string | Optional | Type of severance offered to the employee One of: DAYS, WEEKS, MONTHS, CASH |
used_time_off | Model | Optional | Expand Submit employee resignation PTO review — request body — body data used time off Time-off usage data including policy information and tracking periods |
Referenced models: Submit employee resignation PTO review — request body — body data used time off
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
Submit employee resignation PTO review — request body — body data used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time-off usage data including policy information and tracking periods |
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 Submit employee resignation PTO review — 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
Submit employee resignation PTO review — 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[] | Model | Each item | Expand Submit employee resignation PTO review — request body — body / data / used_time_off / off_platform_used_time_off / entitlement_unit: BUSINESS DAY, CALENDAR DAY, HOUR, WEEK, MONTH, YEAR entitlements item |
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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eoroffboarding_revieweoroffboardingpto. Catalog operation: eoroffboarding_revieweoroffboardingpto. 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"}