Skip to content

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.

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 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_offboarding.get_contract_offboarding_time_offs(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.end_datestringOptionalFormat: date

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve Employee Time Off Data for Offboarding — 200 response body

Referenced models: Retrieve Employee Time Off Data for Offboarding — 200 response body

Retrieve Employee Time Off Data for Offboarding — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the employee contract
entitlementsarrayRequired within parentList of entitlement periods sorted by tracking period (descending)
entitlements[]ModelEach itemExpand Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item
has_external_integrationbooleanRequired within parentWhether the contract has external integration
policy_settingsModelRequired within parentExpand Retrieve Employee Time Off Data for Offboarding — 200 response body — data policy settings
Policy configuration settings for time off calculations
remaining_balanceJSONOptional
remaining_balance (anyOf 1)JSONAlternative
remaining_balance (anyOf 1) (anyOf 1)numberAlternativeRemaining time off balance
Format: double
remaining_balance (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
remaining_balance (anyOf 2)nullAlternativeRemaining time off balance
Format: double
tracking_typestringRequired within parentThe time off tracking type
Known values: OFF_PLATFORM, ON_PLATFORM
upcoming_time_offsarrayRequired within parentList of upcoming time off requests
upcoming_time_offs[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootPolicy configuration settings for time off calculations
entitlement_unitstringRequired within parentThe entitlement unit for the policy
is_accrued_days_availablebooleanRequired within parentWhether accrued days are available
is_estimated_payout_availablebooleanRequired within parentWhether estimated payout is available
Retrieve Employee Time Off Data for Offboarding — 200 response body — data entitlements item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentWhen the entitlement was created
Format: date-time
entitlement_unitstringRequired within parentUnit of time measurement
Known values: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR
idstringRequired within parentThe entitlement ID
Format: uuid
requestsJSONRequired within parent
requests (anyOf 1)integerAlternativeNumber of time off requests in this period
requests (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_periodstringRequired within parentThe tracking period start date
Format: date
tracking_period_end_datestringRequired within parentThe tracking period end date
Format: date
updated_atstringRequired within parentWhen the entitlement was updated
Format: date-time
usedJSONRequired within parent
used (anyOf 1)numberAlternativeAmount of time off used in this period
Format: double
used (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve Employee Time Off Data for Offboarding — 200 response body — data upcoming time offs item
FieldTypePresenceDescription and constraints
$objectRoot
amountJSONRequired within parent
amount (anyOf 1)numberAlternativeAmount of time off requested
Format: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
approved_atstringRequired within parentWhen the time off was approved
Format: date-time
created_atstringRequired within parentWhen the time off request was created
Format: date-time
end_datestringRequired within parentEnd date of the time off
Format: date-time
idstringRequired within parentTime off request ID
Format: uuid
requested_atstringRequired within parentWhen the time off was requested
Format: date-time
start_datestringRequired within parentStart date of the time off
Format: date-time
statusstringRequired within parentStatus of the time off request
updated_atstringRequired within parentWhen the time off request was updated
Format: date-time

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.