Change Employee - Payroll Tax
Use this service to import Employee Payroll Tax information.
Connection Info for POST
URL = https://<SPECTRUM-SERVER>:8482/employee/payrolltaximports
Authentication: Basic Authentication, Enhanced Authentication
Supported methods: POST
Supported formats: JSON
Sample JSON Body
{
"employeePayrollTaxImports": [{
"Company_Code": "2ND",
"Employee_Code": "VS123",
"Auto_Deposit_Allocation":"",
"Bank_Account_Number":"",
"Bank_Account_Type":"",
"ABA_Number":"",
"Auto_Deposit_Flag":"",
"Auto_Deposit_Rate1":"",
"Bank_Account_Number_2":"",
"Bank_Account_Type_2":"",
"ABA_Number_2":"",
"Auto_Deposit_Flag_2":"",
"Auto_Deposit_Rate2":"",
"Bank_Account_Number_3":"",
"Bank_Account_Type_3":"",
"ABA_Number_3":"",
"Auto_Deposit_Flag_3":"",
"Auto_Deposit_Rate3":"",
"Bank_Account_Number_4":"",
"Bank_Account_Type_4":"",
"ABA_Number_4":"",
"Auto_Deposit_Flag_4":"",
"Auto_Deposit_Rate4":"",
"Bank_Account_Number_5":"",
"Bank_Account_Type_5":"",
"ABA_Number_5":"",
"Auto_Deposit_Flag_5":"",
"Auto_Deposit_Rate5":"",
"Part_time_Casual_Flag":"",
"Billing_Code":"A",
"Special_Pay_Rate":"",
"Special_Pay_Amount":"",
"Misc_Allowance_Rate":"",
"Prevail_Wage_Fringe_Rate":"",
"Perm_wk_State_Tax_Code":"",
"Subject_to_Perm_wk_State_Tax":"",
"Subject_to_SDI_Perm_wk":"",
"Subject_to_SUTA_Perm_wk":"",
"Perm_wk_State_Filing_Status":"",
"Perm_wk_State_Exemptions":"",
"Perm_wk_State_Tax_Override":"10",
"Perm_wk_State_Tax_Override_Cont":"P",
"Res_County_Tax_Code":"BO",
"Subject_to_Res_County_Tax":"",
"Subject_to_FICA_Res_County":"",
"Subject_to_FUTA_Res_County":"",
"Res_County_Filing_Status":"",
"Res_County_Exemptions":"",
"Res_County_Tax_Override":"",
"Res_County_Tax_Override_Cont":"",
"Res_Local_Tax_Code":"WA",
"Subject_to_Res_Local_Tax":"E",
"Subject_to_FICA_Res_Local":"E",
"Subject_to_FUTA_Res_Local":"E",
"Res_Local_Filing_Status":"SINGLE",
"Res_Local_Exemptions":"",
"Res_Local_Tax_Override":"",
"Res_Local_Tax_Override_Cont":"",
"Permanent_Unemployment_State":"",
"Permanent_SDI_State":"",
"Apprentice_ID":"225",
"Apprentice_Wage_Percent":"",
"Summary_Post_Flag":"Y",
"Suppress_Post_Flag":"Y",
"Fed_Two_Jobs_Total": "Y",
"Fed_Dep_Claimed_Annually": "",
"Fed_Other_Annual_Income": "",
"Fed_Other_Annual_Deductions": "",
"Fed_Income_Tax_Override": "",
"Fed_Income_Tax_Override_Cont": ""
}]
}
Assumptions and Dependencies
- The Payroll module must be set up.
- The Employee code must exist in the defined Company code.
- The Change Employee - Payroll Tax Web Service updates an existing employee's information for the defined fields only.
- Any field that is left blank will not be updated in Spectrum.
- The service does not delete values that exist in Spectrum; it only changes data defined in the layout.
- The Auto deposit rates must equal 100% if the Auto Deposit Allocation Method is defined as Percent. Therefore if any changes are made, all accounts must be defined in the Employee-Payroll Tax Information Web Service.
- The Primary Account must be active (Y) if any other accounts have an active status. Therefore the Auto_Deposit_Flag field must be defined as Y in order for the other accounts to be updated.
- The Tax code must be unique between the Resident state, Perm work state, Resident county, and Resident local.
- The Permanent_Unemployment_State defined tax code is the permanent override for the Resident and Work State unemployment calculation.
- The defined tax code can be the same as the Resident state, Perm work state, Resident county, or Resident local.
- If it is defined, then the Permanently override resident and work state unemployment checkbox will be selected.
- The Permanent_SDI_State defined tax code is the permanent override for the Resident and Work State disability calculation.
- If it is defined, then the Permanently override resident and work state disability insurance (SDI) checkbox will be selected.
Field Descriptions
Use the table below for reference when using this service.
| Excel | Element Name | Description | Req | Type | Max | Format | Validation |
|---|---|---|---|---|---|---|---|
| Authorization_ID | Authorization ID to access the server | YES | Text | 20 | Data Exchange Installation Screen | ||
| GUID | Unique reference number created by programming | Text | 36 | ** See GUID definition | |||
| B | Company_Code | Company Code | YES | Text | 3 | Valid Company in Spectrum | |
| C | Employee_Code | Employee Code | YES | Text | 11 | Unique Identifier / No commas. | Employee Code must exist in the defined Company Code |
| D | Auto_Deposit_Allocation | Auto-Deposit Allocation Method | Text | 1 | (P)ercent or (F)ixed amount only | If Percent is defined then all Account Rates must total 100%. | |
| E | Bank_Account_Number | Primary Auto-Deposit Acct # | Text | 17 | |||
| F | Bank_Account_Type | Primary Auto-Deposit Acct Type | Text | 1 | (C)hecking or (S)avings only | ||
| G | ABA_Number | Primary Auto-Deposit Acct ABA # | Text | 9 | |||
| H | Auto_Deposit_Flag | Primary Auto-Deposit Acct Status | Text | 1 | (Y)es; (N)o or (P)re-notification only | The Primary Account must be active if any other accounts have an active status. | |
| I | Auto_Deposit_Rate1 | Primary Auto-Deposit Acct Rate | Numeric | 8 | If multiple Accounts exist then all Accounts must be defined to make changes. | If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%. | |
| J | Bank_Account_Number_2 | Second Auto-Deposit Acct | Text | 17 | |||
| K | Bank_Account_Type_2 | Second Auto-Deposit Acct Type | Text | 1 | (C)hecking or (S)avings only | ||
| L | ABA_Number_2 | Second Auto-Deposit Acct ABA # | Text | 9 | |||
| M | Auto_Deposit_Flag_2 | Second Auto-Deposit Acct Status | Text | 1 | (Y)es; (N)o or (P)re-notification only | The Primary Account must be active if any other accounts have an active status. | |
| N | Auto_Deposit_Rate2 | Second Auto-Deposit Acct Rate | Numeric | 8 | If multiple Accounts exist then all Accounts must be defined to make changes. | If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%. | |
| O | Bank_Account_Number_3 | Third Auto-Deposit Acct | Text | 17 | |||
| P | Bank_Account_Type_3 | Third Auto-Deposit Acct Type | Text | 1 | (C)hecking or (S)avings only | ||
| Q | ABA_Number_3 | Third Auto-Deposit Acct ABA # | Text | 9 | |||
| R | Auto_Deposit_Flag_3 | Third Auto-Deposit Acct Status | Text | 1 | (Y)es; (N)o or (P)re-notification only | The Primary Account must be active if any other accounts have an active status. | |
| S | Auto_Deposit_Rate3 | Third Auto-Deposit Acct Rate | Numeric | 8 | If multiple Accounts exist then all Accounts must be defined to make changes. | If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%. | |
| T | Bank_Account_Number_4 | Fourth Auto-Deposit Acct | Text | 17 | |||
| U | Bank_Account_Type_4 | Fourth Auto-Deposit Acct Type | Text | 1 | (C)hecking or (S)avings only | ||
| V | ABA_Number_4 | Fourth Auto-Deposit Acct ABA # | Text | 9 | |||
| W | Auto_Deposit_Flag_4 | Fourth Auto-Deposit Acct Status | Text | 1 | (Y)es; (N)o or (P)re-notification only | The Primary Account must be active if any other accounts have an active status. | |
| X | Auto_Deposit_Rate4 | Fourth Auto-Deposit Acct Rate | Numeric | 8 | If multiple Accounts exist then all Accounts must be defined to make changes. | If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%. | |
| Y | Bank_Account_Number_5 | Fifth Auto-Deposit Acct | Text | 17 | |||
| Z | Bank_Account_Type_5 | Fifth Auto-Deposit Acct Type | Text | 1 | (C)hecking or (S)avings only | ||
| AA | ABA_Number_5 | Fifth Auto-Deposit Acct ABA # | Text | 9 | |||
| AB | Auto_Deposit_Flag_5 | Fifth Auto-Deposit Acct Status | Text | 1 | (Y)es; (N)o or (P)re-notification only | The Primary Account must be active if any other accounts have an active status. | |
| AC | Auto_Deposit_Rate5 | Fifth Auto-Deposit Acct Rate | Numeric | 8 | If multiple Accounts exist then all Accounts must be defined to make changes. | If Percent is defined in field name Auto_Deposit_Allocation then all Account Rates must total 100%. | |
| AD | Part_time_Casual_Flag | Part-Time? | Text | 1 | (Y)es or (N)o only (if left blank; this flag will default to 'no' in Spectrum). This is an option to exclude the Employee from Automatic Pay Cycle. | ||
| AE | Billing_Code | T&M Billing Code | Text | 10 | T&M Billing Code Maintenance | ||
| AF | Special_Pay_Rate | Special Pay Rate | Numeric | 7 | Positive number only. | ||
| AG | Special_Pay_Amount | Special Pay Amount | Numeric | 7 | Positive number only. | ||
| AH | Misc_Allowance_Rate | Misc Allow Amount | Numeric | 7 | Positive number only. | ||
| AI | Prevail_Wage_Fringe_Rate | Prevailing Wage Fringe Employer Benefit | Numeric | 7 | Positive number only. | ||
| AJ | Perm_wk_State_Tax_Code | Perm Work State Tax Table Code | Text | 10 | The Tax code must be unique between the Resident State, Perm Work State, Resident County and Resident Local. | Payroll Tax Table Maintenance | |
| AK | Subject_to_Perm_wk_State_Tax | Subject to Perm Work State Income Tax | Text | 1 | (E)xempt or (T)axable only. Required if field name Perm_wk_State_Tax_Code is not blank. | ||
| AL | Subject_to_SDI_Perm_wk | Subject to Perm Work State SDI | Text | 1 | (E)xempt or (T)axable only. Required if field name Perm_wk_State_Tax_Code is not blank. | ||
| AM | Subject_to_SUTA_Perm_wk | Subject to Perm Work State Unemployment | Text | 1 | (E)xempt or (T)axable only. Required if field name Perm_wk_State_Tax_Code is not blank. | ||
| AN | Perm_wk_State_Filing_Status | Perm Work State Filing Status | Text | 20 | If Subject_to_Perm_wk_State_Tax = T then this field is required. | Payroll Tax Table Maintenance | |
| AO | Perm_wk_State_Exemptions | # Exemptions for Perm Work State Income Tax | Numeric | 5 | |||
| AP | Perm_wk_State_Tax_Override | Amount of Perm Work State Income Tax Override | Numeric | 7 | |||
| AQ | Perm_wk_State_Tax_Override_Cont | Perm Work State Income Tax Override | Text | 1 | (F)ixed; (P)ercent; (A)dd-on only | ||
| AR | Res_County_Tax_Code | Resident County Tax Table Code | Text | 10 | The Tax code must be unique between the Resident State, Perm Work State, Resident County and Resident Local. | Payroll Tax Table Maintenance | |
| AS | Subject_to_Res_County_Tax | Subject to Resident County Income Tax | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_County_Tax_Code is not blank. | ||
| AT | Subject_to_FICA_Res_County | Subject to Resident County FICA | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_County_Tax_Code is not blank. | ||
| AU | Subject_to_FUTA_Res_County | Subject to Resident County Unemployment | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_County_Tax_Code is not blank. | ||
| AV | Res_County_Filing_Status | Resident County Filing Status | Text | 20 | If Subject_to_Res_County_Tax = T then this field is required. | Payroll Tax Table Maintenance | |
| AW | Res_County_Exemptions | # Exemptions for Resident County Income Tax | Numeric | 5 | |||
| AX | Res_County_Tax_Override | Amount of Resident County Income Tax Override | Numeric | 7 | |||
| AY | Res_County_Tax_Override_Cont | Resident County Income Tax Override Control | Text | 1 | (F)ixed; (P)ercent; (A)dd-on only | ||
| AZ | Res_Local_Tax_Code | Resident Local Tax Table Code | Text | 10 | The Tax code must be unique between the Resident State, Perm Work State, Resident County and Resident Local. | Payroll Tax Table Maintenance | |
| BA | Subject_to_Res_Local_Tax | Subject to Resident Local Income Tax | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_Local_Tax_Code is not blank. | ||
| BB | Subject_to_FICA_Res_Local | Subject to Resident Local FICA | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_Local_Tax_Code is not blank. | ||
| BC | Subject_to_FUTA_Res_Local | Subject to Resident Local Unemployment | Text | 1 | (E)xempt or (T)axable only. Required if field name Res_Local_Tax_Code is not blank. | ||
| BD | Res_Local_Filing_Status | Resident Local Filing Status | Text | 20 | If Subject_to_Res_Local_Tax = T then this field is required | Payroll Tax Table Maintenance | |
| BE | Res_Local_Exemptions | # Exemptions for Resident Local Income Tax | Numeric | 5 | |||
| BF | Res_Local_Tax_Override | Amount of Resident Local Income Tax Override | Numeric | 7 | |||
| BG | Res_Local_Tax_Override_Cont | Resident Local Income Tax Override Control | Text | 1 | (F)ixed; (P)ercent; or (A)dd-on only | ||
| BH | Permanent_Unemployment_State | Unemployment state (Permanent Override for resident and work state) | Text | 10 | This Tax code can be the same as a Resident State, Perm Work State, Resident County or the Resident Local. | Payroll Tax Table Maintenance | |
| BI | Permanent_SDI_State | Disability insurance state (Permanent Override for resident and work state) | Text | 10 | Payroll Tax Table Maintenance | ||
| BJ | Apprentice_ID | Apprentice program ID # | Text | 20 | |||
| BK | Apprentice_Wage_Percent | Wage % | Numeric | 6 | Format = xxx.xx Positive numbers only and cannot exceed 100. If defined then Apprenctice_ID is required. | ||
| BL | Summary_Post_Flag | Post in summary to job and equipment history (confidential employee)? | Text | 1 | (Y)es or (N)o only. If left blank then defaults to N. Field is not available in a Confidential Payroll Company. | ||
| BM | Suppress_Post_Flag | Also suppress employee's hours in job and equipment history | Text | 1 | Summary_Post_Flag must = Y in order to define. (Y)es or (N)o only. If left blank then defaults to N. Field is not available in a Confidential Payroll Company. | ||
| BN | Fed_Two_Jobs_Total | Two jobs in total? | Text | 1 | (Y)es = Selected, Blank or (N)o = Not selected | ||
| BO | Fed_Dep_Claimed_Annually | Dependents claimed annually | Numeric | 6.2 | |||
| BP | Fed_Other_Annual_Income | Other annual income | Numeric | 6.2 | |||
| BQ | Fed_Other_Annual_Deductions | Other annual deductions | Numeric | 6.2 | |||
| BR | Fed_Income_Tax_Override | Federal income tax override | Numeric | 4.2 | |||
| BS | Fed_Income_Tax_Override_Cont | Federal income tax override control | Text | 1 | (F)ixed, (P)ercent, (A)dd-on only |