Deel: Retrieve Employee Time Off Data for Offboarding — 200 response body — data

API reference · Contract 2026-10-27

SDK schema: 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