getTerminatedUsers

The getTerminatedUsers API retrieves comprehensive information about all users who have been terminated within a company.

What it does:

• Provides user data for employees and contractors who have been terminated

Notes:

• Terminated user data may need to be retained for compliance and to resolve outstanding tax withholdings
• Returns the same fields as getUsers, which can be used to retrieve a full list of activated, deactivated and terminated users

GET /reports#getTerminatedUsers

getTerminatedUsers

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getTerminatedUsers' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getTerminatedUsers",
  "companyId": "4c27f783-681a-4a7a-aaf2-03c719f5c9fc",
  "workerType": "W2"
}
'

200

{
  "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": "[e-mail]",
      "phoneNumber": "7788589652",
      "kycStatus": "passed",
      "jobTitle": "HR",
      "dateOfJoin": "2023-05-29",
      "email": "[e-mail]",
      "userWages": [
        {
          "userWorkerType": {
            "workerType": "W2"
          }
        }
      ],
      "userAddress": {
        "address1": "663 Calle Tulipan",
        "address2": null,
        "city": "Thousand Oaks",
        "state": "CA",
        "zipcode": "91360",
        "country": "US"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

Example:

"getTerminatedUsers"

companyId · string<uuid> · required

workerType · enum<string> · required

Available options: W2, 1099-NEC

Response

200 - application/json

user · object[] · required

Show child attributes