ProcessInteractiveInterimDriver

Process Interactive Interims Driver

Minor Business Rule

Object Name: B0701520

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0701520 - DS for Process Interactive Interims Driver

Parameter NameData ItemData TypeReq/OptI/O/Both
szPayrollIDOWPAYDcharOPTNONE

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.

mnAddressNumberAN8MATH_NUMERICOPTNONE

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

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.

szTimecardCacheNamePIDcharOPTNONE

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.

szDBACacheNamePIDcharOPTNONE

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.

szDeductionCacheNamePIDcharOPTNONE

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.

szVertexCacheNamePIDcharOPTNONE

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.

szCheckControlCacheNamePIDcharOPTNONE

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.

szPayCycleGroupCacheNamePIDcharOPTNONE

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.

szMultipleJobsCacheNamePIDcharOPTNONE

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.

szGroupLimitCacheNamePIDcharOPTNONE

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.

szDBAAliasCacheNamePIDcharOPTNONE

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.

szBasisCacheNamePIDcharOPTNONE

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.

szDBADetailCacheNamePIDcharOPTNONE

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.

szTranNoDetailCacheNamePIDcharOPTNONE

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.

szUnionLevelCacheNamePIDcharOPTNONE

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.

szChildSupportCacheNamePIDcharOPTNONE

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.

szSickVacationCacheNamePIDcharOPTNONE

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.

szCountryCacheNamePIDcharOPTNONE

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.

szUnemploymentRatesCacheNamePIDcharOPTNONE

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.

szTaxDetailCacheNamePIDcharOPTNONE

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.

cPayrollTypeF07210PATYcharOPTNONE

An option that specifies whether the payroll cycle includes interim payments only. Valid values are:    On Yes, the payroll cycle includes 
interim payments only.    Off No, the payroll cycle includes regular payments instead of or in addition to interim payments.

jdPayPeriodEndDateF07210PPEDJDEDATEOPTNONE

The last day of a processing period (pay period, month, quarter or year).

jdEffectiveBeginningDateF07210EFTBJDEDATEOPTNONE

The date that an address, item, transaction, or table record becomes active.  The meaning of this field differs, depending on the program.  
For example, the effective date could represent the following:    o When a change of address becomes effective.   o When a lease becomes 
effective.   o When a price becomes effective.   o When the currency exchange rate becomes effective.   o When a tax rate becomes effective. 

jdEffectiveEndingDateF07210EFTEJDEDATEOPTNONE

The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used 
generically throughout the system. It could be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective 
date, or whatever is appropriate.

szPayPeriodNumberF07210PPNBcharOPTNONE

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 
periods with October being the 10th period. Typical values are:        001-052 (Weekly Payroll Cycle)        001-026 (Biweekly Payroll Cycle)        
001-024 (Semimonthly Payroll Cycle)        001-012 (Monthly Payroll Cycle)        001-004 (Quarterly Payroll Cycle)        001-001 (Annual Payroll Cycle)

mnMaximumNetPayF07210NMAXMATH_NUMERICOPTNONE

The lowest amount to be generated as a check, bank advice, or payslip. The system does not allow zero amount checks if you have 
specified a minimum check amount. You can leave this field blank. Generally, this field's value will specify the minimum amount that must be paid 
to the employee.

cPayPeriodNumbersF07210PPMBcharOPTNONE

For WorldSoftware: The definition of this field depends on the program from which you access the field:     o Valid Master Pay Cycles 
(P069061) - A value that specifies which period bucket number in the Payroll Integrity table (F0620) will be updated.        The integrity period number 
specifies one of five periods in which the system stores the history. It does not determine the calculation of DBAs. If you run a multiple 
frequency payroll (such as salary with both weekly and biweekly employees), enter an unused integrity period number. For example, for the first 
biweekly payroll of the month, use 2         because 1 was already used for the first weekly payroll.     o Pay Cycle Control Parameters (P06210) - A 
value that specifies whether the pre-payroll programs will calculate those benefits and accruals that are based on calendar month amounts 
(dollars/hours). If the value is N, the system skips these benefits and accruals. For OneWorld: A value that specifies whether the pre-payroll 
programs will calculate benefits and accruals that are based on calendar month amounts (dollars/hours). Valid values are:    Y        Yes. The 
pre-payroll programs will calculate benefits and accruals that are based on calendar month amounts (dollars/hours).    N        No. The pre-payroll 
programs will not calculate benefits and accruals that are based on calendar month amounts (dollars/hours).    Blank Same as N.

szCountryCodeF07210CCPRcharOPTNONE

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

cBypassDBAFlagF07210ODBAcharOPTNONE

A code that specifies whether the system processes a DBA during the interim payroll cycle. You can enter this code in any of the following 
places:   o  When you set up the DBA, to specify whether the system processes it with interim payments   o  During pre-payroll processing, to 
specify whether the system processes the DBA in the current payroll cycle   o  When you enter an interim payment, to specify that the system 
does not calculate DBAs for the interim payment

cAutoDepositOverrideFlagF07210ADOFcharOPTNONE

A code that specifies whether to override auto deposits. A Y turns off auto deposit for all employees in this pre-payroll processing version 
and prints checks instead of automatic deposit advice slips. This field lets you override auto deposit instructions in one place instead of 
changing auto deposit instructions individually for each employee in the version. Valid values are:    Y Yes, override auto deposit instructions. Use 
this code for regular payment processing.    N No, do not override auto deposit instructions.    P Override auto deposit instructions during 
interim payment processing.

mnWeeklyHoursF07210WHRWMATH_NUMERICOPTNONE

The standard number of hours to be paid employees whose pay frequency is Weekly (W). The number entered into this field is used 
during pre-payroll processing when the system calculates autopay; the hours entered into this field are used versus calculating the hours based 
upon gross pay divided by the hourly rate. If you leave this field blank, the hours worked are calculated during the generation of timecards.

mnBiweeklyHoursF07210BHRWMATH_NUMERICOPTNONE

The standard number of hours to be paid employees whose pay frequency is Bi-Weekly (B). The number entered into this field is used 
during pre-payroll processing when the system calculates autopay: the hours entered into this field are used versus calculating the hours based 
upon gross pay divided by the hourly rate.

mnSemiMonthlyHoursF07210SHRWMATH_NUMERICOPTNONE

The standard number of hours to be paid employees whose pay frequency is Semi-Monthly (S). The number entered into this field is used 
during pre-payroll processing when the system calculates autopay; the hours entered into this field are used versus calculating the hours 
based upon gross pay divided by the hourly rate.

mnMonthlyHoursF07210MHRWMATH_NUMERICOPTNONE

The standard number of hours to be paid employees whose pay frequency is Monthly (M). The number entered into this field is used during 
pre-payroll processing when the system calculates autopay; the hours entered into this field are used versus calculating the hours based 
upon gross pay divided by the hourly rate.

mnOtherHoursF07210OHRWMATH_NUMERICOPTNONE

The standard number of hours to be paid employees whose pay frequency is Other (O). The number entered into this field is used during 
pre-payroll processing when the system calculates autopay; the hours entered into this field are used versus calculating the hours based upon 
gross pay divided by the hourly rate.

cPayPeriodWeeklyF07210PPM1charOPTNONE

The number of the pay period, within the month, for employees who are paid weekly. This field is used in conjunction with the Pay Period to 
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals the system will calculate during the current 
payroll cycle.

cPayPeriodBiweeklyF07210PPM2charOPTNONE

The number of the pay period, within the month, for employees who are paid biweekly. The system uses this value and the Pay Period to 
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate during the current payroll cycle.

cPayPeriodSemiWeeklyF07210PPM3charOPTNONE

The number of the pay period, within the month, for employees paid semimonthly. The system uses this value and the Pay Period to 
Calculate, from the DBA Setup form, to determine which deductions, benefits, and accruals to calculate for the current payroll processing cycle.

cPayPeriodMonthlyF07210PPM4charOPTNONE

The number of the pay period within the month, for employees who are paid monthly. This field is used in conjunction with the Pay Period to 
Calculate field on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

cPayPeriodAnnualF07210PPM5charOPTNONE

The number of the pay period for employees who are paid annually. This field is used in conjunction with the Pay Period to Calculate field 
on the DBA Setup form to determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

cPayPeriodOtherF07210PPM6charOPTNONE

The number of the pay period, within the month, that is used in conjunction with the Pay Period to Calculate field on the DBA Setup form to 
determine which deductions, benefits, and accruals are to be calculated during this payroll cycle.

szCompanyF07210COcharOPTNONE

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

szPaycycleGroupCodeF07210CYGRcharOPTNONE

A user defined code (system 06, type PG) that indicates a pay cycle group. If you enter a pay cycle group code here, the system 
processes only those timecards whose business unit has that pay cycle group assigned in the business unit constants. The type code explained 
below determines which business unit is used in the selection process. This field and the accompanying Type field override the DREAM Writer 
home business unit selection. Employees must first be selected in the DREAM Writer Data Selection, then timecards for those employees are 
selected based on Pay Cycle Group Code and Type.

cPayCylcleGroupTypeF07210PCGTcharOPTNONE

A code which identifies which Business Unit in the Timecard Detail File (F06116) is to be used in the selection of the transactions for a 
Payroll Processing. Any one of the following Business Units may be selected:    D Distribution Business Unit (YTMCU)    J Job Location (YTMUCO)   
 H Home Business Unit (YTHMCU)

szGLBankAccountF07210GLBAcharOPTNONE

The number of the bank account (general ledger account) to be updated automatically when receipts or disbursements are entered. The 
bank account number is assumed to be the same for every document in a batch. Therefore, it is not cleared from entry to entry. However, if 
you leave the bank account number blank, the system retrieves a default bank account number from the Automatic Accounting Instructions file 
(F0012), item number RB for Accounts Receivable and PB for Accounts Payable.

jdPayCheckDateF07210CKDTJDEDATEOPTNONE

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.

szUserIdUSERcharOPTNONE

The code that identifies a user profile.

szProgramId_19PIDcharOPTNONE

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.

mnTimeLastUpdatedUPMTMATH_NUMERICOPTNONE

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

jdDateUpdatedUPMJJDEDATEOPTNONE

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

szWorkStationIdJOBNcharOPTNONE

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

mnOverPaymentDBAPDBAMATH_NUMERICOPTNONE

A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are 
numbered from 1000 to 9999.

cPrintVertexReportEV01charOPTNONE

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

cEEGrossToNetErrorEV02charOPTNONE

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

mnHoursWork_PHRWPHRWMATH_NUMERICOPTNONE

The number of hours associated with each transaction.

mnBatchNumber_ICUICUMATH_NUMERICOPTNONE

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either 
assign a batch number or let the system assign it using the Next Numbers program.

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.

szDBAOverrideInstrucCacheNamePIDcharOPTNONE

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.

mnAmountNetPay_NPAYNPAYMATH_NUMERICOPTNONE

The net amount of the payment. Before the net-deduction phase of the pre-payroll process runs, this amount equals gross pay, less taxes, 
less deductions that are based on gross pay. After the net-deduction phase, this amount represents the true net pay. For additional information 
that is related to this calculation process, see data items NPY1 and DESQ.

mnOverridePayType_PDBAPDBAMATH_NUMERICOPTNONE

A code that defines the type of pay, deduction, benefit, or accrual. Pay types are numbered from 1 to 999. Deductions and benefits are 
numbered from 1000 to 9999.

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.

szTaxAreaResidenceTARRcharOPTNONE

A code that identifies both the geographical location and the tax authorities for the employee's residence. Authorities include employee 
and employer statutory requirements. This code is synonymous with GeoCode. Refer to Vertex System's Master GeoCode File for valid codes 
for your locations.

jdDateBirthDOBJDEDATEOPTNONE

The employee's date of birth.

cWorkTaxAreaSourceNScharOPTNONE

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, 
employee labor rules or employee master to determine Tax Area.    E Always use the Work Tax Area from the employee master on time 
record. When blank the system assumes N.

cResidencyStatus12WSPScharOPTNONE

A value that identifies out-of-state employees for whom an employer must withhold tax for the state of residence. Valid values are: N 
(Default) The system uses the employee residence state to calculate taxes. Because the work state has a reciprocal agreement with the employee 
state of residence, the system uses the employee residence state from the Employee Master Information table (F060116).  W The system 
uses only the work state to calculate taxes.

cEarnIncomeCredStatusEICcharOPTNONE

A code that specifies whether the employee qualifies for the earned income credit and elects for the employer to give him or her the 
advance. Valid values are:    N The employee does not qualify (default).    Y The employee qualifies and the employee is single/head of 
household.    M The employee qualifies and is married without spouse filing certificate.     B The employee qualifies and his or her spouse also 
qualifies.

cSourceofSUIReportingSUIcharOPTNONE

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 
work state, regardless of where the employee worked. FUI is calculated in the same state where SUI is calculated. Weeks Worked are the 
number of weeks the employee worked in the taxed state.  Valid values are:    N   Use the work tax area in the time entry record to determine 
SUI. This is the default value.    R   Always use residence tax area from Employee Master table even if the time entry record is different.    W  
Always use work tax area from Employee Master table even if the time entry record is different.

mnSchoolDistrictCodeSCDCMATH_NUMERICOPTNONE

A user-defined code in UDC 06/SD that determines the school district tax for taxation purposes. Vertex automatically calculates the school 
district tax. This feature is primarily used by the public sector.

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.

cMaritalStatusTaxMSTXcharOPTNONE

A user defined code (system 06, type MS) that specifies the employees' federal marital status code as retrieved from the W-4 form. This 
code is used in the computation of all federal income tax.  You can add codes if needed.

cMaritalStatusTaxStateMSTIcharOPTNONE

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 
taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

cMaritalStatusResStateRMSTcharOPTNONE

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. 
This code is related to specific VERTEX system codes (see the VERTEX Tax Manual for their explanation). Also, two special codes have 
been provided: one designates single for Federal and married for State, and the other designates married for Federal and single for State.

cLocalAreaMaritalLMSTcharOPTNONE

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) 
payroll taxes associated with the state in which the employee performed work. If you leave this field blank, the Federal status is used.

szTaxOverrideCacheNamePIDcharOPTNONE

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.

mnGrossUpFedRate_RTAMRTAMMATH_NUMERICOPTNONE

A value that is a percentage, a monetary amount, or an hourly rate, depending on where it is used.  Valid values are: 1 For a deduction, 
benefit, or accrual, the meaning of this value depends on the method of calculation.  The method determines whether the deduction is a flat 
monetary amount, a percentage, or a multiplication rate.  Table method DBAs, depending on which table method they use, can either use this 
amount in the calculation or ignore it.  If there are exceptions to the table calculation, you can override the table code in the detail area, set up a 
flat monetary DBA amount, or override the amount with a one-time override for a timecard. 2 For a pay type, amounts entered in this field 
override the hourly rate. 

mnGrossUpStateRate_RTAMRTAMMATH_NUMERICOPTNONE

A value that is a percentage, a monetary amount, or an hourly rate, depending on where it is used.  Valid values are: 1 For a deduction, 
benefit, or accrual, the meaning of this value depends on the method of calculation.  The method determines whether the deduction is a flat 
monetary amount, a percentage, or a multiplication rate.  Table method DBAs, depending on which table method they use, can either use this 
amount in the calculation or ignore it.  If there are exceptions to the table calculation, you can override the table code in the detail area, set up a 
flat monetary DBA amount, or override the amount with a one-time override for a timecard. 2 For a pay type, amounts entered in this field 
override the hourly rate. 

mnGrossUpBillingRate_BLGRTBLGRTMATH_NUMERICOPTNONE

A rate used for the billing of labor services. This rate is often referred to as the billing or recharge rate. The extended amount based on this 
rate will be charged to the primary distribution account on the timecard with an offset being made to an account derived from the Accounting 
Rules table. This rate will not affect the employee's payroll. To allow billing rates in time entry,you must set the employee's record type as 
either 2 or 3 on the Basic Employee Entry form. Enter a rate on any of the following forms to override the rate in the Employee Primary Job table:     
o Pay Rate Information     o Employee Labor Distribution     o Occupational Pay Rates     o Time Entry by Employee     o Time Entry by Job or 
Business Unit     o Daily Timecard Entry     o Time Entry by Employee with Equipment     o Time Entry by Shop Floor Control

cDeductionFactorsDAAFcharOPTNONE

A code which designates the number of periods that the check represents, and therefore the number of periods that the 'Flat Dollar' 
deductions are to apply. This number will be multiplied by the standard deduction amount to come up with the amount to be subtracted from the 
employee's check.

mnGrossUpNetPay_NPAYNPAYMATH_NUMERICOPTNONE

The net amount of the payment. Before the net-deduction phase of the pre-payroll process runs, this amount equals gross pay, less taxes, 
less deductions that are based on gross pay. After the net-deduction phase, this amount represents the true net pay. For additional information 
that is related to this calculation process, see data items NPY1 and DESQ.

mnBenefitCycleBypassCtBCBMATH_NUMERICOPTNONE

The number of pay cycles (paychecks) that you want the system to bypass the benefit calculations. Typically, you specify this information 
during the interim check process. If you leave this value blank when you enter an interim check, the system bypasses the same number of 
cycles that you enter in the Replace Next N Checks field. This number must be equal to or greater than the number of pay bypasses. If you 
specify less than this number, the system bypasses the same number of pay cycles that you entered in the Replace Next N Checks field. When 
you enter a value in this field, the system updates the employee's master record. If you change or delete the other information on the interim 
check,the system does not remove or adjust the bypass count. You must use the Change action on Additional Parameters to change the value 
in the Employee Master table. However, if you delete the interim check the system also deletes the value from the Employee Master table.

mnPayCycleBypassCountPYCBMATH_NUMERICOPTNONE

The number of pay cycles (that is, paychecks) bypassed. This is normally specified during the interim check process and would be used 
for short-term absences such as vacations and jury duty.  A normal paycheck will only be printed for an employee if this number is zero.  For 
Flexible Spending Accounts Auto Deposit Instructions Only: This field is used to provide a count for the number of Pay cycles you want to 
bypass the auto deposit feature so that you can write a manual check. Reasons for bypassing pay periods might be the employee's involvement 
in jury duty, vacation, or leave of absence. 

szAAIJournalsCache_PIDPIDcharOPTNONE

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.

cVacationFactorsAAFcharOPTNONE

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 
payroll tax program to treat the pay as a vacation advance. The computed taxes are automatically averaged over the number of pay periods. 
See the Vertex system manual for an explanation of the method of calculating tax on vacation advances.

iNumberOfPayPeriodsINT01integerOPTNONE

Number of Days in Future to Query for Responses Due. 

cLastPeriodOfMonthEV01charOPTNONE

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

Related Functions

None

Related Tables

None