Property | Value | Description | Notes |
---|---|---|---|
worksite_id | integer | The id of the employee worksite | writable |
federal_status | enum |
The federal marital status of the employee.
1 - Single 2 - Married |
writable |
federal_allowances | integer | The number of the employee's federal allowances. | writable |
fica_exempt | enum |
Indicates if the employee is FICA exempt.
0 - False 1 - True |
writable |
fit_exempt | enum |
Indicates if the employee is FIT exempt.
0 - False 1 - True |
writable |
fit_additional_amount | decimal | Additional FIT wittholding for the employee. | writable |
sdi_exempt | enum |
Indicates if the employee is SDI exempt.
0 - False 1 - True |
writable |
sit_exempt | enum |
Indicates if the employee is SIT exempt.
0 - False 1 - True |
writable |
sit_additional_amount | decimal | Additional SIT withholding for the employee. | writable |
state_resident | enum |
Indicates if the employee is a resident of the work state.
0 - False 1 - True |
writable |
state_misc_1_value | mixed | Dependent on employee tax state. | writable |
state_misc_2_value | mixed | Dependent on employee tax state. | writable |
state_misc_3_value | mixed | Dependent on employee tax state. | writable |
state_misc_4_value | mixed | Dependent on employee tax state. | writable |
work_location_display_fields | object | Contains information on how to display tax fields for the employee's tax state(s). |
The tax-fields response tells you not only the values of the state tax fields, but also reveals what each field represents for that state in display_fields.
{
"worksite_id": 1,
"federal_status": 1,
"federal_allowances": 0,
"fica_exempt": "",
"fit_exempt": 0,
"fit_additional_amount": "0.00",
"work_location_display_fields": {
"state_information": {
"name": "California"
},
"display_fields": {
"state_misc_1_value": {
"label": "Filing Status",
"enum": [
"S",
"M",
"H"
],
"type": "select",
"options": [
{
"label": "Single or Married with Dual Employers",
"value": "S"
},
{
"label": "Married filing Jointly",
"value": "M"
},
{
"label": "Unmarried Head of Household",
"value": "H"
}
],
"required": true
},
"state_misc_3_value": {
"label": "Regular Allowances",
"pattern": "^\\d{0,6}$",
"type": "text",
"required": false
},
"state_misc_2_value": {
"label": "Additional Allowances",
"pattern": "^\\d{0,6}$",
"type": "text",
"required": false
},
"sit_additional_amount": {
"label": "Additional Withholding",
"pattern": "^\\d{0,6}(\\.\\d{1,6})?$",
"type": "text",
"required": false
},
"sdi_exempt": {
"label": "SDI Exempt",
"enum": [
"0",
"1"
],
"type": "radio",
"options": [
{
"label": "True",
"value": "1"
},
{
"label": "False",
"value": "0"
}
],
"required": true
},
"state_misc_4_value": {
"label": "Use Supplemental Bonus Rate",
"enum": [
"",
"BONUS"
],
"type": "radio",
"options": [
{
"label": "True",
"value": "BONUS"
},
{
"label": "False",
"value": ""
}
],
"required": true
},
"sit_exempt": {
"label": "Exempt From State Withholding",
"enum": [
"0",
"1"
],
"type": "radio",
"options": [
{
"label": "True",
"value": "1"
},
{
"label": "False",
"value": "0"
}
],
"required": true
},
"state_resident": {
"label": "State Resident",
"enum": [
"0",
"1"
],
"type": "radio",
"options": [
{
"label": "True",
"value": "1"
},
{
"label": "False",
"value": "0"
}
],
"required": true
}
}
},
"state_misc_1_value": "S",
"state_misc_3_value": "",
"state_misc_2_value": "",
"sit_additional_amount": 0,
"sdi_exempt": 0,
"state_misc_4_value": "",
"sit_exempt": 0,
"state_resident": 1
}