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
- StateRegistration
- POST
- User Portal
- Payroll
- Benefits
- Reports
- Webhooks
Admin Portal
terminateUser
This Endpoint is used to Terminate either Employee/Contractor
PUT
/
adminPortal#terminateUser
curl --request PUT \
--url 'https://sandbox.rollfi.xyz/adminPortal#terminateUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "terminateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"companyId": "eb869cf0-af11-4bdb-853c-fd2616bc91f2",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"terminationChoice": "No - This user did not choose to leave",
"dismissalType": "Layoff",
"severance": true,
"severancePaymentType": "Yes, it will be a one time severance payment",
"severancePaymentFrequency": "Weekly, every Friday",
"firstSeverancePayDate": "2023-09-09",
"lastSeverancePayDate": "2023-12-12",
"severanceAmount": 2333,
"additionalNotes": "terminated due to recession"
}
}'
{
"1": {
"summary": "Success",
"value": {
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been terminated successfully."
}
}
}
}
Body
application/json
Available 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
Available options:
Yes - This employee is leaving voluntarily
, No - This employee did not choose to leave
Available options:
Performance
, Attendance
, Other
, Layoff
, Location
, Seasonal
, Position Eliminated
Available options:
No, the severance payments will be made over time
, Yes, it will be a one time severance payment
Available options:
Weekly, every Friday
, Bi-Weekly, Every other Friday
, Monthly, Last Day of the month
, Semi-Monthly, 15th and last day of month
Maximum length:
10
Maximum length:
10
curl --request PUT \
--url 'https://sandbox.rollfi.xyz/adminPortal#terminateUser' \
--header 'Content-Type: application/json' \
--data '{
"method": "terminateUser",
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"companyId": "eb869cf0-af11-4bdb-853c-fd2616bc91f2",
"exitDate": "2023-09-09",
"personalEmail": "mm@aa.ll",
"finalPayCheckType": "They have already been paid",
"terminationChoice": "No - This user did not choose to leave",
"dismissalType": "Layoff",
"severance": true,
"severancePaymentType": "Yes, it will be a one time severance payment",
"severancePaymentFrequency": "Weekly, every Friday",
"firstSeverancePayDate": "2023-09-09",
"lastSeverancePayDate": "2023-12-12",
"severanceAmount": 2333,
"additionalNotes": "terminated due to recession"
}
}'
{
"1": {
"summary": "Success",
"value": {
"user": {
"userId": "f9b2507d-c757-4c9a-9e96-0002299fa2f7",
"status": "Inactive",
"message": "The User has been terminated successfully."
}
}
}
}