Deel: EOR offboarding schemas
33 Deel schemas with complete fields and constraints.
← EOR offboarding operations · All schemas
Create client sign off — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| 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 Create client sign off — 200 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: 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
| 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 |
resignation_letter | JSON | Optional | |
resignation_letter (anyOf 1) | Model | Alternative | Expand Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at |
resignation_letter (anyOf 2) | null | Alternative | |
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 documents resignation letter created at, id, signature, signed at, updated at
Create client sign off — 200 response body — data documents offboarding item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time the document set was created Format: date-time |
files | array | Required within parent | |
files[] | Model | Each item | Expand Create client sign off — 200 response body — data documents offboarding item files item |
id | string | Optional | The unique identifier of the document set shared with the employee. Format: uuid |
is_employee_notification_required | boolean | Required within parent | Indicates if the employee should be notified about this document review |
notification_instructions | JSON | Optional | |
notification_instructions (anyOf 1) | string | Alternative | HTML instructions for the reviewer notification |
notification_instructions (anyOf 2) | null | Alternative | HTML instructions for the reviewer notification |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | The date and time when the document was reviewed Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | The date and time when the document was reviewed Format: date-time |
reviewed_by | JSON | Optional | |
reviewed_by (anyOf 1) | string | Alternative | The 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) | null | Alternative | The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client |
reviewer_feedback | JSON | Optional | |
reviewer_feedback (anyOf 1) | string | Alternative | Feedback provided by the reviewer |
reviewer_feedback (anyOf 2) | null | Alternative | Feedback provided by the reviewer |
reviewer_type | string | Required within parent | The type of reviewer for this document Known values: CLIENT, EMPLOYEE |
status | string | Required within parent | The 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_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the file was created Format: date-time |
id | string | Required within parent | The unique identifier of the file |
name | string | Required within parent | The name of the file |
type | string | Required within parent | The type/extension of the file |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time the resignation letter was created Format: date-time |
id | string | Optional | The unique identifier of the resignation letter Format: uuid |
signature | JSON | Optional | |
signature (anyOf 1) | string | Alternative | The signature of the resignation letter |
signature (anyOf 2) | null | Alternative | The signature of the resignation letter |
signed_at | JSON | Optional | |
signed_at (anyOf 1) | string | Alternative | The date and time when the resignation letter was signed Format: date-time |
signed_at (anyOf 2) | null | Alternative | The date and time when the resignation letter was signed Format: date-time |
updated_at | string | Optional | The date and time the resignation letter was updated Format: date-time |
Create client sign off — 200 response body — data documents supporting item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the file was created Format: date-time |
id | string | Required within parent | The unique identifier of the file |
is_additional_supporting_document | boolean | Required within parent | Indicates if this is an additional supporting document added after the initial submission |
name | string | Required within parent | The name of the file |
type | string | Required within parent | The type/extension of the file |
updated_at | string | Required within parent | The 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
| 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Time-off usage data including policy information and tracking periods |
additional_details | JSON | Optional | |
additional_details (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 used time off additional details last updated at, notes, updated by |
additional_details (anyOf 2) | null | Alternative | |
is_deel_pto_confirmed | boolean | Required within parent | Indicates whether the PTO allocation has been confirmed by Deel's system |
time_offs | array | Required within parent | |
time_offs[] | Model | Each item | 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 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
last_updated_at | JSON | Optional | |
last_updated_at (anyOf 1) | string | Alternative | The date and time when the time-off data was last updated Format: date-time |
last_updated_at (anyOf 2) | null | Alternative | The date and time when the time-off data was last updated Format: date-time |
notes | JSON | Optional | |
notes (anyOf 1) | string | Alternative | Additional notes or comments about the time-off data |
notes (anyOf 2) | null | Alternative | Additional notes or comments about the time-off data |
updated_by | JSON | Optional | |
updated_by (anyOf 1) | string | Alternative | The person or system that last updated the time-off data |
updated_by (anyOf 2) | null | Alternative | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
policy_type | string | Required within parent | The type of time-off policy |
scheduled_until_end_date | JSON | Required within parent | |
scheduled_until_end_date (anyOf 1) | number | Alternative | The amount of time off scheduled until the end date of the current tracking period Format: double |
scheduled_until_end_date (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tracking_periods | array | Required within parent | |
tracking_periods[] | Model | Each item | 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 offs item tracking periods item |
unit | string | Required within parent | The unit of measurement for time off tracking Known values: BUSINESS_DAY, CALENDAR_DAY, HOUR |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
end_date | string | Required within parent | The end date of the tracking period Format: date-time |
start_date | string | Required within parent | The start date of the tracking period Format: date-time |
used | JSON | Required within parent | |
used (anyOf 1) | number | Alternative | The amount of time off used in this tracking period Format: double |
used (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create client sign off — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_client_approved | boolean | Required within parent | Indicates if the client has approved the termination request |
has_employee_been_notified | boolean or null | Optional | Indicates if the employee has been notified about the termiantion |
reviewer_feedback | string or null | Optional | Feedback 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Specifies the text of additional questions that the client must answer when requesting a termination |
documents | JSON | Optional | |
documents (anyOf 1) | string | Alternative | If not null, specifies the documents that the client must upload when requesting a termination |
documents (anyOf 2) | null | Alternative | If not null, specifies the documents that the client must upload when requesting a termination |
questions | JSON | Optional | |
questions (anyOf 1) | array | Alternative | A list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional. |
questions (anyOf 1)[] | Model | Each item | Expand Get additional information required to request employee termination — 200 response body — data questions null item |
questions (anyOf 2) | null | Alternative | A list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional. |
questions (anyOf 2)[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_optional | boolean | Optional | Indicates whether answering the question is optional. If false, client must provide an answer. |
text | string | Optional | Specifies the text of additional questions that the client must answer when requesting a termination |
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 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 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 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 |
Retrieve Offboarding Request — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve Offboarding Request — 200 response body — data |
Referenced models: Retrieve Offboarding Request — 200 response body — data
Retrieve Offboarding Request — 200 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 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) | 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, 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
| 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 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_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: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
earliest_available_end_date | string | Required within parent | The earliest date that can be selected as the end date. Format: date-time |
is_end_date_allowed_on_holidays | boolean | Required within parent | Whether end date selection is allowed on holidays. |
is_out_work_scheduled_allowed | boolean | Required within parent | Whether scheduling out of work is allowed. |
restricted_dates | array | Required within parent | Dates that are not enabled for selection. |
restricted_dates[] | string | Each item | Format: 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
| 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 |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tracking_period | string | Required within parent | Start date of the tracking period Format: date |
tracking_period_end_date | string | Required within parent | End date of the tracking period Format: date |
used | string | Required within parent | Amount of time off used in the period |
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
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 |
Submit employee sign-off review for offboarding documents — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approved | boolean | Required within parent | Indicates if the employee has approved the sign-off review |
requested_changes | string or null | Required within parent | Details of requested changes if the review is not approved Maximum length: 2000 |
reviewer_signature | string or null | Required within parent | Signature of the reviewer if the review is approved Maximum length: 1000 |