removeGarnishment
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/removeGarnishment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EcE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D"
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/removeGarnishment"
payload = {
"method": "removeUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EcE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'removeUserGarnishment',
userId: '1755E872-9092-4ECE-8386-860531D492D3',
companyId: '21DA3F1A-E593-42EcE-95F5-A22EDF6382F0',
garnishmentId: '52F6249E-F4ED-40C2-B25F-39BB99BCF98D'
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/removeGarnishment', 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/adminPortal/removeGarnishment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'removeUserGarnishment',
'userId' => '1755E872-9092-4ECE-8386-860531D492D3',
'companyId' => '21DA3F1A-E593-42EcE-95F5-A22EDF6382F0',
'garnishmentId' => '52F6249E-F4ED-40C2-B25F-39BB99BCF98D'
]),
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/adminPortal/removeGarnishment"
payload := strings.NewReader("{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.rollfi.xyz/adminPortal/removeGarnishment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/removeGarnishment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Garnishment removed successfully"
}{
"error": {
"code": 404,
"message": "garnishment not found"
}
}Admin Portal
removeGarnishment
The removeGarnishment API is used to remove a garnishment from an employee
When to use:
- When the garnishment is paid in full outside of payroll
- When a garnishment is no longer applicable to the employee
Notes:
- An employee’s active garnishments and garnishmentIds can be viewed using the
getUserAPI - Once removed, the garnishment will no longer show in
getUser, and will not be applied to future pay periods
POST
/
adminPortal
/
removeGarnishment
removeGarnishment
curl --request POST \
--url https://sandbox.rollfi.xyz/adminPortal/removeGarnishment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "removeUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EcE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D"
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/removeGarnishment"
payload = {
"method": "removeUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EcE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'removeUserGarnishment',
userId: '1755E872-9092-4ECE-8386-860531D492D3',
companyId: '21DA3F1A-E593-42EcE-95F5-A22EDF6382F0',
garnishmentId: '52F6249E-F4ED-40C2-B25F-39BB99BCF98D'
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/removeGarnishment', 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/adminPortal/removeGarnishment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'removeUserGarnishment',
'userId' => '1755E872-9092-4ECE-8386-860531D492D3',
'companyId' => '21DA3F1A-E593-42EcE-95F5-A22EDF6382F0',
'garnishmentId' => '52F6249E-F4ED-40C2-B25F-39BB99BCF98D'
]),
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/adminPortal/removeGarnishment"
payload := strings.NewReader("{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://sandbox.rollfi.xyz/adminPortal/removeGarnishment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/removeGarnishment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"removeUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EcE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Garnishment removed successfully"
}{
"error": {
"code": 404,
"message": "garnishment not found"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
⌘I
