getTerminatedUsers
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"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTerminatedUsers"
payload = {
"method": "getTerminatedUsers",
"companyId": "4c27f783-681a-4a7a-aaf2-03c719f5c9fc",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTerminatedUsers',
companyId: '4c27f783-681a-4a7a-aaf2-03c719f5c9fc',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTerminatedUsers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getTerminatedUsers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTerminatedUsers',
'companyId' => '4c27f783-681a-4a7a-aaf2-03c719f5c9fc',
'workerType' => 'W2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getTerminatedUsers"
payload := strings.NewReader("{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getTerminatedUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTerminatedUsers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
]
}Reports
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 --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"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTerminatedUsers"
payload = {
"method": "getTerminatedUsers",
"companyId": "4c27f783-681a-4a7a-aaf2-03c719f5c9fc",
"workerType": "W2"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'getTerminatedUsers',
companyId: '4c27f783-681a-4a7a-aaf2-03c719f5c9fc',
workerType: 'W2'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTerminatedUsers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.rollfi.xyz/reports/getTerminatedUsers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'getTerminatedUsers',
'companyId' => '4c27f783-681a-4a7a-aaf2-03c719f5c9fc',
'workerType' => 'W2'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.rollfi.xyz/reports/getTerminatedUsers"
payload := strings.NewReader("{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.rollfi.xyz/reports/getTerminatedUsers")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTerminatedUsers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"getTerminatedUsers\",\n \"companyId\": \"4c27f783-681a-4a7a-aaf2-03c719f5c9fc\",\n \"workerType\": \"W2\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
200 - application/json
Show child attributes
Show child attributes
⌘I
