GET
/
reports#getStateW4FormFeilds
curl --request GET \
  --url 'https://sandbox.rollfi.xyz/reports#getStateW4FormFeilds' \
  --header 'Content-Type: application/json' \
  --data '{
  "method": "getStateW4Information",
  "userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB"
}'
{
  "summary": "Success",
  "value": {
    "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"
      }
    ]
  }
}

Body

application/json
method
string
required
Example:
["getStateW4FormFeilds"]
userId
string
required

Response

200 - application/json
employeeId
string
required
stateCode
string
required
stateW4FieldsList
object
required
fields
object[]
required