Admin Portal
terminateUser
API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- POSTaddCompanyBankAccount
- PUTdeactivateCompanyBankAccount
- POSTaddUser
- POSTaddBusinessContractor
- PUTupdateUser
- POSTaddUsers
- POSTaddStateRegistration
- PUTupdateStateRegistration
- POSTaddUserWage
- PUTupdateUserWage
- PUTupdateBusinessUserAsEmployee
- PUTupdateEmployeeAsBusinessUser
- PUTupdateBusinessUser
- PUTupdateCompanyLocation
- POSTactivateUser
- POSTdeactivateUser
- PUTterminateUser
- POST
- User Portal
- Payroll
- benefits
- Reports
Admin Portal
terminateUser
This Endpoint is used to Terminate either Employee/Contractor
PUT
/
adminPortal#terminateUser
Authorization
object
*
Authorization
Required
object
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
username
string
username
string
password
string
password
string
object
method
string
*
method
Required
string
Add Example Value
user
object
*
user
Required
object
userId
string
*
userId
Required
string
companyId
string
*
companyId
Required
string
exitDate
string
*
exitDate
Required
string
personalEmail
string
*
personalEmail
Required
string
finalPayCheckType
enum<string>
*
finalPayCheckType
Required
enum<string>
terminationChoice
enum<string>
*
terminationChoice
Required
enum<string>
dismissalType
enum<string>
*
dismissalType
Required
enum<string>
severance
boolean
*
severance
Required
boolean
severancePaymentType
enum<string>
*
severancePaymentType
Required
enum<string>
severancePaymentFrequency
enum<string>
*
severancePaymentFrequency
Required
enum<string>
firstSeverancePayDate
string
*
firstSeverancePayDate
Required
string
lastSeverancePayDate
string
*
lastSeverancePayDate
Required
string
severanceAmount
integer
*
severanceAmount
Required
integer
additionalNotes
string
*
additionalNotes
Required
string
Body
application/json
method
string
requireduser
object
requiredResponse
200 - application/json
user
object
required