This page (revision-21) was last changed on 26-Nov-2021 10:22 by Kevin Higgs

This page was created on 26-Nov-2021 10:22 by JMyers

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note
21 26-Nov-2021 10:22 8 KB Kevin Higgs to previous US Tax Withholding Options (UFED_TAX_METHOD) ==> UFED_TAX_METHOD (US Tax Withholding Options)

Page References

Incoming links Outgoing links
IVPPRU
IVPPRU

Version management

Difference between version and

At line 1 changed 2 lines
!!!Alias: IVPPRU
(INF_CV_USPAYRULES)
!!!US PAY RUN INTERFACE FILE
At line 4 changed one line
(US Only) The INF_CV_USPAYRULES table is used to import the rules for employee taxation into the software data structures. The U.S. Pay Rules contain the individual pay factors and rules that are required to calculate all legislated deductions and contributions required for each Employee, by effective date. Completed according to the W-4 form submitted by employees. Employees may have different rule sets by state, if desired.
The US Pay Run Interface File screen is used to import the rules for employee taxation into the software data structures.
At line 6 changed 67 lines
Tables loaded: [P2K_PR_US_PAY_RULES] (one for each user field value provided)
!!Table Columns
\\
||Column name||Data Type / Size||Mand.||Notes
|[ID]|Number(10)| |Used internally to define a unique identification for the record. This field would not be loaded.
|[ENTITY_CODE]|Varchar2(16)|Y|used for validation of the employment record. Validation: The Entity Code provided must be defined on [P2K_CM_ENTITIES].
|[PERSON_CODE]|Varchar2(16)|Y|Used for validation of the employment record. Validation: Must be a valid [PERSON_CODE] already defined on the [P2K_HR_IDENTITIES] table.
|[EMPLOYMENT_TYPE]|Varchar2(30)| |Validation: The employee must have an active employment record for this employment type. Must be one of the fixed lexicon values from [X_EMPLOYMENT_TYPE]. Derivation: If you do not provide an employment type value, the conversion application will look for any P2K_HR_EMPLOYMENTS record that matches the other criteria. Suggestion: If you are loading employees, you can set this field to a fixed value of ‘01’.
|[HIRE_DATE]|Date()| |Used for validation of the employment record. Derivation: If you do not provide a hire date, the conversion application will look for any [P2K_HR_EMPLOYMENTS] record that matches the other criteria. Validation: Must be a valid date.
|[COUNTRY_CODE]|Varchar2(16)| |Used for validation of [STATE_PROVINCE_CODE]. Validation: Must be a valid country code on [P2K_CM_COUNTRIES]. If you provide a [STATE_PROVINCE_CODE], then you must provide a [COUNTRY_CODE].
|[STATE_PROVINCE_CODE]|Varchar2(16)| |Used for validation of [GEO_CODE]. Validation: Must be a valid state code or province code, for the [COUNTRY_CODE] indicated on [P2K_CM_STATE_PROVINCES].
|[GEO_CODE]|Varchar2(16)| |Validation: The GEO Code must be a valid [GEO_CODE] on the [P2K_CM_TAX_JURISDICTIONS] table and it must be within that specific state, as well.
|[DESCRIPTION]|Varchar2(50)| |
|[EFFECTIVE]|Date()|Y|Validation: Must be a valid date format. Suggestion: If you are not loading multiple date-effective records for the same employee, then populate this field with a constant ‘01-Jan-0001’ which represents the beginning of time.
|[EXPIRY]|Date()|Y|Validation: Must be a valid date format, with a date after the effective date. Suggestion: If you are not loading multiple date-effective records for the same employee, then populate this field with a constant ‘31-Dec-3999’ which represents the end of time.
|[CHANGE_CODE]|Varchar2(16)| |Validation: The Change Code provided must be defined on [P2K_CM_CHANGE_REASONS]
|[UFED_FILING_STATUS]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_FILING_STATUS]
|[UFED_NUM_EXEMPTIONS]|Number(5)| |
|[UFED_ANN_EXEMPTION]|Number(18)| |
|[UFED_ADD_EXEMPTION]|Number(18)| |
|[UFED_ADD_TAX_PER_PERIOD]|Number(18)| |
|[UFED_TAX_AMOUNT]|Number(18)| |
|[UFED_TAX_PERCENT]|Number(5)| |
|[UFED_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_TAX_METHOD]
|[UFED_SUPPL_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_SUPPL_METHOD]
|[UFED_FICA_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_FICA_METHOD]
|[UFED_MEDICARE_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_MEDICARE_METHOD]
|[UFED_FUTA_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_FUTA_METHOD]
|[UFED_EIC_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UFED_EIC_METHOD]
|[UST_RECIPROCATION]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_RECIPROCATION]
|[UST_FILING_STATUS]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_FILING_STATUS]
|[UST_NUM_EXEMPTION_1]|Number(5)| |
|[UST_NUM_EXEMPTION_2]|Number(5)| |
|[UST_ANN_EXEMPTION]|Number(18)| |
|[UST_ADD_EXEMPTION]|Number(18)| |
|[UST_ADD_TAX_PER_PERIOD]|Number(18)| |
|[UST_ADD_TAX_RES]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_ADD_TAX_RES]
|[UST_ADD_TAX_WORK]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_ADD_TAX_WORK]
|[UST_TAX_AMOUNT]|Number(18)| |
|[UST_TAX_PERCENT]|Number(5)| |
|[UST_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_TAX_METHOD]
|[UST_SUPPL_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_SUPPL_METHOD]
|[UST_ALT_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_ALT_TAX_METHOD]
|[UST_SUI_EE_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_SUI_METHOD]
|[UST_SUI_ER_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_SUI_METHOD]
|[UST_SDI_EE_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_SDI_METHOD]
|[UST_SDI_ER_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_SDI_METHOD]
|[UST_WCB_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_UST_WCB_METHOD]
|[ULOC_RECIPROCATION]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_RECIPROCATION]
|[ULOC_FILING_STATUS]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_FILING_STATUS]
|[ULOC_NUM_EXEMPTIONS]|Number(5)| |
|[ULOC_ANN_EXEMPTION]|Number(18)| |
|[ULOC_EXEMPTION_PERCENT]|Number(5)| |
|[ULOC_ADD_TAX_PER_PERIOD]|Number(18)| |
|[ULOC_ADD_TAX_WORK]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_ADD_TAX_WORK]
|[ULOC_ADD_TAX_RES]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_ADD_TAX_RES]
|[ULOC_TAX_AMOUNT]|Number(18)| |
|[ULOC_TAX_PERCENT_1]|Number(5)| |
|[ULOC_TAX_PERCENT_2]|Number(5)| |
|[ULOC_COUNTY_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_COUNTY_TAX_METHOD]
|[ULOC_CITY_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_CITY_TAX_METHOD]
|[ULOC_SCHOOL_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_SCHOOL_TAX_METHOD]
|[ULOC_SCHOOL_TAX_AMOUNT]|Number(18)| |
|[ULOC_SCHOOL_TAX_PERCENT]|Number(5)| |
|[ULOC_HEAD_TAX_METHOD]|Varchar2(30)| |Validation: If provided, must be one of the fixed lexicon values from [X_ULOC_HEAD_TAX_METHOD]
|[ULOC_HEAD_TAX_AMOUNT]|Number(18)| |
|[UST_EIC_METHOD]|Varchar2(30)| |
US Pay Run Interface File data is maintained on the [INF_CV_USPAYRULES] table.
At line 74 changed 4 lines
[{If var='loginstatus' contains 'authenticated'
\\
At line 79 changed 2 lines
![Discussion|Edit:Internal.IVPPRU]
[{InsertPage page='Internal.IVPPRU' default='Click to create a new discussion page'}]
!!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]:This field is used to specify the number of exemptions the employee claims.
;[Fed Annual Exemption|UFED_ANN_EXEMPTION]:This field displays the annual exemption amount being claimed.
;[Fed Add'l Exemption|UFED_ADD_EXEMPTION]:This field specifies any additional exemption amount the employee claims.
;[Fed Add'l Tax Per Period|UFED_ADD_TAX_PER_PERIOD]:This field is used to show the amount of additional tax to be taken each pay period.
;[Fed 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.
;[Fed Tax %|UFED_TAX_PERCENT]:This field contains the federal tax percentage applicable to this employee.
;[Fed Tax Method|US Tax Withholding Options (UFED_TAX_METHOD)|UFED_TAX_METHOD (US Tax Withholding Options)]: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]: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.
;[State Number 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.
;[State Annual Exemptions|UST_ANN_EXEMPTION]:This field specifies an overridden annual exemption amount for the state tax calculation.
;[State Add'l Exemption|UST_ADD_EXEMPTION]:This field specifies any additional exemption amount the employee claims.
;[State Add'l Tax Per Period|UST_ADD_TAX_PER_PERIOD]:This field indicates the amount of additional tax to be taken each pay period.
;[State Add'l Tax For Residence|UST_ADD_TAX_RES]:This field indicates whether the additional tax per period is for Residence State tax.
;[State Add'l Tax|UST_ADD_TAX_WORK]:This field indicates whether the additional tax per period is for Work State tax.
;[State 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.
;[State Tax Percent|UST_TAX_PERCENT]:This field contains the state tax percentage applicable to this employee.
;[State Tax Method|UST_TAX_METHOD]:This field specifies the State tax method for the employee.
;[State Suppl Tax Method|UST_SUPPL_TAX_METHOD]:Specifies the state supplemental tax method for the employee.
;[State Alternate Tax Method|UST_ALT_TAX_METHOD]:Specifies the alternate State tax method. This function is 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.
;[State SUI EE Method|UST_SUI_EE_METHOD]:This field specifies the employee’s calculation method for State Unemployment Insurance.
\\
----
!!Tab 3
;[State SUI ER Method|UST_SUI_ER_METHOD]:This field specifies the employer’s calculation method for State Unemployment Insurance.
;[State SDI EE Method|UST_SDI_EE_METHOD]:This field specifies the employee’s calculation method for State Disability Insurance.
;[State SDI ER Method|UST_SDI_ER_METHOD]:This field specifies the employer’s calculation method for State Disability Insurance.
;[State WC Method|UST_WCB_METHOD]:This field specifies the calculation method for Workers’ Compensation:
;[Local 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.
;[Local Filing Status|ULOC_FILING_STATUS]:You will use this field to select a valid filing status for local tax calculation.
;[Local Number of Exemptions|ULOC_NUM_EXEMPTIONS]:This field specifies the number of exemptions the employee claims.
;[Local Annual Exemption|ULOC_ANN_EXEMPTION]:This field specifies the annual exemption amount the employee claims.
;[Local Exemption %|ULOC_EXEMPTION_PERCENT]:This field specifies the additional exemption rate.
;[Local Add'l Tax for Pay Period|ULOC_ADD_TAX_PER_PERIOD]:This field shows the amount of additional tax to be taken each pay period.
;[Local Add'l Tax for Work|ULOC_ADD_TAX_WORK]:This field indicates if the additional tax per period is for Work Local tax.
;[Local Add'l Tax for Residence|ULOC_ADD_TAX_RES]:This field indicates whether the additional tax per period is for Residence Local tax.
;[Local 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.
;[Local 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.
;[Local Tax % 2|ULOC_TAX_PERCENT_2]:This field holds the additional rate of tax you may pass to Vertex.
;[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.
;[School Tax Method|ULOC_SCHOOL_TAX_METHOD]:This field specifies the school district tax method for the employee.
;[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.
\\
----
!!Tab 4
;[Head Tax Method|ULOC_HEAD_TAX_METHOD]:This field specifies whether head tax should be calculated for the employee.
;[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.
;[UST EIC Method|UST_EIC_METHOD]:
At line 82 changed one line
}]
----
![Notes|Edit:Internal.IVPPRU]
[{InsertPage page='Internal.IVPPRU' default='Click to create a new notes page'}]
This page (revision-21) was last changed on 26-Nov-2021 10:22 by Kevin HiggsTop