updateGarnishment
curl --request PUT \
--url https://sandbox.rollfi.xyz/adminPortal/updateGarnishment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"garnishmentFields": {
"County": "Polk",
"Case Number": "9218729",
"Start Date": "2026-03-03",
"End Date": "2026-09-09",
"Total Withholding Amount": 1000,
"Frequency (Per)": "Weekly",
"Maximum Withholding Percentage": 0.1,
"Choose who will be paying the agency": "I want my payroll provider to make the payments"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/updateGarnishment"
payload = {
"method": "updateUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"garnishmentFields": {
"County": "Polk",
"Case Number": "9218729",
"Start Date": "2026-03-03",
"End Date": "2026-09-09",
"Total Withholding Amount": 1000,
"Frequency (Per)": "Weekly",
"Maximum Withholding Percentage": 0.1,
"Choose who will be paying the agency": "I want my payroll provider to make the payments"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'updateUserGarnishment',
userId: '1755E872-9092-4ECE-8386-860531D492D3',
companyId: '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
garnishmentId: '52F6249E-F4ED-40C2-B25F-39BB99BCF98D',
garnishmentFields: {
County: 'Polk',
'Case Number': '9218729',
'Start Date': '2026-03-03',
'End Date': '2026-09-09',
'Total Withholding Amount': 1000,
'Frequency (Per)': 'Weekly',
'Maximum Withholding Percentage': 0.1,
'Choose who will be paying the agency': 'I want my payroll provider to make the payments'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/updateGarnishment', 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/updateGarnishment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'updateUserGarnishment',
'userId' => '1755E872-9092-4ECE-8386-860531D492D3',
'companyId' => '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
'garnishmentId' => '52F6249E-F4ED-40C2-B25F-39BB99BCF98D',
'garnishmentFields' => [
'County' => 'Polk',
'Case Number' => '9218729',
'Start Date' => '2026-03-03',
'End Date' => '2026-09-09',
'Total Withholding Amount' => 1000,
'Frequency (Per)' => 'Weekly',
'Maximum Withholding Percentage' => 0.1,
'Choose who will be paying the agency' => 'I want my payroll provider to make the payments'
]
]),
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/updateGarnishment"
payload := strings.NewReader("{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.rollfi.xyz/adminPortal/updateGarnishment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/updateGarnishment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"message": "Update successful"
}{
"error": {
"code": 400,
"message": "Invalid CompanyId"
}
}Admin Portal
updateGarnishment
The updateGarnishment API is used to make changes to an existing garnishment entry for an employee
- An employee’s active garnishments and garnishmentIds can be viewed using the
getUserAPI - Garnishment form fields can be retrieved using
getGarnishmentFormFields - The amount withheld per pay period is automatically calculated from the total amount and frequency since the garnishment schedule may differ from the paySchedule
When to use:
- When the garnishment details entered initially were incorrect, but the garnishment does apply to the employee
- When payments have been made outside of payroll to reduce the employee’s liability for the added garnishment
- When a garnishment is no longer applicable to the employee, or the total amount of liability has changed
PUT
/
adminPortal
/
updateGarnishment
updateGarnishment
curl --request PUT \
--url https://sandbox.rollfi.xyz/adminPortal/updateGarnishment \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "updateUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"garnishmentFields": {
"County": "Polk",
"Case Number": "9218729",
"Start Date": "2026-03-03",
"End Date": "2026-09-09",
"Total Withholding Amount": 1000,
"Frequency (Per)": "Weekly",
"Maximum Withholding Percentage": 0.1,
"Choose who will be paying the agency": "I want my payroll provider to make the payments"
}
}
'import requests
url = "https://sandbox.rollfi.xyz/adminPortal/updateGarnishment"
payload = {
"method": "updateUserGarnishment",
"userId": "1755E872-9092-4ECE-8386-860531D492D3",
"companyId": "21DA3F1A-E593-42EE-95F5-A22EDF6382F0",
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"garnishmentFields": {
"County": "Polk",
"Case Number": "9218729",
"Start Date": "2026-03-03",
"End Date": "2026-09-09",
"Total Withholding Amount": 1000,
"Frequency (Per)": "Weekly",
"Maximum Withholding Percentage": 0.1,
"Choose who will be paying the agency": "I want my payroll provider to make the payments"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
method: 'updateUserGarnishment',
userId: '1755E872-9092-4ECE-8386-860531D492D3',
companyId: '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
garnishmentId: '52F6249E-F4ED-40C2-B25F-39BB99BCF98D',
garnishmentFields: {
County: 'Polk',
'Case Number': '9218729',
'Start Date': '2026-03-03',
'End Date': '2026-09-09',
'Total Withholding Amount': 1000,
'Frequency (Per)': 'Weekly',
'Maximum Withholding Percentage': 0.1,
'Choose who will be paying the agency': 'I want my payroll provider to make the payments'
}
})
};
fetch('https://sandbox.rollfi.xyz/adminPortal/updateGarnishment', 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/updateGarnishment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'method' => 'updateUserGarnishment',
'userId' => '1755E872-9092-4ECE-8386-860531D492D3',
'companyId' => '21DA3F1A-E593-42EE-95F5-A22EDF6382F0',
'garnishmentId' => '52F6249E-F4ED-40C2-B25F-39BB99BCF98D',
'garnishmentFields' => [
'County' => 'Polk',
'Case Number' => '9218729',
'Start Date' => '2026-03-03',
'End Date' => '2026-09-09',
'Total Withholding Amount' => 1000,
'Frequency (Per)' => 'Weekly',
'Maximum Withholding Percentage' => 0.1,
'Choose who will be paying the agency' => 'I want my payroll provider to make the payments'
]
]),
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/updateGarnishment"
payload := strings.NewReader("{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.rollfi.xyz/adminPortal/updateGarnishment")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/adminPortal/updateGarnishment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"method\": \"updateUserGarnishment\",\n \"userId\": \"1755E872-9092-4ECE-8386-860531D492D3\",\n \"companyId\": \"21DA3F1A-E593-42EE-95F5-A22EDF6382F0\",\n \"garnishmentId\": \"52F6249E-F4ED-40C2-B25F-39BB99BCF98D\",\n \"garnishmentFields\": {\n \"County\": \"Polk\",\n \"Case Number\": \"9218729\",\n \"Start Date\": \"2026-03-03\",\n \"End Date\": \"2026-09-09\",\n \"Total Withholding Amount\": 1000,\n \"Frequency (Per)\": \"Weekly\",\n \"Maximum Withholding Percentage\": 0.1,\n \"Choose who will be paying the agency\": \"I want my payroll provider to make the payments\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"garnishmentId": "52F6249E-F4ED-40C2-B25F-39BB99BCF98D",
"message": "Update successful"
}{
"error": {
"code": 400,
"message": "Invalid CompanyId"
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Response
The response is of type object.
⌘I
