Functional Description
B0700010Vertex Tax Calculations
Purpose
Main driver to set employee tax information, calculate taxes, and create tax detail records (F07353).
Setup Notes and Prerequisites
The Perform Tax Calculations routine is called from the Do section of the UBE (R07200).  
Technical Specification
Parameters:
  szCheckControlNoCacheName
  szVertexCacheName
  szDBACacheName
  szTimecardCacheName
  szPayrollID                  
  mnAddressNumber
  szTaxAreaWork                   
  szTaxAreaResidence              
  szTaxId                   
  cMaritalStatusTax                   
  szCompanyHome                    
  szPayPeriodNumber                
  cPayFrequency                       
  jdDatePayCheck                      
  jdDateUpdated                       
  mnTimeLastUpdated                   
  szProgramId                    
  szWorkStationId                 
  szUserId                        
  cTaxCalcMethod  
  cEICStatus                          
  cWorkTaxSource                      
  cSUISource                          
  cResidencyStatus                    
  mnSchoolDistrictCode 
Related Tables
none
Related Business Functions
Source Name       Function Name
B0700004Set Tax Calculation Inputs
B0700009Create Tax Detail records
B0700008Perform Tax Calculations
B0700058Establish connection to Vertex
Processing 
1.0   Initialize Check Control number cache
2.0Initialize data structures for:
 Employee handle
 Payroll Id
 Address Number
 Timecard Cache Name
 DBA Cache Name
 Vertex Cache Name
 Tax Area Work
 Tax Area Residence
 Tax Id
 Home Company 
 Pay period number
 Pay Frequency
 Pay Check date
3.0Perform Tax Calculations (B0700008)
 Employee handle
 Employee handle
 Address Number
 Date Updated
 Time Last Updated
 Program Id
 Work Station Id
 User Id
5.0Create an Employee Information Handle VprtInitEmpHdl (Data Handle)
6.0Loop through Check Control cache records.  We need to calculate taxes separately  for 
each unique Check Control number.
^
D0700010 - Vertex Tax Calculation
| Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both | 
|---|---|---|---|---|
| szCheckControlNoCacheName | 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 
  | ||||
| szVertexCacheName | PID1 | char | OPT | NONE | 
Program ID - 01  | ||||
| szDBACacheName | PID2 | char | OPT | NONE | 
Program ID - 02  | ||||
| szTimecardCacheName | PID3 | char | OPT | NONE | 
Program ID - 03  | ||||
| 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 
  | ||||
| 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.  | ||||
| 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 
  | ||||
| jdDateUpdated | UPMJ | JDEDATE | OPT | NONE | 
The date that specifies the last update to the file record.  | ||||
| mnTimeLastUpdated | UPMT | MATH_NUMERIC | OPT | NONE | 
The time that specifies when the program executed the last update to this record.  | ||||
| szProgramId | PID4 | char | OPT | NONE | 
Program ID - 04  | ||||
| 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.  | ||||
| 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 
  | ||||
| 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 
  | ||||
| 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 
  | ||||
| cPrintVertexReport | EV01 | char | OPT | NONE | 
An option that specifies the type of processing for an event.  | ||||
| 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) 
  | ||||
| cVacationFactor | AAF | char | OPT | NONE | 
A value in this field represents the number of pay periods that this check is to cover. This is used by the Payroll system to direct the Vertex 
  | ||||
| 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.  | ||||
| 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 
  | ||||
| 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 
  | ||||
| jdDtWorkJulian | DWK | JDEDATE | OPT | NONE | 
The date used as the actual work date or pay-period ending date.  | ||||
| jdDatePayPeriodEnding | PPED | JDEDATE | OPT | NONE | 
The last day of a processing period (pay period, month, quarter or year).  | ||||
| szTaxOverrideCache | 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 
  | ||||
| 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 
  | ||||
| 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.  | ||||
| B0700004 Set Tax Calculation Inputs | ||||
| B0700008 Perform Tax Calculations | ||||
| B0700009 Create Tax Detail Records | ||||
| B0700058 Establish Connection to Vertex | 
| None |