getStateW4FormFeilds

The getStateW4FormFeilds 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
• Used before calling addStateW4Information to get the required fields for that state

GET /reports#getStateW4FormFeilds

getStateW4FormFeilds

cURL

curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getStateW4FormFeilds' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "getStateW4FormFeilds",
  "userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB"
}
'

200

{
  "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

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

method · string · required

Example:

"getStateW4FormFeilds"

userId · string · required

Response

200 - application/json

employeeId · string · required

stateCode · string · required

stateW4FieldsList · object · required

Show child attributes

fields · object[] · required

Show child attributes