Reports
getStateW4FormFeilds
API Reference
- Company Onboarding
- User Onboarding
- Admin Portal
- User Portal
- Payroll
- Benefits
- Reports
- GETgetBusinessUserInfo
- GETgetUserTask
- GETgetUsersByCompanyName
- GETgetCompanies
- GETgetPaidEmployeesCountBasedOnDateRange
- GETgetPayPeriodDetails
- GETgetPayPeriod
- GETgetCompanyInfo
- GETgetCompanyLocationInfo
- GETgetActiveUsers
- GETgetTerminatedUsers
- GETgetDeactivatedUsers
- GETgetPayrollHistoryBasedOnPayPeriod
- GETgetPayrollHistoryBasedOnDateRange
- GETgetPayRun
- GETgetPaySchedule
- GETgetPayStub
- GETgetTransactionBasedOnReference
- GETgetTransactions
- GETgetTransactionsBasedOnName
- GETgetBusinessUserDetails
- GETgetStateW4FormFeilds
- GETgetPayrollJournalReport
- GETgetUser
- GETgetPayBeginDates
- GETgetStateRegistration
- GETgetIndividualPayrollHistory
- GET
- Webhooks
Reports
getStateW4FormFeilds
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"
}'
{
"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
Response
200 - application/json
The response is of type object
.
curl --request GET \
--url 'https://sandbox.rollfi.xyz/reports#getStateW4FormFeilds' \
--header 'Content-Type: application/json' \
--data '{
"method": "getStateW4Information",
"userId": "A31A0E84-3643-405A-B0E4-D229D0A194FB"
}'
{
"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"
}
]
}