Terminates an employee record with a specified reason and effective date.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Do take a look at Get Termination Reasons API to fetch the list of termination reasons. You should pass the
idof the corresponding reason that pertains to your use case in theterminationReasonkey in this APIException: For apps that do not support the Get Termination Reasons API but support this API , please pass in any dummy string as the
terminationReason
Supported Apps
Here are the list of apps that support this API.
Workday (workday)
Hibob (hibob)
Darwinbox (darwinbox)
You can provide any comment or string as the terminationReason
Paychex (paychex)
Paycor (paycor)
You can provide any comment or string as the terminationReason
BambooHR (bamboohr)
Personio (personio)
Personio does not support setting a terminationDate and terminationReason through the API, so you can pass in any dummy date and string for these parameters respectively.
Personio only marks the employee as inactive and does not take the employee through the termination process
For more information and request examples, refer to: https://developers.getknit.dev/docs/getting-started-with-personio-hris-api#terminate-an-employee-api-in-personio
Remote (remote)
You must provide the following fields in the metadata:
-
confidential
Confidential requests are visible for who authorized the token or integration. Non-confidential requests are visible to all admins in the company -
risk_assessment_reasons
Possible reasons for offboarding risk assessment. One of: "caring_responsibilities", "disabled_or_health_condition", "family_leave" ,"member_of_union_or_works_council" ,"none_of_these", "pregnant_or_breastfeeding", "reported_concerns_with_workplace" "requested_medical_or_family_leave", "sick_leave" -
will_challenge_termination
Whether is it likely or not that the employee will challenge their termination
Shapes (shapes)
Supported Request Fields:
employeeIdterminationDateterminationReason
Remarks:
terminationReasonshould be passed as the reason ID (use Get Termination Reasons to fetch available IDs)
Humaans (humaans)
7shifts (7shifts)
Alexis HR (alexishr)
Kallidus (kallidus)
Folks HR (folkshr)
terminationDate and reason are not honored pass dummy values.
OneLogin (onelogin)
PrismHR (prismhr)
Refer api specific guides - PrismHR API Guide
Microsoft Entra (microsoft-entra)
WebWork (webwork)
Supported Request Fields:
employeeId- Required
Makeshift (makeshift)
Supported Request Fields:
employeeId- Required
Remarks
For Makeshift, terminating an employee archives (deletes) the user.
Sesame HR (sesamehr)
Supported Request Fields:
employeeId- Required