Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Request contract resignation — 201 response body — data

Referenced models: Request contract resignation — 201 response body — data

Request contract resignation — 201 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 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: 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

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

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

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[]objectEach item
entitlements[].tracking_periodstringRequired within parentStart date of the tracking period
Format: date
entitlements[].tracking_period_end_datestringRequired within parentEnd date of the tracking period
Format: date
entitlements[].usedstringRequired within parentAmount of time off used in the period
total_scheduledstringRequired within parentTotal amount of time off scheduled until the end date

Request contract resignation — request body — body data used time off

FieldTypePresenceDescription and constraints
$objectRoot
off_platform_used_time_offJSONOptionalRequired when tracking_type is OFF_PLATFORM, null otherwise
off_platform_used_time_off (oneOf 1)ModelAlternativeExpand 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)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: 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

Retrieve worker resignations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date and time the resignation letter was created
Format: date-time
idstringRequired within parentThe unique identifier of the resignation letter
Format: uuid
signatureJSONRequired within parent
signature (anyOf 1)stringAlternativeThe signature of the resignation letter
signature (anyOf 2)nullAlternativeThe signature of the resignation letter
signed_atJSONRequired within parent
signed_at (anyOf 1)stringAlternativeThe date and time the resignation letter was signed
Format: date-time
signed_at (anyOf 2)nullAlternativeThe date and time the resignation letter was signed
Format: date-time
statusstringRequired within parentThe status of the resignation letter
Known values: AWAITING_SIGNATURE, SIGNED
updated_atstringRequired within parentThe date and time the resignation letter was updated
Format: date-time

Retrieve worker resignations — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringRequired within parentThe unique identifier of the employee contract.
created_atstringRequired within parentThe date and time the resignation was created
Format: date-time
desired_end_dateJSONRequired within parent
desired_end_date (anyOf 1)stringAlternativeThe desired end date of the resignation
Format: date-time
desired_end_date (anyOf 2)nullAlternativeThe desired end date of the resignation
Format: date-time
end_dateJSONRequired within parent
end_date (anyOf 1)stringAlternativeThe confirmed end date of the resignation
Format: date-time
end_date (anyOf 2)nullAlternativeThe confirmed end date of the resignation
Format: date-time
idstringRequired within parentThe unique identifier of the resignation
Format: uuid
resignation_letterJSONRequired within parent
resignation_letter (anyOf 1)ModelAlternativeExpand Retrieve worker resignations — 200 response body — data / item / resignation_letter / status: AWAITING SIGNATURE, SIGNED
resignation_letter (anyOf 2)nullAlternative
statusstringRequired within parentThe status of the resignation
Known values: CREATED, COMPLETED, AWAITING_REFUND, PROCESSING, AWAITING_TRIAGE, AWAITING_PROCESSING, CANCELLED, AWAITING_PTO
updated_atstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Sign Resignation Letter — 201 response body — data

Referenced models: Sign Resignation Letter — 201 response body — data

Sign Resignation Letter — 201 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 Sign Resignation Letter — 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 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, Sign Resignation Letter — 201 response body — data documents

Sign Resignation Letter — 201 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 Sign Resignation Letter — 201 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 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time the document set was created
Format: date-time
filesarrayRequired within parent
files[]ModelEach itemExpand Sign Resignation Letter — 201 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: Sign Resignation Letter — 201 response body — data documents offboarding item files item

Sign Resignation Letter — 201 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
Format: cuid
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

Sign Resignation Letter — 201 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
Format: cuid
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

Sign Resignation Letter — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
signaturestringOptionalEmployee signature

Submit EOR Worker Resignation — 201 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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

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 Submit EOR Worker 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 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, Submit EOR Worker Resignation — 201 response body — data documents

Submit EOR Worker Resignation — 201 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 Sign Resignation Letter — 201 response body — data documents offboarding item
supportingarrayRequired within parent
supporting[]ModelEach itemExpand 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

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.