getGarnishmentTypes
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentTypes \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentTypes"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentTypes"
payload = { "method": "getGarnishmentTypes" }
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: 'getGarnishmentTypes'})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentTypes', 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/getGarnishmentTypes",
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' => 'getGarnishmentTypes'
]),
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/getGarnishmentTypes"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentTypes\"\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/getGarnishmentTypes")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentTypes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentTypes")
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\": \"getGarnishmentTypes\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentTypes": [
"Administrative",
"Bankruptcy",
"Child Support",
"Federal Tax Lien",
"Other Garnishment",
"State Tax Lien",
"Student Loan",
"Voluntary Wage"
]
}Garnishments
getGarnishmentTypes
The getGarnishmentTypes API retrieves the available garnishments you can add to an employee
When to use:
- When a garnishment is necessary for an employee
- Used to populate a dropdown of garnishment types to use in
addGarnishments
Note:
- Type can be used to retrieve available agencies if applicable using
getGarnishmentAgencies - Use these garnishmentTypes to retrieve the fields using
getGarnishmentFormFields
GET
/
reports
/
getGarnishmentTypes
getGarnishmentTypes
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getGarnishmentTypes \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getGarnishmentTypes"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getGarnishmentTypes"
payload = { "method": "getGarnishmentTypes" }
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: 'getGarnishmentTypes'})
};
fetch('https://sandbox.rollfi.xyz/reports/getGarnishmentTypes', 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/getGarnishmentTypes",
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' => 'getGarnishmentTypes'
]),
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/getGarnishmentTypes"
payload := strings.NewReader("{\n \"method\": \"getGarnishmentTypes\"\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/getGarnishmentTypes")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getGarnishmentTypes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getGarnishmentTypes")
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\": \"getGarnishmentTypes\"\n}"
response = http.request(request)
puts response.read_body{
"garnishmentTypes": [
"Administrative",
"Bankruptcy",
"Child Support",
"Federal Tax Lien",
"Other Garnishment",
"State Tax Lien",
"Student Loan",
"Voluntary Wage"
]
}⌘I
