Deel: Retrieve Employee Time Off Data for Offboarding
Deel eorOffboarding.getContractOffboardingTimeOffs: arguments, response, policy and SDK examples.
← EOR offboarding operations · Get started
Operation deel.eoroffboarding_getcontractoffboardingtimeoffs
Provider route: GET /eor/contracts/{contract_id}/offboarding/time-offs. 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"]["getContractOffboardingTimeOffs"]>[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.getContractOffboardingTimeOffs(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.get_contract_offboarding_time_offs(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 | |
query | object | Optional | Additional keys: not allowed |
query.end_date | string | Optional | Format: date |
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 Retrieve Employee Time Off Data for Offboarding — 200 response body |
Referenced models: Retrieve Employee Time Off Data for Offboarding — 200 response body
Schemas
Section titled “Schemas”Retrieve Employee Time Off Data for Offboarding — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve Employee Time Off Data for Offboarding — 200 response body — data |
Referenced models: Retrieve Employee Time Off Data for Offboarding — 200 response body — data
Retrieve Employee Time Off Data for Offboarding — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the employee contract |
entitlements | array | Required within parent | List of entitlement periods sorted by tracking period (descending) |
entitlements[] | Model | Each item | Expand Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item |
has_external_integration | boolean | Required within parent | Whether the contract has external integration |
policy_settings | Model | Required within parent | Expand Retrieve Employee Time Off Data for Offboarding — 200 response body — data policy settings Policy configuration settings for time off calculations |
remaining_balance | JSON | Optional | |
remaining_balance (anyOf 1) | JSON | Alternative | |
remaining_balance (anyOf 1) (anyOf 1) | number | Alternative | Remaining time off balance Format: double |
remaining_balance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
remaining_balance (anyOf 2) | null | Alternative | Remaining time off balance Format: double |
tracking_type | string | Required within parent | The time off tracking type Known values: OFF_PLATFORM, ON_PLATFORM |
upcoming_time_offs | array | Required within parent | List of upcoming time off requests |
upcoming_time_offs[] | Model | Each item | Expand Retrieve Employee Time Off Data for Offboarding — 200 response body — data upcoming time offs item |
Referenced models: Retrieve Employee Time Off Data for Offboarding — 200 response body — data policy settings, Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item, Retrieve Employee Time Off Data for Offboarding — 200 response body — data upcoming time offs item
Retrieve Employee Time Off Data for Offboarding — 200 response body — data policy settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Policy configuration settings for time off calculations |
entitlement_unit | string | Required within parent | The entitlement unit for the policy |
is_accrued_days_available | boolean | Required within parent | Whether accrued days are available |
is_estimated_payout_available | boolean | Required within parent | Whether estimated payout is available |
Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | When the entitlement was created Format: date-time |
entitlement_unit | string | Required within parent | Unit of time measurement Known values: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR |
id | string | Required within parent | The entitlement ID Format: uuid |
requests | JSON | Required within parent | |
requests (anyOf 1) | integer | Alternative | Number of time off requests in this period |
requests (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_period | string | Required within parent | The tracking period start date Format: date |
tracking_period_end_date | string | Required within parent | The tracking period end date Format: date |
updated_at | string | Required within parent | When the entitlement was updated Format: date-time |
used | JSON | Required within parent | |
used (anyOf 1) | number | Alternative | Amount of time off used in this period Format: double |
used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve Employee Time Off Data for Offboarding — 200 response body — data upcoming time offs item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | JSON | Required within parent | |
amount (anyOf 1) | number | Alternative | Amount of time off requested Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
approved_at | string | Required within parent | When the time off was approved Format: date-time |
created_at | string | Required within parent | When the time off request was created Format: date-time |
end_date | string | Required within parent | End date of the time off Format: date-time |
id | string | Required within parent | Time off request ID Format: uuid |
requested_at | string | Required within parent | When the time off was requested Format: date-time |
start_date | string | Required within parent | Start date of the time off Format: date-time |
status | string | Required within parent | Status of the time off request |
updated_at | string | Required within parent | When the time off request was updated Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eoroffboarding_getcontractoffboardingtimeoffs. Catalog operation: eoroffboarding_getcontractoffboardingtimeoffs. 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"}