API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETGetBusinessUserInfo
- GETGetUserTask
- GETGetUsersByCompanyName
- GETGetCompanies
- GETGetPaidEmployeesCountBasedOnDateRange
- GETGetPayPeriodDetails
- GETGetPayPeriod
- GETGetCompanyInfo
- GETGetCompanyLocationInfo
- GETGetActiveUsers
- GETGetTerminatedUsers
- GETGetDeactivatedUsers
- GETGetPayrollHistoryBasedOnPayPeriod
- GETGetPayrollHistoryBasedOnDateRange
- GETGetPayRun
- GETGetPaySchedule
- GETGetPayStub
- GETGetTransactionBasedOnReference
- GETGetTransactions
- GETGetTransactionsBasedOnName
- GETGetBusinessUserDetails
- GETGetStateW4FormFeilds
- GETGetPayrollJournalReport
- GETGetUser
- GETGetPayBeginDates
- GETGetStateRegistration
- GETGetIndividualPayrollHistory
- GET
- Webhooks
Reports
GetTerminatedUsers
GET
/
reports#getTerminatedUsers
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getTerminatedUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getTerminatedUsers",
"companyId": "4c27f783-681a-4a7a-aaf2-03c719f5c9fc",
"workerType": "W2"
}'
{
"summary": "Success",
"value": {
"user": [
{
"user": "Nelson Mandor",
"userId": "842A1486-6947-4095-88E0-0FE8ADB8C266",
"companyId": "4C27F783-681A-4A7A-AAF2-03C719F5C9FC",
"status": {
"userStatus": "Terminate"
},
"firstName": "Nelson",
"lastName": "Mandor",
"middleName": null,
"personalEmail": "hhjj@mail.com",
"phoneNumber": "7788589652",
"kycStatus": "passed",
"jobTitle": "HR",
"dateOfJoin": "2023-05-29",
"email": "nelson789@mail.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "663 Calle Tulipan",
"address2": null,
"city": "Thousand Oaks",
"state": "CA",
"zipcode": "91360",
"country": "US"
}
}
]
}
}
Body
application/json
Example:
["getTerminatedUsers"]
Available options:
W2
, 1099-NEC
Response
200 - application/json
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getTerminatedUsers' \
--header 'Content-Type: application/json' \
--data '{
"method": "getTerminatedUsers",
"companyId": "4c27f783-681a-4a7a-aaf2-03c719f5c9fc",
"workerType": "W2"
}'
{
"summary": "Success",
"value": {
"user": [
{
"user": "Nelson Mandor",
"userId": "842A1486-6947-4095-88E0-0FE8ADB8C266",
"companyId": "4C27F783-681A-4A7A-AAF2-03C719F5C9FC",
"status": {
"userStatus": "Terminate"
},
"firstName": "Nelson",
"lastName": "Mandor",
"middleName": null,
"personalEmail": "hhjj@mail.com",
"phoneNumber": "7788589652",
"kycStatus": "passed",
"jobTitle": "HR",
"dateOfJoin": "2023-05-29",
"email": "nelson789@mail.com",
"userWages": [
{
"userWorkerType": {
"workerType": "W2"
}
}
],
"userAddress": {
"address1": "663 Calle Tulipan",
"address2": null,
"city": "Thousand Oaks",
"state": "CA",
"zipcode": "91360",
"country": "US"
}
}
]
}
}