Skip to content

Deel: EOR offboarding schemas

33 Deel schemas with complete fields and constraints.

← EOR offboarding operations · All schemas

Create client sign off — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Create client sign off — 200 response body — data

Referenced models: Create client sign off — 200 response body — data

Create client sign off — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalThe unique identifier of the employee contract.
created_atstringOptionalThe date and time the offboarding request was created
Format: date-time
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
documentsModelOptionalExpand Create client sign off — 200 response body — data documents
Document management structure for termination workflow including review processes and supporting documents
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
idstringOptionalThe unique identifier of the offboarding request
Format: uuid
is_sensitivebooleanOptionalIndicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand 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)nullAlternative
updated_atstringOptionalThe date and time the offboarding request was updated
Format: date-time

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, Create client sign off — 200 response body — data documents

Create client sign off — 200 response body — data documents

FieldTypePresenceDescription and constraints
$objectRootDocument management structure for termination workflow including review processes and supporting documents
offboardingarrayRequired within parentDocument set shared that requires client or employee review
offboarding[]ModelEach itemExpand Create client sign off — 200 response body — data documents offboarding item
resignation_letterJSONOptional
resignation_letter (anyOf 1)ModelAlternativeExpand Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at
resignation_letter (anyOf 2)nullAlternative
supportingarrayRequired within parent
supporting[]ModelEach itemExpand 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 documents resignation letter created at, id, signature, signed at, updated at

Create client sign off — 200 response body — data documents offboarding item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time the document set was created
Format: date-time
filesarrayRequired within parent
files[]ModelEach itemExpand Create client sign off — 200 response body — data documents offboarding item files item
idstringOptionalThe unique identifier of the document set shared with the employee.
Format: uuid
is_employee_notification_requiredbooleanRequired within parentIndicates if the employee should be notified about this document review
notification_instructionsJSONOptional
notification_instructions (anyOf 1)stringAlternativeHTML instructions for the reviewer notification
notification_instructions (anyOf 2)nullAlternativeHTML instructions for the reviewer notification
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeThe date and time when the document was reviewed
Format: date-time
reviewed_at (anyOf 2)nullAlternativeThe date and time when the document was reviewed
Format: date-time
reviewed_byJSONOptional
reviewed_by (anyOf 1)stringAlternativeThe name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client
reviewed_by (anyOf 2)nullAlternativeThe name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client
reviewer_feedbackJSONOptional
reviewer_feedback (anyOf 1)stringAlternativeFeedback provided by the reviewer
reviewer_feedback (anyOf 2)nullAlternativeFeedback provided by the reviewer
reviewer_typestringRequired within parentThe type of reviewer for this document
Known values: CLIENT, EMPLOYEE
statusstringRequired within parentThe current status of the document review
Known values: AWAITING_REVIEW, AWAITING_FEEDBACK, FEEDBACK_PROVIDED, APPROVED, CHANGES_REQUESTED_BY_CLIENT, CHANGES_REQUESTED_BY_EMPLOYEE, WAIVED_REVIEW, NOT_RESPONDED, CANCELLED
updated_atstringOptionalThe date and time the document set was updated
Format: date-time

Referenced models: Create client sign off — 200 response body — data documents offboarding item files item

Create client sign off — 200 response body — data documents offboarding item files item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date and time the file was created
Format: date-time
idstringRequired within parentThe unique identifier of the file
namestringRequired within parentThe name of the file
typestringRequired within parentThe type/extension of the file
updated_atstringOptionalThe date and time the file was updated
Format: date-time

Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time the resignation letter was created
Format: date-time
idstringOptionalThe unique identifier of the resignation letter
Format: uuid
signatureJSONOptional
signature (anyOf 1)stringAlternativeThe signature of the resignation letter
signature (anyOf 2)nullAlternativeThe signature of the resignation letter
signed_atJSONOptional
signed_at (anyOf 1)stringAlternativeThe date and time when the resignation letter was signed
Format: date-time
signed_at (anyOf 2)nullAlternativeThe date and time when the resignation letter was signed
Format: date-time
updated_atstringOptionalThe date and time the resignation letter was updated
Format: date-time

Create client sign off — 200 response body — data documents supporting item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date and time the file was created
Format: date-time
idstringRequired within parentThe unique identifier of the file
is_additional_supporting_documentbooleanRequired within parentIndicates if this is an additional supporting document added after the initial submission
namestringRequired within parentThe name of the file
typestringRequired within parentThe type/extension of the file
updated_atstringRequired within parentThe date and time the file was updated
Format: date-time

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

FieldTypePresenceDescription and constraints
$objectRoot
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
eligible_for_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (anyOf 1)stringAlternativeParameter 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)nullAlternative
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
reasonModelOptionalExpand 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_detailJSONOptional
reason_detail (anyOf 1)stringAlternativeOptional field to describe the reason behind the resignation request
reason_detail (anyOf 2)nullAlternativeOptional field to describe the reason behind the resignation request
used_time_offModelOptionalExpand 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

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

FieldTypePresenceDescription and constraints
$stringRootThe reason for the termination
Known values: STATUS_CHANGE, RELOCATION, COMPENSATION, RETIREMENT, JOB_ABANDONMENT, WORK_RELATED, PERSONAL, OTHER_OPPORTUNITY, NON_RENEWAL, PROBATION, ASSIGNMENT_ENDED, POSITION_ELIMINATION, FORCE_REDUCTION, DEATH, FOR_CAUSE, PERFORMANCE, MEDICAL, PERFORMANCE_ISSUES, ATTENDANCE_ISSUES, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE, ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, OFFER_WAS_REVOKED, EXITING_THE_MARKET, NO_LONGER_WISH_TO_WORK_WITH_DEEL, COMPANY_ACQUIRED, STEALING, MISCONDUCT, FALSIFYING, HARASSMENT, VIOLENCE, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE, STANDARD_RESELLER_PRACTICE, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, OTHER

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

FieldTypePresenceDescription and constraints
$objectRootTime-off usage data including policy information and tracking periods
additional_detailsJSONOptional
additional_details (anyOf 1)ModelAlternativeExpand 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 additional details last updated at, notes, updated by
additional_details (anyOf 2)nullAlternative
is_deel_pto_confirmedbooleanRequired within parentIndicates whether the PTO allocation has been confirmed by Deel's system
time_offsarrayRequired within parent
time_offs[]ModelEach itemExpand 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 offs item

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 additional details last updated at, notes, updated by, 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 offs 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 used time off additional details last updated at, notes, updated by

FieldTypePresenceDescription and constraints
$objectRoot
last_updated_atJSONOptional
last_updated_at (anyOf 1)stringAlternativeThe date and time when the time-off data was last updated
Format: date-time
last_updated_at (anyOf 2)nullAlternativeThe date and time when the time-off data was last updated
Format: date-time
notesJSONOptional
notes (anyOf 1)stringAlternativeAdditional notes or comments about the time-off data
notes (anyOf 2)nullAlternativeAdditional notes or comments about the time-off data
updated_byJSONOptional
updated_by (anyOf 1)stringAlternativeThe person or system that last updated the time-off data
updated_by (anyOf 2)nullAlternativeThe person or system that last updated the time-off data

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 offs item

FieldTypePresenceDescription and constraints
$objectRoot
policy_typestringRequired within parentThe type of time-off policy
scheduled_until_end_dateJSONRequired within parent
scheduled_until_end_date (anyOf 1)numberAlternativeThe amount of time off scheduled until the end date of the current tracking period
Format: double
scheduled_until_end_date (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tracking_periodsarrayRequired within parent
tracking_periods[]ModelEach itemExpand 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 offs item tracking periods item
unitstringRequired within parentThe unit of measurement for time off tracking
Known values: BUSINESS_DAY, CALENDAR_DAY, HOUR

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 time offs item tracking periods 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 used time off time offs item tracking periods item

FieldTypePresenceDescription and constraints
$objectRoot
end_datestringRequired within parentThe end date of the tracking period
Format: date-time
start_datestringRequired within parentThe start date of the tracking period
Format: date-time
usedJSONRequired within parent
used (anyOf 1)numberAlternativeThe amount of time off used in this tracking period
Format: double
used (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create client sign off — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
has_client_approvedbooleanRequired within parentIndicates if the client has approved the termination request
has_employee_been_notifiedboolean or nullOptionalIndicates if the employee has been notified about the termiantion
reviewer_feedbackstring or nullOptionalFeedback from the reviewer when the termination is not approved. Required if has_client_approved is false, otherwise optional.
Maximum length: 2000

Get additional information required to request employee termination — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get additional information required to request employee termination — 200 response body — data
Specifies the text of additional questions that the client must answer when requesting a termination

Referenced models: Get additional information required to request employee termination — 200 response body — data

Get additional information required to request employee termination — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootSpecifies the text of additional questions that the client must answer when requesting a termination
documentsJSONOptional
documents (anyOf 1)stringAlternativeIf not null, specifies the documents that the client must upload when requesting a termination
documents (anyOf 2)nullAlternativeIf not null, specifies the documents that the client must upload when requesting a termination
questionsJSONOptional
questions (anyOf 1)arrayAlternativeA list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional.
questions (anyOf 1)[]ModelEach itemExpand Get additional information required to request employee termination — 200 response body — data questions null item
questions (anyOf 2)nullAlternativeA list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional.
questions (anyOf 2)[]ModelEach itemExpand Get additional information required to request employee termination — 200 response body — data questions null item

Referenced models: Get additional information required to request employee termination — 200 response body — data questions null item

Get additional information required to request employee termination — 200 response body — data questions null item

FieldTypePresenceDescription and constraints
$objectRoot
is_optionalbooleanOptionalIndicates whether answering the question is optional. If false, client must provide an answer.
textstringOptionalSpecifies the text of additional questions that the client must answer when requesting a termination

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

Retrieve Offboarding Request — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve Offboarding Request — 200 response body — data

Referenced models: Retrieve Offboarding Request — 200 response body — data

Retrieve Offboarding Request — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalThe unique identifier of the employee contract.
created_atstringOptionalThe date and time the offboarding request was created
Format: date-time
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
documentsModelOptionalExpand Request contract resignation — 201 response body — data documents
Document management structure for termination workflow including review processes and supporting documents
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
idstringOptionalThe unique identifier of the offboarding request
Format: uuid
is_sensitivebooleanOptionalIndicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand Retrieve Offboarding Request — 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)nullAlternative
updated_atstringOptionalThe date and time the offboarding request was updated
Format: date-time

Referenced models: Request contract resignation — 201 response body — data documents, Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off

Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off

FieldTypePresenceDescription and constraints
$objectRoot
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe 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)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
eligible_for_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (anyOf 1)stringAlternativeParameter 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)nullAlternative
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
reasonModelOptionalExpand Retrieve Offboarding Request — 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_detailJSONOptional
reason_detail (anyOf 1)stringAlternativeOptional field to describe the reason behind the resignation request
reason_detail (anyOf 2)nullAlternativeOptional field to describe the reason behind the resignation request
used_time_offModelOptionalExpand 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: Retrieve Offboarding Request — 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, 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

Retrieve Offboarding Request — 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

FieldTypePresenceDescription and constraints
$stringRootThe reason for the termination
Known values: STATUS_CHANGE, RELOCATION, COMPENSATION, RETIREMENT, JOB_ABANDONMENT, WORK_RELATED, PERSONAL, OTHER_OPPORTUNITY, NON_RENEWAL, PROBATION, ASSIGNMENT_ENDED, POSITION_ELIMINATION, FORCE_REDUCTION, DEATH, FOR_CAUSE, PERFORMANCE, MEDICAL, PERFORMANCE_ISSUES, ATTENDANCE_ISSUES, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE, ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, OFFER_WAS_REVOKED, EXITING_THE_MARKET, NO_LONGER_WISH_TO_WORK_WITH_DEEL, COMPANY_ACQUIRED, STEALING, MISCONDUCT, FALSIFYING, HARASSMENT, VIOLENCE, REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED, UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE, STANDARD_RESELLER_PRACTICE, MOVING_EMPLOYEE_TO_INTERNAL_ENTITY, MOVING_EMPLOYEE_TO_DEEL_PEO, WORKER_TYPE_CHANGE, DISSATISFIED_WITH_DEEL_SERVICE, DISSATISFIED_WITH_DEEL_PRICING, DISSATISFIED_WITH_DEEL_PRODUCT, DEEL_COLLECTIONS, EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY, EMPLOYEE_FOUND_ANOTHER_JOB, EMPLOYEE_NOT_HAPPY_WITH_BENEFITS, EMPLOYEE_NOT_HAPPY_WITH_SALARY, EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE, EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE, EMPLOYEE_NOT_HAPPY_WITH_DEEL, EMPLOYEE_PROJECT_ENDED, EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER, EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS, EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE, EMPLOYEE_DID_NOT_TAKE_THE_OFFER, EMPLOYEE_PROVIDED_NO_REASON, OTHER_BUSINESS_REASONS, PREFERRED_NOT_TO_SAY, OTHER

Retrieve restricted offboarding dates — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve restricted offboarding dates — 200 response body — data

Referenced models: Retrieve restricted offboarding dates — 200 response body — data

Retrieve restricted offboarding dates — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
earliest_available_end_datestringRequired within parentThe earliest date that can be selected as the end date.
Format: date-time
is_end_date_allowed_on_holidaysbooleanRequired within parentWhether end date selection is allowed on holidays.
is_out_work_scheduled_allowedbooleanRequired within parentWhether scheduling out of work is allowed.
restricted_datesarrayRequired within parentDates that are not enabled for selection.
restricted_dates[]stringEach itemFormat: date-time

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

FieldTypePresenceDescription and constraints
$objectRootRequired when tracking_type is OFF_PLATFORM, null otherwise
entitlement_unitstringRequired within parentUnit of measurement for the time off entitlements
One of: BUSINESS_DAY, CALENDAR_DAY, HOUR, WEEK, MONTH, YEAR
entitlementsarrayRequired within parentArray of time off entitlements for different tracking periods
entitlements[]ModelEach itemExpand 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_scheduledstringRequired within parentTotal amount of time off scheduled until the end date

Referenced models: 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

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

FieldTypePresenceDescription and constraints
$objectRoot
tracking_periodstringRequired within parentStart date of the tracking period
Format: date
tracking_period_end_datestringRequired within parentEnd date of the tracking period
Format: date
usedstringRequired within parentAmount of time off used in the period

Submit employee resignation PTO review — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
decline_reasonstringOptionalReason 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_detailstringOptionalDetailed explanation for declining the resignation request
Maximum length: 2000
Minimum length: 150
has_client_accepted_resignation_requestbooleanOptionalIndicates whether the client has accepted the resignation request
severance_amountstringOptionalAmount of severance offered to the employee
severance_typestringOptionalType of severance offered to the employee
One of: DAYS, WEEKS, MONTHS, CASH
used_time_offModelOptionalExpand 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

Submit employee resignation PTO review — request body — body data used time off

FieldTypePresenceDescription and constraints
$objectRootTime-off usage data including policy information and tracking periods
off_platform_used_time_offJSONOptionalRequired when tracking_type is OFF_PLATFORM, null otherwise
off_platform_used_time_off (oneOf 1)ModelAlternativeExpand 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)nullAlternative
tracking_typestringOptionalType of time off tracking - whether it's tracked on Deel platform or off platform
One of: ON_PLATFORM, OFF_PLATFORM

Referenced models: 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

Submit employee sign-off review for offboarding documents — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
approvedbooleanRequired within parentIndicates if the employee has approved the sign-off review
requested_changesstring or nullRequired within parentDetails of requested changes if the review is not approved
Maximum length: 2000
reviewer_signaturestring or nullRequired within parentSignature of the reviewer if the review is approved
Maximum length: 1000

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.