Admin Portal
terminateUser
- Documentation
- API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- POSTaddCompanyBankAccount
- PUTdeactivateCompanyBankAccount
- POSTaddUser
- PUTupdateUser
- POSTaddUsers
- POSTaddStateRegistration
- PUTupdateStateRegistration
- POSTaddUserWage
- PUTupdateUserWage
- PUTupdateBusinessUserAsEmployee
- PUTupdateEmployeeAsBusinessUser
- PUTupdateBusinessUser
- PUTupdateCompanyLocation
- POSTactivateUser
- POSTdeactivateUser
- PUTterminateUser
- POST
- User Portal
- Payroll
- Reports
API Reference
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
terminateUser · 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 · enum<string>
*
finalPayCheckType
Required
enum<string>
terminationChoice
Enum · enum<string>
*
terminationChoice
Required
enum<string>
dismissalType
Only used If employeeRefTerminationChoice is No · 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
default: terminateUserrequireduser
object
requireduser.userId
string
requireduser.companyId
string
requireduser.exitDate
string
requireduser.personalEmail
string
requireduser.finalPayCheckType
enum<string>
requiredAvailable options:
They will be paid by cash or check
, They will be paid by supplemental payroll
, They will be paid by a different way
, They will be paid during a regular payroll cycle
, They have already been paid
user.terminationChoice
enum<string>
requiredAvailable options:
Yes - This employee is leaving voluntarily
, No - This employee did not choose to leave
user.dismissalType
enum<string>
requiredAvailable options:
Performance
, Attendance
, Other
, Layoff
, Location
, Seasonal
, Position Eliminated
user.severance
boolean
requireduser.severancePaymentType
enum<string>
requiredAvailable options:
No, the severance payments will be made over time
, Yes, it will be a one time severance payment
user.severancePaymentFrequency
enum<string>
requiredAvailable options:
Weekly, every Friday
, Bi-Weekly, Every other Friday
, Monthly, Last Day of the month
, Semi-Monthly, 15th and last day of month
user.firstSeverancePayDate
string
requireduser.lastSeverancePayDate
string
requireduser.severanceAmount
integer
requireduser.additionalNotes
string
requiredResponse
200 - application/json
user
object
requireduser.userId
string
requireduser.status
string
requireduser.message
string