[{TableOfContents }]
!!!US PAY RUN INTERFACE FILE
The US Pay Run Interface File screen is used to import the rules for employee taxation into the software data structures.
US Pay Run Interface File data is maintained on the [INF_CV_USPAYRULES] table.
\\
----
!!Tab 1
;[ID|ID]:This field uniquely identifies the US pay run record within the data base.
;[Entity|ENTITY_CODE]:This field identifies the entity associated with the pay rule.
;[Person Code|PERSON_CODE]:This field identifies the person associated with the pay rule.
;[Employment Type|EMPLOYMENT_TYPE]:The person's employment type is displayed in this field.
;[Date of Hire|HIRE_DATE]:The employee's date of hire is displayed in this field.
;[Country Name|COUNTRY_CODE]:The entity's associated country is displayed in this field.
;[State, Country|STATE_PROVINCE_CODE]:The entity's associated state or province is displayed in this field.
;[Tax Jurisdiction|GEO_CODE]:This field holds the GEO code of the city, county or state used for taxation purposes.
;[Description|DESCRIPTION]:A quick description of the pay run is provided in this field.
;[Effective as of|EFFECTIVE]/[Expires On|EXPIRY]:If the employment is for a limited time, that time period is defined in these fields.
;[Change Reason|CHANGE_CODE]:This field displays the ‘Change Reason’ code, which provides the rationale as to why information has been created or changed as of an effective date.
;[Fed Number of Exemptions|UFED_NUM_EXEMPTIONS]:
;[Fed Annual Exemption|UFED_ANN_EXEMPTION]:
;[Fed Add'l Exemption|UFED_ADD_EXEMPTION]:
;[Fed Add'l Tax Per Period|UFED_ADD_TAX_PER_PERIOD]:
;[Fed Tax Amount|UFED_TAX_AMOUNT]:
;[Fed Tax %|UFED_TAX_PERCENT]:
;[Fed Tax Method|UFED_TAX_METHOD]:This field specifies the federal tax method for this employee.
\\
----
!!Tab 2
;[Fed Suppl Tax Method|UFED_SUPPL_TAX_METHOD]:This field specifies the Federal supplemental tax method for this employee.
;[Fed FICA Method|UFED_FICA_METHOD]:This field specifies the calculation method for FICA.
;[Fed Medicare Method|UFED_MEDICARE_METHOD]:This field specifies the calculation method for the Medicare portion of the FICA.
;[Fed FUTA Method|UFED_FUTA_METHOD]:This field specifies the calculation method for FUTA.
;[Fed EIC Method|UFED_EIC_METHOD]:This field specifies the calculation method for employee Earned Income Credit.
;[State Reciprocity Agreement|UST_RECIPROCATION]:This field indicates if the employee has filed a ‘Non-Residency Certificate’ with the employer and therefore the state tax is to be calculated by the certificate.
;[State Filing Status|UST_FILING_STATUS]:This field provides a valid filing status for state tax calculation.
;[State Number of Exemptions|UST_NUM_EXEMPTION_1]:
;[State Number of Exemptions 2|UST_NUM_EXEMPTION_2]:
;[State Annual Exemptions|UST_ANN_EXEMPTION]:
;[State Add'l Exemption|UST_ADD_EXEMPTION]:
;[State Add'l Tax Per Period|UST_ADD_TAX_PER_PERIOD]:
;[State Add'l Tax For Residence|UST_ADD_TAX_RES]:
;[State Add'l Tax|UST_ADD_TAX_WORK]:
;[State Tax Amount|UST_TAX_AMOUNT]:
;[State Tax Percent|UST_TAX_PERCENT]:
;[State Tax Method|UST_TAX_METHOD]:
;[State Suppl Tax Method|UST_SUPPL_TAX_METHOD]:
;[State Alternate Tax Method|UST_ALT_TAX_METHOD]:
;[State SUI EE Method|UST_SUI_EE_METHOD]:
\\
----
!!Tab 3
;[State SUI ER Method|UST_SUI_ER_METHOD]:
;[State SUI EE Method|UST_SDI_EE_METHOD]:
;[State SDI ER Method|UST_SDI_ER_METHOD]:
;[State WC Method|UST_WCB_METHOD]:
;[Local Reciprocity Agreement|ULOC_RECIPROCATION]:
;[Local Filing Status|ULOC_FILING_STATUS]:
;[Local Number of Exemptions|ULOC_NUM_EXEMPTIONS]:
;[Local Annual Exemption|ULOC_ANN_EXEMPTION]:
;[Local Exemption %|ULOC_EXEMPTION_PERCENT]:
;[Local Add'l Tax for Pay Period|ULOC_ADD_TAX_PER_PERIOD]:
;[Local Add'l Tax for Work|ULOC_ADD_TAX_WORK]:
;[Local Add'l Tax for Residence|ULOC_ADD_TAX_RES]:
;[Local Tax Amount|ULOC_TAX_AMOUNT]:
;[Local Tax % 1|ULOC_TAX_PERCENT_1]:
;[Local Tax % 2|ULOC_TAX_PERCENT_2]:
;[County Tax Method|ULOC_COUNTY_TAX_METHOD]:
;[City Tax Method|ULOC_CITY_TAX_METHOD]:
;[School Tax Method|ULOC_SCHOOL_TAX_METHOD]:
;[School Tax Amount|ULOC_SCHOOL_TAX_AMOUNT]:
;[School Tax Percent|ULOC_SCHOOL_TAX_PERCENT]:
\\
----
!!Tab 4
;[Head Tax Method|ULOC_HEAD_TAX_METHOD]:
;[Head Tax Amount|ULOC_HEAD_TAX_AMOUNT]:
;[UST EIC Method|UST_EIC_METHOD]:
[{If var='loginstatus' contains 'authenticated'
----
![Discussion|Edit:Internal.IVPPRU]
[{InsertPage page='Internal.IVPPRU' default='Click to create a new discussion page'}]
}]
!!Federal tab
;[Filing Status|UFED_FILING_STATUS]:The Federal Filing Status indicates how the employee is filing.
;[Tax Method|UFED_TAX_METHOD]: This field specifies the federal tax method for this employee.
;[Suppl. Tax Method|UFED_SUPPL_TAX_METHOD]:This field specifies the Federal supplemental tax method for this employee.
;[FICA Method|UFED_FICA_METHOD]: This field specifies the calculation method for FICA.
;[Medicare Method|UFED_MEDICARE_METHOD]: This field specifies the calculation method for the Medicare portion of the FICA.
;[FUTA Method|UFED_FUTA_METHOD]:This field specifies the calculation method for FUTA.
;[EIC Method|UFED_EIC_METHOD]: This field specifies the calculation method for employee Earned Income Credit.
;[Number of Exemptions|UFED_NUM_EXEMPTIONS]: This field specifies the number of exemptions the employee claims.
;[Annual Exemption|UFED_ANN_EXEMPTION]: This field displays the annual exemption amount being claimed.
;[Add’l Exemption|UFED_ADD_EXEMPTION]: This field specifies any additional exemption amount the employee claims.
;[Add’l Tax Per Period|UFED_ADD_TAX_PER_PERIOD]: This field shows the amount of additional tax to be taken each pay period. If the employee does not have enough taxable earnings this amount will only be taken if the additional tax option is set to 'always’ in the Payroll Information form and the pay is a ‘Regular Pay’ pay category.
;:If Federal Tax Method = Annualized + %, then this field contains the percentage that will be apply to federal earnings and treats as additional tax. (e.g. 5%, enter as 5).
;:If Federal Tax Method = Annualized + Amount, then this field contains a per pay period additional tax amount.
;[Tax Amount|UFED_TAX_AMOUNT]:This field contains the flat tax amount that has been pre-calculated by you to be taken for the pay.
;:It will be used when Federal Tax Method = Flat Amount Method.
;[Tax %|UFED_TAX_PERCENT]:This field contains the federal tax percentage applicable to this employee.
;:If the percentage is greater than zero, it will be used whenever the FED-TAX-METHOD or FED-SUP-METHOD specifies to use %. Otherwise the percentage from GOVTREG file ([IDGV]) will be used.
!Railroad Taxation
For US Railroad Employers, this section contains the pay methods required to calculate all legislated deductions and contributions required for those employees.
;[Tier1 SOC Method|URR_TIER1_SOC_METHOD]:This field specifies the Tier 1 Social Security tax calculation method for railway employees.
;[Tier1 MED Method|URR_TIER1_MED_METHOD]:This field specifies the Tier 1 Medicare tax calculation method for railway employees.
;[Tier2 RET Method|URR_TIER2_RET_METHOD]:This field specifies the Tier 2 Retirement tax calculation method for railway employees.
;[RUIA Method|URR_RUIA_METHOD]:This field specifies the Railroad Unemployment Insurance Act (RUIA) tax calculation method for railway employees.
;[Railroad SUPPL Method|URR_SUPPL_METHOD]:This field specifies the Railroad Supplemental Annuity tax calculation method for railway employees.
;[RURT Method|URR_RURT_METHOD]:This field specifies the Railroad Unemployment Repayment (RURT) tax calculation method for railway employees.
\\
----
!!State tab
;[Filing Status|UST_FILING_STATUS]:Valid filing status for state tax calculation:
;[Tax Method|UST_TAX_METHOD]:This field specifies the State tax method for the employee:
;[Suppl. Tax Method|UST_SUPPL_TAX_METHOD]:Specifies the state supplemental tax method for the employee:
;[Alternate Tax Method|UST_ALT_TAX_METHOD]:Specifies the alternate State tax method. Only used by a few states. If a state supports the Alternate State Tax method, it will be specified in the Vertex manual, ‘Current Information’ for the state. Please refer to Vertex manual prior to using the Alternate State method.
;:''Alt St Tax Method 00 – 09
;:UST_Alt_Tax_Method is a fixed lexicon ([X_UST_ALT_TAX_METHOD]) that you may use to look up the value.
;[SUI Employee Method|UST_SUI_EE_METHOD]:This field specifies the employee’s calculation method for State Unemployment Insurance:
;[SUI Employer Method|UST_SUI_ER_METHOD]:This field specifies the employer’s calculation method for State Unemployment Insurance:
;[SDI Employee Method|UST_SDI_EE_METHOD]:This field specifies the employee’s calculation method for State Disability Insurance:
;[SDI Employer Method|UST_SDI_ER_METHOD]:This field specifies the Employer’s calculation method for State Disability Insurance:
;[WCB Method|UST_WCB_METHOD]:This field specifies the calculation method for Workers’ Compensation:
;[Reciprocity Agreement|UST_RECIPROCATION]:This field indicates if the employee has filed a ‘Non-Residency Certificate’ with the employer and therefore the state tax is to be calculated by the certificate.
;[# of Exemptions 1|UST_NUM_EXEMPTION_1]:This field specifies the number of primary exemptions for the employee (e.g. spouse, dependants etc.). In most cases this will be the only number of exemptions claims.
;[# of Exemptions 2|UST_NUM_EXEMPTION_2]:This field specifies the number of secondary exemptions for the employee. This is used in some states for blind or over-65 dependents.
;[Tax Percent|UST_TAX_PERCENT]:This field contains the state tax percentage applicable to this employee.
;:If the percentage is greater than zero, it will be used whenever UST_TAX_METHOD or UST_SUPPL_TAX_METHOD specifies to use %. Otherwise, the percentage from GOVTREG file ([IDGV]) will be used.
;[Annual Exemption|UST_ANN_EXEMPTION]:This field specifies an overridden annual exemption amount for the state tax calculation. UST_Ann_Exemption is an optional 18 digit numeric field that you must manually enter.
;[Add’l Exemption|UST_ADD_EXEMPTION]:This field specifies any additional exemption amount the employee claims.
;[Add’l Tax Per Period|UST_ADD_TAX_PER_PERIOD]:This field indicates the amount of additional tax to be taken each pay period.
;:If the employee does not have enough taxable earnings this amount will only be taken if the additional tax option is set to 'always’ in the Payroll Information form and the pay is a ‘Regular Pay’ pay category.
;:If State Tax Method = Annualized +%, then this field contains the percentage that will be apply to federal earnings and treats as additional tax. (e.g. 5%, enter as 5).
;:If State Tax Method = Annualized + Amount, then this field contains a per pay period additional tax amount.
;[Add’l Tax for Res.|UST_ADD_TAX_RES]:This field indicates whether the additional tax per period is for Residence State tax:
*Add Tax not for RES
*Add Tax for RES
;[Add’l Tax for Work|UST_ADD_TAX_WORK]:This field indicates whether the additional tax per period is for Work State tax:
*Add Tax not for WORK
*Add Tax for WORK
;[Tax Amount|UST_TAX_AMOUNT]:This field contains the flat tax amount that has been pre-calculated by you to be taken for the pay. This field will be used when State Tax Method = Flat Amount method.
\\
----
!!Local tab
;[Filing Status|ULOC_FILING_STATUS]:You will use this field to select a valid filing status for local tax calculation:
;[Number of Exemptions|ULOC_NUM_EXEMPTIONS]:This field specifies the number of exemptions the employee claims.
;[County Tax Method|ULOC_COUNTY_TAX_METHOD]:This field specifies the county tax method for the employee:
;[City Tax Method|ULOC_CITY_TAX_METHOD]:This field specifies the city tax method for the employee:
;[Head Tax Method|ULOC_HEAD_TAX_METHOD]:This field specifies whether head tax should be calculated for the employee:
;[School Tax Method|ULOC_SCHOOL_TAX_METHOD]: This field specifies the school district tax method for the employee:
;[Add’l Tax for Work|ULOC_ADD_TAX_WORK]: This field indicates if the additional tax per period is for Work Local tax:
;[Add’l Tax for Res|ULOC_ADD_TAX_RES]:This field indicates whether the additional tax per period is for Residence Local tax:
;[Reciprocity Agreement|ULOC_RECIPROCATION]:In some areas of the United States, an employee may be taxed both where they work and where they live. To alleviate this, there are established agreements between tax jurisdictions to determine where the employee should pay taxes. These reciprocal agreements are indicated in this field.
;[Tax % 1|ULOC_TAX_PERCENT_1]:This field contains the local tax% applicable to this employee. If this percentage is greater than zero, it will be used wherever the County Tax method or City Tax method specifies to use %. Otherwise the percentage from GovtReg ([IDGV]) will be used.
;[Tax % 2|ULOC_TAX_PERCENT_2]: This field holds the additional rate of tax you may pass to Vertex.
;[Tax Amount|ULOC_TAX_AMOUNT]:This field contains the flat tax amount that has been pre-calculated by you to be taken for the pay. This field will be used when the County or City Tax method = Flat Amount method.
;[Add’l Tax Per Period|ULOC_ADD_TAX_PER_PERIOD]: This field shows the amount of additional tax to be taken each pay period.
;:If the employee does not have enough taxable earnings, this amount will only be taken if the toggle set ON in the payroll Information form and the pay is a ‘Regular Pay’ pay category.
;:If County or City Tax Method = Annualized + %, then this field contains the percentage that will be apply to federal earnings and treats as additional tax. (e.g. 5%, enter as 5)
;:If County or City Tax Method = Annualized + Amount, then this field contains a per pay period additional tax amount.
;[Head Tax Amount|ULOC_HEAD_TAX_AMOUNT]: If a flat amount is chosen for the Head Tax method then the amount need to be entered here.
;[School Tax Amount|ULOC_SCHOOL_TAX_AMOUNT]:If flat amount is chosen from the School Tax method then the amount needs to be entered here.
;[School Tax Percent|ULOC_SCHOOL_TAX_PERCENT]: If a percentage is chosen for the School Tax method then the percentage needs to be entered here.
;[Annual Exemption|ULOC_ANN_EXEMPTION]: This field specifies the annual exemption amount the employee claims.
;[Exemption %|ULOC_EXEMPTION_PERCENT]:This field specifies the additional exemption rate.