The identity and technical contract details declared by the specification.
PreviewResignationLetterRequestForbiddenError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff
object
Required when trackingtype is OFFPLATFORM, null otherwise
3 properties
3 required
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems
object
8 properties
8 required
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
RetrieveWorkerResignationsRequestBadRequestError
object
1 property
SubmitEorWorkerResignationRequestUnauthorizedError
object
1 property
eor-worker-offboarding_getEmployeeResignations_Response_200
object
1 property
1 required
PreviewResignationLetterRequestInternalServerError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorWorkersResignationsGetParametersStatus
string
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
RetrieveWorkerResignationsRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason
string
Reason why the contract is being terminated
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
RequestContractResignationRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData
object
9 properties
SignResignationLetterRequestForbiddenError
object
1 property
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff
object
2 properties
ApiErrorContainer
object
2 properties
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
RequestContractResignationRequestInternalServerError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ApiErrorRequest
object
7 properties
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
eor-worker-offboarding_createEmployeeResignation_Response_201
object
1 property
1 required
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
RetrieveWorkerResignationsRequestForbiddenError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus
string
The status of the resignation letter
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
3 properties
2 required
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType
string
The type of severance selected by the client. It's an optional field
SignResignationLetterRequestUnauthorizedError
object
1 property
ApiError
object
2 properties
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason
string
The reason for the employee's resignation
RequestContractResignationRequestBadRequestError
object
1 property
RetrieveWorkerResignationsRequestUnauthorizedError
object
1 property
PreviewResignationLetterRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType
string
Type of time off tracking - whether it's tracked on Deel platform or off platform
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit
string
Unit of measurement for the time off entitlements
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
SignResignationLetterRequestBadRequestError
object
1 property
SignResignationLetterRequestInternalServerError
object
1 property
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData
object
13 properties
3 required
eor-worker-offboarding_submitEORWorkerResignation_Response_201
object
1 property
1 required
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter
object
6 properties
6 required
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems
object
3 properties
3 required
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason
string
An additional reason can be provided in case the reason selected is MOVINGEMPLOYEETOINTERNALENTITY
EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
PreviewResignationLetterRequestUnauthorizedError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
SubmitEorWorkerResignationRequestBadRequestError
object
1 property
RequestContractResignationRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
SubmitEorWorkerResignationRequestInternalServerError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus
string
The status of the resignation
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData
object
5 properties
3 required
EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
eor-worker-offboarding_signEmployeeResignationLetter_Response_201
object
1 property
1 required
EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
SubmitEorWorkerResignationRequestForbiddenError
object
1 property
EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter
object
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Deel publishes across the network.