addEmployeeMiscellaneousStateTax

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/adminPortal#addEmployeeMiscellaneousStateTax' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addEmployeeMiscellaneousStateTax",
  "companyId": "7440E812-C699-4A94-AE14-A4B788D83299",
  "userId": "98CCB6CF-08DD-4C17-A367-B339CD5526CD",
  "employeeMiscellaneousStateTax": {
    "CompositeRate": "5",
    "RiskClassName": "Painter",
    "RiskClassCode": "121212",
    "PayrollDeductionRate": "4"
  }
}
'

{
  "employeeMiscellaneousStateTax": {
    "status": "Ready",
    "message": "The Employee Miscellaneous State Tax Information has been saved successfully."
  }
}

Admin Portal

addEmployeeMiscellaneousStateTax

The addEmployeeMiscellaneousStateTax API is used to collect state-specific tax withholding information for employees in states that require profession/job specific taxes

What it does:

Used when a state tax does not apply to all employees within the state, but to a select few professions/jobs

Notes:

This step is only required for employees subjest to state taxes not covered in the standard W4 import. Skip this step if the employee is not subject to miscellaneous taxes.
“CompositeRate” cannot be less than “PayrollDeductionRate”.
A user’s MiscellaneousStateTaxes can be seen in getUsers and getUser APIs.
After adding MiscellaneousStateTaxes, use getEmployeeMiscellaneousStateTaxforPayroll to retrieve the exact object to add the taxes to payroll.

POST

adminPortal#addEmployeeMiscellaneousStateTax

addEmployeeMiscellaneousStateTax

curl --request POST \
  --url 'https://sandbox.rollfi.xyz/adminPortal#addEmployeeMiscellaneousStateTax' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "addEmployeeMiscellaneousStateTax",
  "companyId": "7440E812-C699-4A94-AE14-A4B788D83299",
  "userId": "98CCB6CF-08DD-4C17-A367-B339CD5526CD",
  "employeeMiscellaneousStateTax": {
    "CompositeRate": "5",
    "RiskClassName": "Painter",
    "RiskClassCode": "121212",
    "PayrollDeductionRate": "4"
  }
}
'

{
  "employeeMiscellaneousStateTax": {
    "status": "Ready",
    "message": "The Employee Miscellaneous State Tax Information 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

companyId

string

required

userId

string

required

employeeMiscellaneousStateTax

object

required

Show child attributes

Response

The response is of type object.

DeleteStateRegistration terminateUser

API Reference

Documentation Index

Authorizations

Body

Response