addStateW4Information

The addStateW4Information API is used to collect state-specific tax withholding information for employees in states that require additional withholding forms.

To retreive the state specific W4 fields use ‘getStateW4FormFields` with the userId

What it does:

• Collects state-specific withholding data
• Ensures compliance with state tax regulations

Note:

• This step is only required for employees in states with their own W-4 forms. Skip this step if the employee’s state doesn’t require additional withholding information.

POST /userOnboarding#addStateW4Information

addStateW4Information

cURL

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/userOnboarding#addStateW4Information' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addStateW4Information",
  "employeeId": "A31A0E84-3643-405A-B0E4-D229D0A194FB",
  "stateW4Information": {
    "Filing Status": "Married",
    "Withholding Allowance": "10",
    "Additional Withholding": "10.10",
    "NYC Withholding Allowance": "20",
    "NYC Additional Withholding": "14.00"
  }
}
'

200

1

{
  "stateW4Information": {
    "status": "Ready",
    "message": "The StateW4Information for Steve  Jobs has been saved successfully."
  }
}

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:

"addStateW4Information"

employeeId · string · required

stateW4Information · object · required

Show child attributes

Response

200

application/json

stateW4Information · object · required

Show child attributes