CreateTaxWorkfileHistory

Create Tax Workfile History

Minor Business Rule

Object Name: B0700014

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700014 - DS for Create Tax Workfile History

Parameter NameData ItemData TypeReq/OptI/O/Both
szCheckControlCachePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

mnAddressNumberAN8MATH_NUMERICOPTNONE

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

mnCheckYearYRMATH_NUMERICOPTNONE

The calendar year for this calendar.

szPayrollIDPAYDcharOPTNONE

A code that identifies a group of employees for whom you are processing payroll. Use this ID to process each step of the payroll 
cycle. This code is also used to identify the interim ID that you select when you enter interim payments.

jdDateUpdatedUPMJJDEDATEOPTNONE

The date that specifies the last update to the file record.

mnTimeLastUpdatedUPMTMATH_NUMERICOPTNONE

The time that specifies when the program executed the last update to this record.

szProgramIDPIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szWorkStationIDJOBNcharOPTNONE

The code that identifies the work station ID that executed a particular job.

szUserIDUSERcharOPTNONE

The code that identifies a user profile.

szTaxDetailCachePID1charOPTNONE

Program ID - 01

mnCheckControlNumberCKCNMATH_NUMERICOPTNONE

A number used to group all payroll transactions for each payment or individual interim payment. This number is carried into the accounting 
journal entries and facilitates the update of the actual check number after payment printing is complete. This number is also used for 
automatically voiding payments. The payment work table contains both the actual check number and the check control number. All associated 
payment transactions are automatically reversed using the check control number. This is not the actual check number.

jdDatePayCheckCKDTJDEDATEOPTNONE

The date associated with the various types of net pay instructions. This date relates to a payroll check, an interim payment, a bank 
automatic-deposit advice slip, a payslip (cash), or a claim reimbursement.

cProcInterimsEV01charOPTNONE

An option that specifies the type of processing for an event.

cMergeInterimsEV01charOPTNONE

An option that specifies the type of processing for an event.

cTaxCalcMethodFICMcharOPTNONE

A code that specifies the tax method that the Vertex payroll-tax calculation system uses to calculate certain taxes. The codes are defined in 
UDC 07/TM. This code can also determine the form that the employee receives for year-end tax reporting. For example, when you enter C, 
a contract employee receives IRS Form 1099-M rather than IRS Form W-2. If a form is not specified in Description 2, the system generates 
IRS Form W-2. For employees who are paid multiple times within one pay period, the system should review previous payments within the same 
pay period and then adjust tax amounts. To specify this function, enter S. If a tax method exists for an employee in addition to the normal tax 
method that is set up in the Employee Master Information table (F060116), the system can use the alternative tax method to interactively 
process interim payments. To specify this function, enter Z. Some values, such as S and Z, might require additional setup in the UDC table.

cBypassVoidwithSpecialTaxesBPVDcharOPTNONE

A code that indicates whether you want to bypass or process voided payments if those payments contain special taxes. Valid values 
are: 0 Process voided payments with special taxes.  1 Bypass voided payments with special taxes.

szCountryCodeCCPRcharOPTNONE

A user defined code list 00/CN that indicates the country in which the employee resides.

szDBACachePIDcharOPTNONE

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

szTaxAreaWorkTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

szStatutoryCode1SCODcharOPTNONE

A code that specifies the two-character or three-character state or province code that prints on statutory reports such as W-2s and T4s. For 
example, on W-2s and T4s, instead of printing 06, which might be the taxing authority for the state of Colorado, the system prints the statutory 
code CO. Enter in an alpha code from UDC table 06/SC. 

cInterimPaymentCodePACOcharOPTNONE

A code that specifies the type of payment the interim creates. The value is stored in the Payment File (F07350). These values are 
hard-coded and should not be changed. Valid values are: G Gross up allows a user to enter a desired net check amount for an employee. The system 
calculates the gross amount that is required to include taxes and deductions and still produce the desired net check amount. A Net advance 
is a check that the system produces to give an employee a payroll check in advance of the normal pay date. In this case, you enter the 
advance amount. This amount becomes the net amount of the check with no taxes subtracted from the total. C Calculated advance is a check that 
the system produces to provide an employee payroll check in advance of the normal pay date. In this case, the system calculates the 
advance amount and deducts taxes from the net amount of the check. O Off cycle are payroll checks that the system produces outside of the 
normal payroll check cycle run. J Adjustment allows a user to create adjustments that create negative payment records in the Payment File. The 
Payment File is a manual table that you can use to change (or void) payroll history transactions.

Related Functions

B0700003 Create PrePayroll Caches

Related Tables

F06136 Tax History
F069016 Payroll Tax Area Profile
F069086 Payroll Corporate Tax Identification
F07353 Tax Detail File