Deel: EOR worker offboarding schemas
18 Deel schemas with complete fields and constraints.
← EOR worker offboarding operations · All schemas
Request contract resignation — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Request contract resignation — 201 response body — data |
Referenced models: Request contract resignation — 201 response body — data
Request contract resignation — 201 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 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: Request contract resignation — 201 response body — data documents, 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 contract resignation — 201 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 |
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
Request contract resignation — 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[] | object | Each item | |
entitlements[].tracking_period | string | Required within parent | Start date of the tracking period Format: date |
entitlements[].tracking_period_end_date | string | Required within parent | End date of the tracking period Format: date |
entitlements[].used | string | Required within parent | Amount of time off used in the period |
total_scheduled | string | Required within parent | Total amount of time off scheduled until the end date |
Request contract resignation — request body — body data used time off
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
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 Request contract resignation — 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 |
Retrieve worker resignations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve worker resignations — 200 response body — data item |
Referenced models: Retrieve worker resignations — 200 response body — data item
Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the resignation letter was created Format: date-time |
id | string | Required within parent | The unique identifier of the resignation letter Format: uuid |
signature | JSON | Required within parent | |
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 | Required within parent | |
signed_at (anyOf 1) | string | Alternative | The date and time the resignation letter was signed Format: date-time |
signed_at (anyOf 2) | null | Alternative | The date and time the resignation letter was signed Format: date-time |
status | string | Required within parent | The status of the resignation letter Known values: AWAITING_SIGNATURE, SIGNED |
updated_at | string | Required within parent | The date and time the resignation letter was updated Format: date-time |
Retrieve worker resignations — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Required within parent | The unique identifier of the employee contract. |
created_at | string | Required within parent | The date and time the resignation was created Format: date-time |
desired_end_date | JSON | Required within parent | |
desired_end_date (anyOf 1) | string | Alternative | The desired end date of the resignation Format: date-time |
desired_end_date (anyOf 2) | null | Alternative | The desired end date of the resignation Format: date-time |
end_date | JSON | Required within parent | |
end_date (anyOf 1) | string | Alternative | The confirmed end date of the resignation Format: date-time |
end_date (anyOf 2) | null | Alternative | The confirmed end date of the resignation Format: date-time |
id | string | Required within parent | The unique identifier of the resignation Format: uuid |
resignation_letter | JSON | Required within parent | |
resignation_letter (anyOf 1) | Model | Alternative | Expand Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED |
resignation_letter (anyOf 2) | null | Alternative | |
status | string | Required within parent | The status of the resignation Known values: CREATED, COMPLETED, AWAITING_REFUND, PROCESSING, AWAITING_TRIAGE, AWAITING_PROCESSING, CANCELLED, AWAITING_PTO |
updated_at | string | Required within parent | The date and time the resignation was updated Format: date-time |
Referenced models: Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED
Sign Resignation Letter — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Sign Resignation Letter — 201 response body — data |
Referenced models: Sign Resignation Letter — 201 response body — data
Sign Resignation Letter — 201 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 Sign Resignation Letter — 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 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, Sign Resignation Letter — 201 response body — data documents
Sign Resignation Letter — 201 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 Sign Resignation Letter — 201 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 Sign Resignation Letter — 201 response body — data documents supporting item |
Referenced models: Sign Resignation Letter — 201 response body — data documents supporting item, Create client sign off — 200 response body — data documents resignation letter created at, id, signature, signed at, updated at, Sign Resignation Letter — 201 response body — data documents offboarding item
Sign Resignation Letter — 201 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 Sign Resignation Letter — 201 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: Sign Resignation Letter — 201 response body — data documents offboarding item files item
Sign Resignation Letter — 201 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 Format: cuid |
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 |
Sign Resignation Letter — 201 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 Format: cuid |
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 |
Sign Resignation Letter — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
signature | string | Optional | Employee signature |
Submit EOR Worker Resignation — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Submit EOR Worker Resignation — 201 response body — data |
Referenced models: Submit EOR Worker Resignation — 201 response body — data
Submit EOR Worker Resignation — 201 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 Submit EOR Worker 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 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, Submit EOR Worker Resignation — 201 response body — data documents
Submit EOR Worker Resignation — 201 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 Sign Resignation Letter — 201 response body — data documents offboarding item |
supporting | array | Required within parent | |
supporting[] | Model | Each item | Expand Sign Resignation Letter — 201 response body — data documents supporting item |
Referenced models: Sign Resignation Letter — 201 response body — data documents supporting item, Sign Resignation Letter — 201 response body — data documents offboarding item