getTaxNameForExemption
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTaxNameForExemption \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTaxNameForExemption",
"companyId": "ECF1B47E-108F-45C0-A520-6A128A727B04",
"userId": "33820169-85C2-482A-BCCF-B2281419E96E"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTaxNameForExemption"
payload = {
"method": "getTaxNameForExemption",
"companyId": "ECF1B47E-108F-45C0-A520-6A128A727B04",
"userId": "33820169-85C2-482A-BCCF-B2281419E96E"
}
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: 'getTaxNameForExemption',
companyId: 'ECF1B47E-108F-45C0-A520-6A128A727B04',
userId: '33820169-85C2-482A-BCCF-B2281419E96E'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTaxNameForExemption', 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/getTaxNameForExemption",
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' => 'getTaxNameForExemption',
'companyId' => 'ECF1B47E-108F-45C0-A520-6A128A727B04',
'userId' => '33820169-85C2-482A-BCCF-B2281419E96E'
]),
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/getTaxNameForExemption"
payload := strings.NewReader("{\n \"method\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\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/getTaxNameForExemption")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTaxNameForExemption")
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\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\n}"
response = http.request(request)
puts response.read_body{
"EmployerTaxName": [
{
"taxName": "FL - State Unemployment Insurance",
"ExemptionStatus": "High Risk",
"warningMessage": "High-risk tax exemption. Confirm eligibility and effective dates before saving. If applied incorrectly, this may result in inaccurate reporting, tax underpayment, and required corrections."
},
{
"taxName": "FUTA",
"ExemptionStatus": "High Risk",
"warningMessage": "High-risk tax exemption. Confirm eligibility and effective dates before saving. If applied incorrectly, this may result in inaccurate reporting, tax underpayment, and required corrections."
},
{
"taxName": "WA - Industrial Insurance EE"
}
]
}{
"error": {
"code": 400,
"message": "companyId is required."
}
}Reports
getTaxNameForExemption
Retrieves the taxNames that can be added as exemptions for employees and companies
Note:
- Once retrieved use these taxNames with the
addPayrollTaxExemptionAPI - userId is optional, include it to find employee specific taxNames or omit it to find company taxNames
- Some taxes are returned with a
High Riskindicator and a warning message. This message should be displayed clearly on your UI to limit legal liability
GET
/
reports
/
getTaxNameForExemption
getTaxNameForExemption
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getTaxNameForExemption \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getTaxNameForExemption",
"companyId": "ECF1B47E-108F-45C0-A520-6A128A727B04",
"userId": "33820169-85C2-482A-BCCF-B2281419E96E"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getTaxNameForExemption"
payload = {
"method": "getTaxNameForExemption",
"companyId": "ECF1B47E-108F-45C0-A520-6A128A727B04",
"userId": "33820169-85C2-482A-BCCF-B2281419E96E"
}
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: 'getTaxNameForExemption',
companyId: 'ECF1B47E-108F-45C0-A520-6A128A727B04',
userId: '33820169-85C2-482A-BCCF-B2281419E96E'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getTaxNameForExemption', 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/getTaxNameForExemption",
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' => 'getTaxNameForExemption',
'companyId' => 'ECF1B47E-108F-45C0-A520-6A128A727B04',
'userId' => '33820169-85C2-482A-BCCF-B2281419E96E'
]),
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/getTaxNameForExemption"
payload := strings.NewReader("{\n \"method\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\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/getTaxNameForExemption")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getTaxNameForExemption")
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\": \"getTaxNameForExemption\",\n \"companyId\": \"ECF1B47E-108F-45C0-A520-6A128A727B04\",\n \"userId\": \"33820169-85C2-482A-BCCF-B2281419E96E\"\n}"
response = http.request(request)
puts response.read_body{
"EmployerTaxName": [
{
"taxName": "FL - State Unemployment Insurance",
"ExemptionStatus": "High Risk",
"warningMessage": "High-risk tax exemption. Confirm eligibility and effective dates before saving. If applied incorrectly, this may result in inaccurate reporting, tax underpayment, and required corrections."
},
{
"taxName": "FUTA",
"ExemptionStatus": "High Risk",
"warningMessage": "High-risk tax exemption. Confirm eligibility and effective dates before saving. If applied incorrectly, this may result in inaccurate reporting, tax underpayment, and required corrections."
},
{
"taxName": "WA - Industrial Insurance EE"
}
]
}{
"error": {
"code": 400,
"message": "companyId is required."
}
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Response
Show child attributes
Show child attributes
⌘I
