MainDBACalc

Pre-Payroll DBA Calculation

Minor Business Rule

Object Name: B0700005

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700005G - DS for Main

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICOPTNONE

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

cPayTypeHSPSALYcharOPTNONE

A code that specifies how an employee is paid. Valid codes are: H Hourly S Salaried P Piecework

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. 

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.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

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.

jdDateBeginningEffectiveEFTBJDEDATEOPTNONE

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. 

jdDateEndingEffectiveEFTEJDEDATEOPTNONE

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.

cAdvanceOnPayADVcharOPTNONE

A value of "1" indicates that the transaction has an advance payment on the employee's special process amount.

jdDatePayPeriodEndingPPEDJDEDATEOPTNONE

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

cInterimCheckCodeICCcharOPTNONE

For OneWorld: A code that indicates one of the following conditions:    Blank The payment was processed in a regular payroll cycle.    I         
The payment was processed as an interim. Interim payments can include replacements for both regular voided payments and manually 
voided payments.    X        The payment is an original payment that has been voided. For World: An internal code that indicates one of the following 
conditions:     o The time and pay record is for an interim payment.     o The record in the Payment table (F07350) is an interim payment.     o An 
employee has an interim payment in the Payment table for the current pay period. Valid codes are:    X The payment has been voided.    V 
The payment is a void of a previously-entered payment.    I  The payment was processed as an interim check.    Blank The payment was 
processed in a regular payroll cycle.

cInterimCheckStatusICScharOPTNONE

A code that indicates the type of payment that the system generated. For OneWorld, valid codes are:    A Automatic deposit    C 
Computer-generated payment    V Voided regular payment    M Manually-generated payment    Z Voided manual payment For World, valid codes are:    A 
Automatic deposit    C Computer-generated payment    P Payslip (cash)    M Manually-generated payment    X Voided payment  If the code is M, 
the Automatic Accounting Instruction (AAI) for the payroll manual check bank are used to generate the cash entry. If the code is C or blank, 
the AAI for the normal payroll bank is used.

szPayrollLockoutIdentifiUSRcharOPTNONE

This code is a combination of the IBM user ID and the batch number assigned to a prepayroll selection. It is used to prohibit one employee 
from being processed in more than one concurrent payroll cycle. It also locks out everyone but the user who is running the payroll (or 
prepayroll) from updating the employee's master file or time records until either the the cycle is complete or a reset of the payroll lockout is 
executed.

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.

szGroupLimitsCacheNamePIDcharOPTNONE

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.

szCheckControlNoCacheNamePIDcharOPTNONE

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.

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.

szTransNoDetailCacheNamePIDcharOPTNONE

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.

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.

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.

cPayFrequencyPFRQcharOPTNONE

A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are: B Biweekly   W Weekly   S Semimonthly  
M Monthly   A Annually   C European Annualized  The system uses the value in the Description-2 field on user defined codes to calculate the amount per 
pay period for a salaried employee.

cFloatCodeWETcharOPTNONE

A code that specifies any special circumstances associated with the workers compensation insurance (WCI) code, resulting in multiple 
rates for the same WCI code due to location or risk, for example. The subclass should remain blank if multiple rates do not exist. Default codes 
are: Blank There are no special circumstances associated with this code. F There are special circumstances associated with this code.

szWorkersCompInsurCodeWCMPcharOPTNONE

A user defined code (00/W) that represents a workers' compensation insurance (WCI) code. This code should correspond to the 
classifications on your periodic workers' compensation insurance reports.

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.

cPayPeriodNumberWPPM1charOPTNONE

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.

cPayPeriodNumber2PPM2charOPTNONE

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.

cPayPeriodNumber3PPM3charOPTNONE

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.

cPayPeriodNumber4PPM4charOPTNONE

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.

cPayPeriodNumber5PPM5charOPTNONE

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.

cPayPeriodNumber6PPM6charOPTNONE

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.

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.

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.

szUserIdUSERcharOPTNONE

The code that identifies a user profile.

szWorkStationIdJOBNcharOPTNONE

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

jdDateBirthDOBJDEDATEOPTNONE

The employee's date of birth.

jdDateOriginalEmploymentDSIJDEDATEOPTNONE

The date on which the employee was originally hired by the company. If the employee was terminated and subsequently rehired, the new 
start date will be represented by the data in the Date Started (DST) field.

jdDateEmploymentStartDSTJDEDATEOPTNONE

The date on which the employee actually reported to work for the most recent period of hire. When an employee initially begins working, 
the default is the original hire date. If no original hire date exists, the system uses the current date. This field can be updated multiple times if, for 
example, an employee is a seasonal worker. For the calculation tables in the Payroll system and the eligibility tables and date codes in the 
Human Resources system, the system also uses this date as a start date when it calculates deductions, benefits, and accruals.

mnAgeFixedFAGEMATH_NUMERICOPTNONE

For World: The age of the employee as of a certain date (for example, January 1st) for a given year. You can manually update this field or 
update it each year using the future data facility. For One World: The age of the employee as of a certain date (for example, January 1st) for a 
given year. You can manually update this field or the system can update this field when you run the Update Employee Master Age report 
(R083495).

mnSalaryFixedFSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for a spouse's life insurance premium. Any table method that 
begins with an F uses this field.

mnAnnualSalaryLifeLSALMATH_NUMERICOPTNONE

You can use this field to calculate deductions, benefits, and accruals (DBAs) for an employee's life insurance premium. Any table method 
that begins with an I (Insurance) uses this field.

jdDateLoaStartsLSDTJDEDATEOPTNONE

The date on which an employee's paid or unpaid leave of absence begins. Use this date to indicate the leave for the Family and Medical 
Leave Act.

jdDateParticipationPADTJDEDATEOPTNONE

The date the employee began participating in the company deferred income or stock option plan. This date must be later than the Date 
Started date.

mnRtPieceworkPPRTMATH_NUMERICOPTNONE

The rate paid for the type of component (piece) produced.  If you enter a rate in this field, this rate overrides the rate in the Employee Master 
file.

mnRtSalarySALMATH_NUMERICOPTNONE

The amount that an employee is paid in one year, assuming that the employee is paid every pay period of the year. For WorldSoftware: For 
the employee's primary job, the system stores the annual salary in the Employee Master Information table (F060116) and the Employee 
Jobs table (F060118). For secondary jobs, the system stores the annual salary only in the Employee Jobs table (F060118). Depending on how 
the value that is entered in the Display Salary (Annual/Effective) field in the HR History Constants table (F08040), this field displays one of the 
following:   o  Annual salary. For salaried employees who are not linked with a contract calendar, the user enters the amount or the system 
retrieves the amount from the Pay Grade/Salary Range Table (F082001). For employees who are linked with a contract calendar, the system 
calculates this amount using the following formula: (((current salary minus salary paid before change) divided by number of periods to pay) 
multiplied by pay frequency).   o  Effective salary. For employees whose jobs are linked with a contract calendar, the system recalculates the 
effective salary when you enter a mid-calendar salary adjustment. After you enter a mid-calendar adjustment, the effective salary equals the 
salary that is paid to the employee from the time of the adjustment through the end of the contract. The system calculates this amount using 
the following formula: ((annual salary divided by pay frequency) times periods to pay). 

cGrossoOrNetFlagEV01charOPTNONE

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

cReprocessEmployeeFlagEV01charOPTNONE

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

mnAmountGrossPayTotalGPAYMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is different from the distributed gross pay amount used for labour 
distribution. On Work Order Time Entry, use this field to record miscellaneous pay for an employee, such as piece rate bonus.

mnAmountNetPayTotalNPAYMATH_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.

mnTotalDeductionsTotalTTDEMATH_NUMERICOPTNONE

The total amount of deductions for all payments in this Payroll ID.

mnTotalHoursTotalTTHSMATH_NUMERICOPTNONE

The total number of hours in this Payroll ID.

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.

szNameAlphaSortPALFcharOPTNONE

This field is the first number of character's of an employee's name.

mnAmountMaxNetPayF060116NMAXMATH_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.

mnAmountMaxNetPayF07210NMAXMATH_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.

mnGeneralLedgerBatchGICUMATH_NUMERICOPTNONE

The batch number which has been assigned to the group of Journal Entries generated in the Payroll System. This number ties the entries 
together all of the way through Final Update and into the General Ledger Post program.

cDeductionsNotTakenFlagEV01charOPTNONE

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

cArrearagesTakenFlagEV02charOPTNONE

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

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.

szChildSupportCachePIDcharOPTNONE

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.

mnEndingQuarterMonthDTEMMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable month.  If you leave this field blank, the program uses the system date.

mnEndingYearMonthDTEMMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable month.  If you leave this field blank, the program uses the system date.

mnBeginingYearMonthDTEMMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable month.  If you leave this field blank, the program uses the system date.

mnBeginingQuarterMonthDTEMMATH_NUMERICOPTNONE

A two-digit number that specifies the applicable month.  If you leave this field blank, the program uses the system date.

cJournalsProcessingOptionFlagEV01charOPTNONE

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

mnRtHourlyPHRTMATH_NUMERICOPTNONE

The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the 
value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it 
is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - 
Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.

szUnionCodeF060116UNcharOPTNONE

A user defined code (06/UN) that represents the union or plan in which the employee or group of employees work or participate.

szCostCenterF060116MCUcharOPTNONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szJobCategoryF060116JBCDcharOPTNONE

A user defined code (07/G) that defines the jobs within your organization. You can associate pay and benefit information with a job type and 
apply that information to the employees who are linked to that job type.

szJobStepF060116JBSTcharOPTNONE

A user defined code (07/GS) that designates a specific level within a particular job type. The system uses this code in conjunction with job 
type to determine pay rates by job in the Pay Rates table.

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.

szCompanyCOcharOPTNONE

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.

szCostCenterHomeHMCUcharOPTNONE

The number of the business unit in which the employee generally resides.

szReportingCodesPayro001P001charOPTNONE

A category code that defines payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for information such as Division, Supervisor, Branch office, Health insurance plan, Stock plan, and so on. 
Note: When setting up category codes in the Workforce Management system, you should coordinate information with the payroll department 
to insure that information is not duplicated or overwritten.

szReportingCodesPayro002P002charOPTNONE

A category code which specifies payroll system needs. You may define the use and description of this code to fit your organization.  For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan  Work Force Management: Coordinate the use of this category code with the payroll department.

szReportingCodesPayro003P003charOPTNONE

A category code which specifies payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan   Work Force Management: Coordinate the use of this category code with your payroll department.

szReportingCodesPayro004P004charOPTNONE

A category code which specifies payroll system needs. You can define the use and description of this code to fit your organization. For 
example, you can set up a category code for any of the following categories:   o Division     o Supervisor     o Branch Office     o Health Insurance 
Plan     o Stock Plan   Work Force Management: Coordinate the use of this category code with your payroll department.

szRoutingCodeCheckMAILcharOPTNONE

A user defined code (07/CR) that specifies the check routing or mail-stop code. Use this code to sequence the printing of payroll checks to 
facilitate their handling and delivery.

szProgramPIDcharOPTNONE

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.

cTaxHistoryTypeTHTYcharOPTNONE

A user defined code (07/TH) that specifies the type of information being tracked for the employee in the US Taxation Summary History 
table (F06136) or the Canadian Tax History table (F0713). The value in this field determines what type of year-end form the system generates.

cTerminatedEEPaidFlagEV01charOPTNONE

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

cEmployeePayStatusPASTcharOPTNONE

The code used to indicate whether an employee's pay status is active or inactive. Codes for active pay status employees are numeric, 
and codes for inactive pay status employees are alphabetic. The system omits all employees with alphabetic pay status codes from the 
payroll run. See also Employment Status (EST) and Change Reason (TRS).

jdDateTerminatedDTJDEDATEOPTNONE

The date that the employee was terminated, if applicable.

szCountryForPayrollCCPRcharOPTNONE

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

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.

szDBAOverrideInstructionsCachePIDcharOPTNONE

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.

cRetrievePDBAHistorySysFlagPHISHcharOPTNONE

This option determines how the system retrieves PDBA history for an employee. This value works in conjunction with the Retrieve PDBA 
History System Flag on the Additional Options tab of the Company Options form for Company 0 (zero). If that flag is set to look at each PDBA to 
determine how to retrieve PDBA history, you must enter a value in this field. Valid values are: 1 Retrieve PDBA historical amounts using the 
Corporate Tax ID associated with the Home Company on the employee's timecard. (Default)   2 Retrieve PDBA historical amounts across all 
Corporate Tax IDs for which the employee has history for the current year.

Related Functions

B0700003 Create PrePayroll Caches
B0700017 Payment Shell Record Server
B0700320 Process Child Support Cache
B9800100 Get Audit Information
N0700003 DBA Generic Calculation Functions
N0700004 Calculate Payroll/Calendar Dates
N0700005 Perform Functions and Tests for DBA Calculations
N0700025 TARA - Extract and Combine State, County, City
N0700051 Net/Gross DBA Calculation Module
N0700052 Negative Check Logic Module
N0700180 Wage Attachment Calculation Functions
X00022 F00022 Get Next Unique Key ID

Related Tables

F0005 User Defined Codes
F06106 Employee Pay Instructions
F06146 Employee Transaction History Summary
F069026 Payroll Generic Tables
F069036 Payroll Transaction Cross Reference
F069086 Payroll Corporate Tax Identification
F069106 Union Benefits Master
F069116 Payroll Transaction Constants
F0705 DBA Period Control File
F0709 Deduction/Benefit/Accrual Ledger File
F0729 Employee DBA Override Instructions
F07350 Payment File
F07901 Pre-Payroll DBA Calculation Control Table
ProcessDBACalc

ProcessDBACalc

Pre-Payroll DBA Calculation

Minor Business Rule

Object Name: B0700005

Parent DLL: CPAY

Location: Client/Server

Language: C

Data Structure

D0700005C - DS for Calculate DBAs - Process

Parameter NameData ItemData TypeReq/OptI/O/Both
szDBAAliasCacheNamePIDcharOPTINPUT

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.

cDeductionBenefitMethodDEDMcharOPTINPUT

A user defined code (07/DM) that specifies the method that the system uses to perform certain calculations. For example, the system uses 
a method of calculation to calculate deductions, benefits, and accruals (DBAs) and workers' compensation insurance.

cTypeOfTableTABTcharOPTINPUT

A code that defines the purpose of the table. Valid values are:    D The system uses the table to calculate DBAs.    R The system uses the 
table to determine limits for rolling over sick and vacation accruals.

szDBACacheNamePIDcharOPTINPUT

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.

mnPayrollTransactionNoPRTRMATH_NUMERICOPTINPUT

A unique number that the system assigns to each timecard. You can use this field in the Time Entry By Job program to retrieve a specific 
timecard for display. This field is also used to tie a timecard to each Actual Burden audit record created for the timecard during the Actual 
Burden Journaling process.

mnRtBaseHourlyBHRTMATH_NUMERICOPTINPUT

This is the employee's base hourly rate as retrieved from either the Employee Master or the Union Rates Table.  This number would not be 
modified by multipliers, differentials, etc. It is saved in the time entry file (F0611) for the express purpose of being able to account for 
premium pay separate from base pay.  (See also: HRT, PWRT, BRT) ***Important Note*** If you change the number of DATA DISPLAY DECIMAL 
digits for the field "PHRT", "SHRT" you MUST also change this field's data display decimals to be the same number.

mnRtDistributionOrBillPBRTMATH_NUMERICOPTINPUT

A number that specifies the rate that the system uses to bill for labor services. This rate is often referred to as the billing or recharge rate. 
The system charges the resulting amount, based on this rate, to the primary distribution account for the timecard. The system also enters an 
offset to an account that is derived from automatic accounting instructions. This rate does not affect employee payroll. To allow billing rates in 
time entry, the employee record type must be set to 2 (payroll and recharge processing) or 3 (recharge processing only) with the Employee 
Payroll program (P0801PRL).

mnPiecesUnitsPCUNMATH_NUMERICOPTINPUT

The number of pieces for piecework or any other unit of measure you want to track for this employee. Examples are:  recording miles driven 
for drivers of company vehicles, cubic yards of concrete, feet drilled, or miles flown and so forth.

mnRtHourlyPHRTMATH_NUMERICOPTINPUT

The employee's hourly rate, which is retrieved during time entry. If you enter a rate in this field on any other form, that rate can override the 
value in the Employee Master table. In the Employee Master table, this number is the employee's base hourly rate. In the Union Rates table, it 
is the straight time rate. NOTE: If you change the number of the data display decimal digits for this field, you must also change fields Rate - 
Base Hourly (BHRT) and Rate - Hourly (SHRT) so that they have exactly the same number of data display decimal digits.

mnRtPieceworkPPRTMATH_NUMERICOPTINPUT

The rate paid for the type of component (piece) produced.  If you enter a rate in this field, this rate overrides the rate in the Employee Master 
file.

mnLimitOnAnnualDollarsADLMATH_NUMERICOPTINPUT

The maximum amount that can be withheld or accrued in a year for a deduction, benefit or accrual. This amount is expressed in dollars for 
deductions and benefits.  For accruals, this amount is expressed in hours. NOTE:  For the Payroll system, this field can represent either an 
initial annual limitation or a final limitation in a year:     o If the Annual (Level 1) field is not blank, this amount represents the first level of the yearly 
limitation. The value in Annual (Level 2) represents the final limitation.     o If an annual limit is specified on a DBA calculation table, the annual 
limit from the table will take precedence over annual limits defined at the master DBA or employee levels.

mnAddressNumberAN8MATH_NUMERICOPTINPUT

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

cPayFrequencyPFRQcharOPTINPUT

A user defined code (07/PF) that indicates how often an employee is paid. Valid codes are: B Biweekly   W Weekly   S Semimonthly  
M Monthly   A Annually   C European Annualized  The system uses the value in the Description-2 field on user defined codes to calculate the amount per 
pay period for a salaried employee.

mnHoursWorkPHRWMATH_NUMERICOPTINPUT

The number of hours associated with each transaction.

mnLimitOnPayPeriodPerPPPLMATH_NUMERICOPTINPUT

The maximum percentage of pay that the calculated deduction or benefit amount may not exceed. This percentage works in conjunction 
with the dollar limits of the deduction or benefit, so whichever limit is reached first stops the calculation. For accrual transactions, this field 
represents an hour's limit.

mnAmtOrRateRTAMMATH_NUMERICOPTINPUT

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. 

szBenefitDeductionTableDTABcharOPTNONE

The table used if the calculation requires table values.

cCalledFromBenefitsFlagEV01charOPTNONE

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

cNextDBAEV01charOPTNONE

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

cGrossoOrNetFlagEV01charOPTNONE

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

cDeductionBasisDESQcharOPTNONE

A user defined code (07/DB) that specifies the basis of a deduction, benefit, or accrual. When the system calculates the gross amount for 
disposable net wages, it does not use the basis of calculation. The gross amount includes all earnings that have a positive effect on the gross 
and net payment. For wage attachments use one of the following codes: 1-8 Garnishment, tax levy, wage assignment (child support and 
maintenance)   R Loan, interest   0 Fees Note:  When using the following codes (L = Prior Year, I= Inception to Date or P = Prior Month), it is required to 
roll over pdba amounts at year end for any pdba code that is included in the basis of calculation.  Rollover (P07390) is required to create 
historical summary records (F06145 or F06146) in the new year that summarize amounts used for these calculations.

mnAmountNetPayNPAYMATH_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.

mnAmountNetPay2NPAYMATH_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.

mnAmountNetPay1NPAYMATH_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.

mnAmountMaxNetPayF060116NMAXMATH_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.

mnAmountMaxNetPayF07210NMAXMATH_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.

cOptionalStateCalcuCALCcharOPTNONE

A code that specifies whether the system calculates a DBA in the absence of gross pay.  Valid values are: Y Yes, calculate this DBA when 
an employee has no gross pay, and no PDBA codes exist in the basis of calculation. N No, do not calculate this DBA when an employee has 
no gross pay, and no PDBA codes exist in the basis of calculation.  Note:  When an employee has no gross pay, the system calculates the 
DBA when the following conditions exist:    o Calculate if no gross is set to Y.    o Source of calculation is set to G.    o Method of calculation is set 
to $. The system then records the resulting amount in arrears and performs one of the following functions:    o Creates an overpayment for a 
deduction.    o Calculates it as a benefit or an accrual. Note:  If PDBA codes exist in the basis of calculation, the system attempts to calculate the 
DBA regardless of this setting. 

mnAliasCacheGrossPayGPAMATH_NUMERICOPTNONE

The actual gross pay amount for an employee. This amount is to be distinguished from the distributed gross pay amount used for labor 
distribution. See data item DPAY. When using Work Order Time Entry, this field is used to record miscellaneous pay for an employee, (for 
example, piece rate bonus).

mnWorkingNetNPAYMATH_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.

mnWorkingTotalDeductionsNetNPAYMATH_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.

cAliasCacheSplitDeductionFlagWAPFcharOPTNONE

Use this code to specify whether a child support deduction amount is divided equally or apportioned among all the families to whom the 
employee is paying child support. This condition occurs when there are multiple child support deductions for one employee, and the 
employee did not earn enough wages to pay all the support payments. Instead of making a payment to only one family, the amount will be allocated 
or divided equally to each of the wage attachment numbers.    Y  Apportion the amount. If one payment was for 100 and another for 200, and 
the employee had only 150 available for the payments, the first family would get 50 and the second family would get 100.    1   Divide the 
amount equally among the families. If one payment was for 100 and another for 200, and the employee had only 150 available for the payments, 
each family would get 75.    N   Do not take other child support payments into consideration. To use the split deduction feature, you must use a 
flat dollar amount method.

szAliasCacheDeductionGroupDGRPcharOPTNONE

Specify a code common to all deductions or benefits that share the same limitations (for example, pay period dollar amount or percentage, 
monthly,annual, and so on).  The system takes these limits from the first deduction encountered in the group, and withholds for all 
deductions until the limit is reached for the aggregate.   Example:  Deduction 6400, Group A, Annual Limit = $1000, No Pay Period Limit  Deduction 6430, 
Group A, No Annual or Pay Period Limit  Deduction 7700, Group A, No Annual or Pay Period Limit  Deduction 9400, Group B, No Annual or Pay 
Period Limit  Deduction 7550, Group B, No Annual Limit, Pay Period Limit = $50  For this example, the system looks at the deductions 
assigned to Group A, and applies a $1000 annual limit for all three deductions. The system continues to take the deductions from an employee's 
paycheck until a total of $1000 has been deducted between all entities in Group A for the year.  For deductions in Group B, the system deducts 
no more than $50 per pay period between for the two deductions. 

cVoluntaryDeductionFlagMVcharOPTNONE

This code designates whether a DBA is subtracted from gross to determine an employee's disposable wages. Valid codes are:    1    
Voluntary. These deductions are subtracted from gross to determine disposable wages for deductions with a Source of Calculation of 1, 5, and 7.   
 2    Mandatory. These deductions are subtracted from gross to determine disposable wages for deductions with Source of Calculation of 1, 
2, 4, 5, 6, and 7.

mnWorkingMandDeductionsMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

mnWorkingVolDeductionsMATH02MATH_NUMERICOPTNONE

- - - Good Performance High Value. 

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.

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.

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.

szCountryForPayrollCCPRcharOPTNONE

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

mnPayDeductBenAccTypePDBAMATH_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.

Related Functions

B0700003 Create PrePayroll Caches
B0700017 Payment Shell Record Server
B0700320 Process Child Support Cache
B9800100 Get Audit Information
N0700003 DBA Generic Calculation Functions
N0700004 Calculate Payroll/Calendar Dates
N0700005 Perform Functions and Tests for DBA Calculations
N0700025 TARA - Extract and Combine State, County, City
N0700051 Net/Gross DBA Calculation Module
N0700052 Negative Check Logic Module
N0700180 Wage Attachment Calculation Functions
X00022 F00022 Get Next Unique Key ID

Related Tables

F0005 User Defined Codes
F06106 Employee Pay Instructions
F06146 Employee Transaction History Summary
F069026 Payroll Generic Tables
F069036 Payroll Transaction Cross Reference
F069086 Payroll Corporate Tax Identification
F069106 Union Benefits Master
F069116 Payroll Transaction Constants
F0705 DBA Period Control File
F0709 Deduction/Benefit/Accrual Ledger File
F0729 Employee DBA Override Instructions
F07350 Payment File
F07901 Pre-Payroll DBA Calculation Control Table