getStateW4FormFields
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getStateW4FormFields \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getStateW4FormFields",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "CA"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getStateW4FormFields"
payload = {
"method": "getStateW4FormFields",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "CA"
}
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: 'getStateW4FormFields',
userId: 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
stateCode: 'CA'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getStateW4FormFields', 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/getStateW4FormFields",
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' => 'getStateW4FormFields',
'userId' => 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
'stateCode' => 'CA'
]),
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/getStateW4FormFields"
payload := strings.NewReader("{\n \"method\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\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/getStateW4FormFields")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getStateW4FormFields")
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\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\n}"
response = http.request(request)
puts response.read_body{
"employeeId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "NY",
"stateW4FieldsList": {
"Filing Status": "",
"Withholding Allowance": "",
"Additional Withholding": "",
"NYC Withholding Allowance": "",
"NYC Additional Withholding": ""
},
"fields": [
{
"fieldName": "Filing Status",
"fieldDescription": "In most cases, use the same filing status that you used on your federal return. If unsure, read the official NY filing status definition(\"https://www.tax.ny.gov/pit/file/filing_status.htm/\")",
"options": [
"Married, but withhold as single",
"Married",
"Single"
]
},
{
"fieldName": "Withholding Allowance",
"fieldDescription": null,
"dataType": "Number"
},
{
"fieldName": "Additional Withholding",
"fieldDescription": null,
"dataType": "Double"
},
{
"fieldName": "NYC Withholding Allowance",
"fieldDescription": null,
"dataType": "Number"
},
{
"fieldName": "NYC Additional Withholding",
"fieldDescription": null,
"dataType": "Double"
}
]
}Reports
getStateW4FormFields
The getStateW4FormFields API retrieves state-specific W4 form fields for an employee based on their location.
What it does:
- Returns state-specific W4 form fields and their available options
- Provides field descriptions for state tax withholding forms (e.g. Married, Single etc.)
- Provides data type restrictions for W4 fields to prevent input error
Notes:
- Employees state is determined using their userId
- userId or stateCode is required to retrieve the correct fields for the state
- Used before calling
addStateW4Informationto get the required fields for that state
GET
/
reports
/
getStateW4FormFields
getStateW4FormFields
curl --request GET \
--url https://sandbox.rollfi.xyz/reports/getStateW4FormFields \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"method": "getStateW4FormFields",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "CA"
}
'import requests
url = "https://sandbox.rollfi.xyz/reports/getStateW4FormFields"
payload = {
"method": "getStateW4FormFields",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "CA"
}
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: 'getStateW4FormFields',
userId: 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
stateCode: 'CA'
})
};
fetch('https://sandbox.rollfi.xyz/reports/getStateW4FormFields', 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/getStateW4FormFields",
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' => 'getStateW4FormFields',
'userId' => 'A31A0E84-3643-405A-B0E4-D229D0A194FB',
'stateCode' => 'CA'
]),
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/getStateW4FormFields"
payload := strings.NewReader("{\n \"method\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\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/getStateW4FormFields")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"method\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.rollfi.xyz/reports/getStateW4FormFields")
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\": \"getStateW4FormFields\",\n \"userId\": \"A31A0E84-3643-405A-B0E4-D229D0A194FB\",\n \"stateCode\": \"CA\"\n}"
response = http.request(request)
puts response.read_body{
"employeeId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
"stateCode": "NY",
"stateW4FieldsList": {
"Filing Status": "",
"Withholding Allowance": "",
"Additional Withholding": "",
"NYC Withholding Allowance": "",
"NYC Additional Withholding": ""
},
"fields": [
{
"fieldName": "Filing Status",
"fieldDescription": "In most cases, use the same filing status that you used on your federal return. If unsure, read the official NY filing status definition(\"https://www.tax.ny.gov/pit/file/filing_status.htm/\")",
"options": [
"Married, but withhold as single",
"Married",
"Single"
]
},
{
"fieldName": "Withholding Allowance",
"fieldDescription": null,
"dataType": "Number"
},
{
"fieldName": "Additional Withholding",
"fieldDescription": null,
"dataType": "Double"
},
{
"fieldName": "NYC Withholding Allowance",
"fieldDescription": null,
"dataType": "Number"
},
{
"fieldName": "NYC Additional Withholding",
"fieldDescription": null,
"dataType": "Double"
}
]
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
⌘I
