getGarnishmentFormFields
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentFormFields",
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida Child Support Enforcement"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields"
payload = {
"method": "getGarnishmentFormFields",
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida Child Support Enforcement"
}
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: 'getGarnishmentFormFields',
garnishmentType: 'Child Support',
garnishmentAgency: 'Florida Child Support Enforcement'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields', 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/getGarnishmentFormFields",
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' => 'getGarnishmentFormFields',
'garnishmentType' => 'Child Support',
'garnishmentAgency' => 'Florida Child Support Enforcement'
]),
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/getGarnishmentFormFields"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\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/getGarnishmentFormFields")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields")
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\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida CSE",
"garnishmentFieldList": [
"County",
"Choose who will be paying the agency",
"Case Number",
"Start Date",
"End Date",
"Total Withholding Amount",
"Frequency (Per)",
"Expected Amount Per Pay Period",
"Maximum Withholding Percentage"
],
"fieldDescription": [
{
"fieldName": "County",
"isMandatory": false,
"dataType": "String",
"options": [
"Alachua",
"Baker",
"Bay",
"Bradford",
"Brevard",
"Broward",
"Calhoun",
"Charlotte",
"Citrus",
"Clay",
"Collier",
"Columbia",
"DeSoto",
"Dixie",
"Duval",
"Escambia",
"Flagler",
"Florida Statewide",
"Franklin",
"Gadsden",
"Gilchrist",
"Glades",
"Gulf",
"Hamilton",
"Hardee",
"Hendry",
"Hernando",
"Highlands",
"Hillsborough",
"Holmes",
"Indian River",
"Jackson",
"Jefferson",
"Lafayette",
"Lake",
"Lee",
"Leon",
"Levy",
"Liberty",
"Madison",
"Manatee",
"Marion",
"Martin",
"Miami-Dade",
"Monroe",
"Nassau",
"Okaloosa",
"Okeechobee",
"Orange",
"Osceola",
"Palm Beach",
"Pasco",
"Pinellas",
"Polk",
"Putnam",
"Santa Rosa",
"Sarasota",
"Seminole",
"St. Johns",
"St. Lucie",
"Sumter",
"Suwannee",
"Taylor",
"Union",
"Volusia",
"Wakulla",
"Walton",
"Washington"
]
},
{
"fieldName": "Choose who will be paying the agency",
"isMandatory": false,
"dataType": "String",
"options": [
"I want my payroll provider to make the payments",
"I will make the payments myself"
]
},
{
"fieldName": "Case Number",
"isMandatory": false,
"dataType": "String"
},
{
"fieldName": "Start Date",
"isMandatory": false,
"dataType": "Date"
},
{
"fieldName": "End Date",
"isMandatory": false,
"dataType": "Date"
},
{
"fieldName": "Total Withholding Amount",
"isMandatory": false,
"dataType": "Decimal"
},
{
"fieldName": "Frequency (Per)",
"isMandatory": false,
"dataType": "String",
"options": [
"Weekly"
]
},
{
"fieldName": "Expected Amount Per Pay Period",
"isMandatory": false,
"dataType": "Decimal"
},
{
"fieldName": "Maximum Withholding Percentage",
"isMandatory": false,
"dataType": "Decimal"
}
]
}{
"error": {
"code": 404,
"message": "No garnishment agency found matching Bankruptcy Agency."
}
}Garnishments
getGarnishmentFormFields
The getGarnishmentFormFields API retrieves the form fields for a particular garnishment and agency
When to use:
- To determine the necessary fields to add an employee garnishment
Note:
- Agency specific fields are currently only supported for child support
Direct Agency Payment Scope:
- Rollfi can only pay agencies directly for
Child Supportgarnishments. - Direct agency payment for child support is available in 49 states (all except South Carolina (SC)).
GET
/
reports
/
getGarnishmentFormFields
getGarnishmentFormFields
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentFormFields",
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida Child Support Enforcement"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields"
payload = {
"method": "getGarnishmentFormFields",
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida Child Support Enforcement"
}
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: 'getGarnishmentFormFields',
garnishmentType: 'Child Support',
garnishmentAgency: 'Florida Child Support Enforcement'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields', 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/getGarnishmentFormFields",
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' => 'getGarnishmentFormFields',
'garnishmentType' => 'Child Support',
'garnishmentAgency' => 'Florida Child Support Enforcement'
]),
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/getGarnishmentFormFields"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\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/getGarnishmentFormFields")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentFormFields")
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\": \"getGarnishmentFormFields\",\n \"garnishmentType\": \"Child Support\",\n \"garnishmentAgency\": \"Florida Child Support Enforcement\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentType": "Child Support",
"garnishmentAgency": "Florida CSE",
"garnishmentFieldList": [
"County",
"Choose who will be paying the agency",
"Case Number",
"Start Date",
"End Date",
"Total Withholding Amount",
"Frequency (Per)",
"Expected Amount Per Pay Period",
"Maximum Withholding Percentage"
],
"fieldDescription": [
{
"fieldName": "County",
"isMandatory": false,
"dataType": "String",
"options": [
"Alachua",
"Baker",
"Bay",
"Bradford",
"Brevard",
"Broward",
"Calhoun",
"Charlotte",
"Citrus",
"Clay",
"Collier",
"Columbia",
"DeSoto",
"Dixie",
"Duval",
"Escambia",
"Flagler",
"Florida Statewide",
"Franklin",
"Gadsden",
"Gilchrist",
"Glades",
"Gulf",
"Hamilton",
"Hardee",
"Hendry",
"Hernando",
"Highlands",
"Hillsborough",
"Holmes",
"Indian River",
"Jackson",
"Jefferson",
"Lafayette",
"Lake",
"Lee",
"Leon",
"Levy",
"Liberty",
"Madison",
"Manatee",
"Marion",
"Martin",
"Miami-Dade",
"Monroe",
"Nassau",
"Okaloosa",
"Okeechobee",
"Orange",
"Osceola",
"Palm Beach",
"Pasco",
"Pinellas",
"Polk",
"Putnam",
"Santa Rosa",
"Sarasota",
"Seminole",
"St. Johns",
"St. Lucie",
"Sumter",
"Suwannee",
"Taylor",
"Union",
"Volusia",
"Wakulla",
"Walton",
"Washington"
]
},
{
"fieldName": "Choose who will be paying the agency",
"isMandatory": false,
"dataType": "String",
"options": [
"I want my payroll provider to make the payments",
"I will make the payments myself"
]
},
{
"fieldName": "Case Number",
"isMandatory": false,
"dataType": "String"
},
{
"fieldName": "Start Date",
"isMandatory": false,
"dataType": "Date"
},
{
"fieldName": "End Date",
"isMandatory": false,
"dataType": "Date"
},
{
"fieldName": "Total Withholding Amount",
"isMandatory": false,
"dataType": "Decimal"
},
{
"fieldName": "Frequency (Per)",
"isMandatory": false,
"dataType": "String",
"options": [
"Weekly"
]
},
{
"fieldName": "Expected Amount Per Pay Period",
"isMandatory": false,
"dataType": "Decimal"
},
{
"fieldName": "Maximum Withholding Percentage",
"isMandatory": false,
"dataType": "Decimal"
}
]
}{
"error": {
"code": 404,
"message": "No garnishment agency found matching Bankruptcy Agency."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
⌘I
