Functional Description
B0700004Set Tax Calculation Inputs
Purpose
Set Employee Information and Employee Tax Parameters into Vertex for tax calculations.
Setup Notes and Prerequisites
The Set Tax Calculation Inputs routine is called from the Business Function Vertex Tax Calculations
(B0700010).
Technical Specification
Parameters:
szPayrollID
mnAddressNumber
szTimecardCacheName
szDBACacheName
szVertexCacheName
szCheckControlNoCacheName
szTaxAreaWork
szTaxAreaResidence
szTaxId
cMaritalStatusTax
szCompanyHome
cTaxHistoryType
szPayPeriodNumber
cPayFrequency
jdDatePayCheck
mnCheckControlNumber
vDataHandle/* Vertex data variable */
cTaxCalcMethod
cSetTaxErrorFlag
cEICStatus
cWorkTaxSource
cSUISource
cResidencyStatus
mnSchoolDistrictCode
Related Tables
none
Related Business Functions
Source Name Function Name
B0700010Vertex Tax Calculations
B0700008Perform Tax Calculations
B0700009Create Tax Detail records
B0700058Establish connection to Vertex
Processing
Note: Vertex can identify up to 10 work locations for a given tax type and pay period. This could
be a limitation at some point that will need to be addressed.
1.0Initialize Caches:
DBA Cache
Vertex Cache
2.0Initialize State List structure. This structure contains a list of unique state geo
codes. This structure is used in tax calculations for state purposes.
3.0Convert Filing Status for Vertex.
Parameter returned:Vertex Filing status
AEVprtFilStat02Married, filing jointly
BEVprtFilStat02Married, filing jointly
HEVprtFilStat03Head of household
JEVprtFilStat04Married, filing
separately
MEVprtFilStat02Married, filing jointly
PEVprtFilStat01Single
QEVprtFilStat02Married, filing jointly
SEVprtFilStat01Single
1EVprtFilStat02Married, filing jointly
2EVprtFilStat01Single
3EVprtFilStat01Single
4.0Calculate Employee Pre Tax Gross Amount
Loop
control number being processed from B0700010
through TT15) that hold exempted tax types. So, this data structure is an array of 15
holding the exempt tax types. The exempt tax types are enumerated tax types that Vertex can
recognize. If a tax type field is blank then the enumerated tax type is "-1".
broken into three pieces, state geo, county geo, and city geo. Thus, need to append all three
pieces together to populate the Tax Work Area.
unique state geo codes (2 digits). The purpose of this data structure is to compute Works-In
state taxes.
unique Works-In geo codes so we need to determine if the current work geo code from the
Timecard cache is unique compared to already existing Works-In geo codes in this data structure.
If the current work geo code is not unique then set a flag to TRUE then do not add this
to the Tax Area data structure.
That is:
State geo code
County geo code
City geo code
Now, check the exempt tax type from the Timecard cache:
Tax Area data structure.
Gross is positive then add the Gross Pay populated from Timecard cache to the Tax Area
data structure. Otherwise, subtract the Gross Pay populated from Timecard cache from
the Tax Area data structure.
exists, then determine the "effect on gross" and add/subtract the Gross Pay populated
from Timecard cache to the Tax Area data structure.
5.0Calculate Employee Pre Tax Gross Amount (continued)
Loop
number being processed from B0700010 and the PDBA type is "D"(deduction).
through TT15) that hold exempted tax types. So, this data structure is an array of 15 holding
the exempt tax types. The exempt tax types are enumerated tax types that Vertex can
recognize. If a tax type field is blank then the enumerated tax type is "-1".
pay method as to whether it is considered "B" (supplemental pay) or regular pay.
deduction types in computing adjusted gross pay (125, 401K, 403B, and 457).
Check the exempt tax type from the DBA cache:
125, 401K, 403B, and 457 plan deductions. Use the Pre Tax Type field in the DBA cache
to determine the deduction type.
exists,
Then compute the deduction amounts and the YTD deduction amounts for 125, 401K, 403B,
and 457 plan deductions.
A1Annual
Q4Quarterly
M12Monthly
S24Semi-Monthly
B26Biweekly
W52Weekly
VprtSetEmpHdl (Employee handle,
Current pay period,
Employee number,
SDI rate,
FUTA rate,
Check date,
Number of pay periods,
Residence geo code,
7.0Set Employee Tax Information for Vertex Tax Calculation.
Tax type description(FWT, FUTA, '85 Medicare Paid)
Vertex function (DED, TAX, GRS, HDL, CALC, OVAL)
Tax basis (YTD or REGular pay)
Tax Level (FEDeral, STate, or LOCal)
125, 403B, or 457). This is based on the deduction amount.
Call Vertex API VprtSetDeduct
Federal tax level,
Deduction type,
Cash option,
Deduction amount,
YTD deductio
D0700004 - Set Tax Calculation Inputs
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
szPayrollID | PAYD | char | OPT | NONE |
A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll
| ||||
mnAddressNumber | AN8 | MATH_NUMERIC | OPT | NONE |
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or
| ||||
szTimecardCacheName | PID | char | OPT | NONE |
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
| ||||
szDBACacheName | PID1 | char | OPT | NONE |
Program ID - 01 | ||||
szVertexCacheName | PID2 | char | OPT | NONE |
Program ID - 02 | ||||
szCheckControlNoCacheName | PID3 | char | OPT | NONE |
Program ID - 03 | ||||
szTaxAreaWork | TARA | char | OPT | NONE |
A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory
| ||||
szTaxAreaResidence | TARR | char | OPT | NONE |
A code that identifies both the geographical location and the tax authorities for the employee's residence. Authorities include employee
| ||||
szTaxId | TAXX | char | OPT | NONE |
A number that identifies your company to the tax authority. This number can include the tax ID number for an individual, a federal or state
| ||||
cMaritalStatusTax | MSTX | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This
| ||||
szCompanyHome | HMCO | char | OPT | NONE |
The company number where the employee records generally reside. | ||||
cTaxHistoryType | THTY | char | OPT | NONE |
A user defined code (07/TH) that specifies the type of information being tracked for the employee in the US Taxation Summary History
| ||||
szPayPeriodNumber | PPNB | char | OPT | NONE |
The number of the pay period from the beginning of the year. For instance, a monthly payroll cycle beginning in January has a total of 12
| ||||
cPayFrequency | PFRQ | char | OPT | NONE |
A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are:
B
Biweekly
W
Weekly
S
Semimonthly
| ||||
jdDatePayCheck | CKDT | JDEDATE | OPT | NONE |
The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank
| ||||
mnCheckControlNumber | CKCN | MATH_NUMERIC | OPT | NONE |
A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting
| ||||
vDataHandle | PID4 | char | OPT | NONE |
Program ID - 04 | ||||
cTaxCalcMethod | FICM | char | OPT | NONE |
A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in
| ||||
cSetTaxErrorFlag | FLG | char | OPT | NONE |
cEICStatus | EIC | char | OPT | NONE |
A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the
| ||||
cWorkTaxSource | NS | char | OPT | NONE |
This code is used to determine the source for obtaining the tax area code for the employee's work location.
N Use time entry, job master,
| ||||
cSUISource | SUI | char | OPT | NONE |
Use this field to specify the work tax area that is used for SUI reporting.
You can specify that the system use either the resident state or the
| ||||
cResidencyStatus | WSPS | char | OPT | NONE |
A value that identifies out-of-state employees for whom an employer must withhold tax for the state of residence. Valid values are:
N
| ||||
mnSchoolDistrictCode | SCDC | MATH_NUMERIC | OPT | NONE |
A user-defined code in UDC 06/SD that determines the school district tax for taxation purposes. Vertex automatically calculates the school
| ||||
iTimecardCount | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due. | ||||
cWorkStateTax | MSTI | char | OPT | NONE |
The employee's "Work" state marital status code as retrieved from the state W-4. This code is used in the computation of all state payroll
| ||||
cResStateTax | RMST | char | OPT | NONE |
A user defined code (system 06, type MS) that specifies the marital status code for the state of residence. It is used for tax computations.
| ||||
cLocalAreaTax | LMST | char | OPT | NONE |
The employee's Local marital status code as retrieved from the locality's W-4.
This code is used in the computation of all local (city, county)
| ||||
szTimecardCompanyHome | HMCO | char | OPT | NONE |
The company number where the employee records generally reside. | ||||
idEmployeeHandle | GENLNG | ID | OPT | NONE |
General purpose ID variable. | ||||
mnTotalGrossPay | MATH01 | MATH_NUMERIC | OPT | NONE |
- - - Good Performance Low Value. | ||||
szTaxOverrideCacheName | PID5 | char | OPT | NONE |
Program ID - 05 | ||||
jdDateOfBirth | DOB | JDEDATE | OPT | NONE |
The employee's date of birth. | ||||
szCountryCode | CCPR | char | OPT | NONE |
A user defined code list 00/CN that indicates the country in which the employee resides. | ||||
cVertexTaxAreaFlag | FLG | char | OPT | NONE |
szUnemploymentRatesCacheName | PID | char | OPT | NONE |
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
| ||||
cPayrollType | PATY | char | OPT | NONE |
An option that specifies whether the payroll cycle includes interim payments only. Valid values are:
On Yes, the payroll cycle includes
| ||||
szTaxDetailCacheName | PID | char | OPT | NONE |
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
| ||||
mnTimeLastUpdated | UPMT | MATH_NUMERIC | OPT | NONE |
The time that specifies when the program executed the last update to this record. | ||||
jdDateUpdated | UPMJ | JDEDATE | OPT | NONE |
The date that specifies the last update to the file record. | ||||
szWorkStationId | JOBN | char | OPT | NONE |
The code that identifies the work station ID that executed a particular job. | ||||
szUserId | USER | char | OPT | NONE |
The code that identifies a user profile. | ||||
cHistoryConversion | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
szDBADetailCacheName | PID | char | OPT | NONE |
The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry
| ||||
iNumberOfPayPeriods | INT01 | integer | OPT | NONE |
Number of Days in Future to Query for Responses Due. | ||||
cLastPeriodOfMonth | EV01 | char | OPT | NONE |
An option that specifies the type of processing for an event. | ||||
cBypassVoidwithSpecialTaxes | BPVD | char | OPT | NONE |
A code that indicates whether you want to bypass or process voided payments if those payments contain special taxes. Valid values
|
B0700010 Vertex Tax Calculations |
F0005 User Defined Codes | ||||
F06017 Employee Tax Exceptions/Overrides | ||||
F069116 Payroll Transaction Constants | ||||
F069226 Unemployment Insurance Rates | ||||
F07353 Tax Detail File |