GetPRTransConstantsInfo

F069166 Retrieve Payroll Transaction Constants

Minor Business Rule

Object Name: N48S0370

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D48S0370 - Gets Payroll Transaction Constants Information

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberPayeeANN8MATH_NUMERICOPTOUTPUT

The address book number for the supplier who receives the final payment. In Benefits administration, this is the address book number of the 
company that issues the plan and receives premium payments for it. For wage attachments, payee is the address book number of the 
agency, company, individual, or court that is to receive the payment of the check.

szNameAlphaExplanationEXAcharOPTOUTPUT

A description, remark, explanation, name, or address.

szDescripCompressedDCcharOPTOUTPUT

The compressed description contains the alpha name without slashes, dashes, commas, and other special characters.  The compressed 
description is the field used in the Name Search.

szDeductBenefitSourcePGRPcharOPTOUTPUT

This code designates the source of a deduction/benefit/accrual.     o  C indicates that it was computer generated during the prepayroll 
process     o  CD indicates that it was computer generated during the daily post     o  M indicates that it was manually entered on a time entry screen  
   o  P indicates that it was an arreared pre-tax deduction During a rerun of a prepayroll, only those deductions that are computer generated 
will be recalculated.  Warnings: A computer generated entry will have its code changed to M if it is called up on a time entry screen and then a 
change (C) action code is used. Therefore, delete any deduction/benefit entries you would want re-computed in the next prepayroll rerun. If 
a deduction/benefit/accrual is removed from the source table (that is, the Union Benefits Master or Employee Instructions), the calculated 
entry will not automatically be removed from the employee on the prepayroll rerun.

cGrossPayEffectPAYGcharOPTOUTPUT

A code that indicates whether the pay type is added to, subtracted from, or does not affect the employee's gross pay. Valid values 
are: + Pay type will be added to the employee's gross pay. - Pay type will be subtracted from the employee's gross pay. Blank Pay type will not have 
an effect on the employee's gross pay.  A pay type should not have a negative effect on gross pay. If you set up a pay type to have a negative 
effect on gross or net pay, gross-to-net errors appear on the Payroll Register.  PeopleSoft recommends that you set up a deduction instead 
of a pay type that would have a negative effect on gross pay. When you set up a pay type with no effect on gross pay and a positive effect 
on net pay, do not create a separate check. Creating a separate check will cause a gross-to-net error.

cNetPayEffectPAYNcharOPTOUTPUT

A code that indicates whether the pay type is added to, subtracted from, or does not affect the employee's net pay. Valid values are:    +        
Pay type will be added to the employee's net pay    -         Pay type will be subtracted from the employee's net pay    blank Pay type will not 
have an effect on the employee's net pay  A pay type should not have a negative effect on net pay. If you set up a pay type to have a negative 
effect on gross or net pay, gross-to-net errors appear on the Payroll Register. J.D.Edwards recommends that you set up a deduction instead 
of a pay type that would have a negative effect on gross pay. When you set up a pay type with no effect on gross pay and a positive effect 
on net pay, do not create a separate check. Creating a separate check will cause a gross-to-net error.

szBenefitDeductionTableDTABcharOPTOUTPUT

The table used if the calculation requires table values.

szW2sSpecialHandlingSPW2charOPTOUTPUT

A code that is used to group similar DBAs in Box 12 of the W-2.  For example, to group all 401(k) deductions on a W-2, enter D for all 401(k) 
DBAs.  You must also enter all the deductions into the Special Handling Table that you have set up for Box 12.  When W-2s are created, all 
the DBAs that have D for this code are totaled and appear as one item in Box 12 with D to the left of the item, and the Deferred Compensation 
box is marked with an X. These codes are IRS-defined (A-T), and are supplied by PeopleSoft in user defined codes (07/S2).

cPayBasisPBcharOPTOUTPUT

A user defined code (07/PB) that defines the value upon which the system bases the employee's pay.  H (hours worked) is the default 
value.  Other valid values exist for tip and piecework processing, and for Canadian lump-sum amounts, irregular commissions, and bonuses.  
Use E (estimated pay) for an advance pay interim check.  The Interim Check program (Format 2) automatically deletes this type of timecard so 
that you can enter the actual time when it is known.

cDeductionBasisDESQcharOPTOUTPUT

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.

cVoluntaryDeductionFlagMVcharOPTOUTPUT

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.

cTransactTypeTimePayDISOcharOPTOUTPUT

A code used to distinguish between the following types of payroll entries: P Time Cards (Earnings)   D Deductions withheld   B Benefit (both 
cash and non cash)   A Accrual of sick, vacation, comp, and so forth  Note: These codes may only be changed by J.D. Edwards If you enter an * 
in this field the system displays all four types of PDBAs.

mnPayDeductBenAccTypePDBAMATH_NUMERICREQINPUT

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.

cPrintOnPaycheckYNPCKcharOPTOUTPUT

A code that identifies whether the PDBA is to be printed on the paystub or whether it is to be printed on a payment that is separate from 
other PDBAs. Valid values for pay types and payroll taxes include:    Y Print on paystub (default)    S Print separate payment (one item per 
payment)    C Print separate payment (C types combined)    N Do not print on paystub Valid values for DBAs include:    Y Print as total deductions 
(default)    S Print separate payment (one item per payment)    C Print separate payment (include detail)    N Do not print on paystub    I Print 
individual DBA codes    T Print by DBA print group  The separate payment feature is not available for any payroll taxes being withheld from the 
employee's payment.

cDeductionBenefitMethodDEDMcharOPTOUTPUT

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.

szUnitOfMeasureUMcharOPTOUTPUT

A user defined code (00/UM) that identifies the unit of measurement for an amount or quantity. For example, it can represent a barrel, box, 
cubic meter, liter, hour, and so on.

mnAmtOrRateRTAMMATH_NUMERICOPTOUTPUT

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. 

mnMultiplierPayTypeMultPAYMMATH_NUMERICOPTOUTPUT

A factor by which the base hourly rate is multiplied to obtain the actual payment hourly rate. For example, you could use 1.5 to designate 
time-and-one-half for overtime pay. 0 is not a valid multiplier. The default value is 1.00.

mnAmtShiftDifferentialSHDMATH_NUMERICOPTOUTPUT

An additional rate, expressed in dollars or percent, added to an employee's hourly rate, depending on the shift worked. This rate can be 
applied in one of two ways, as defined by the Shift Differential Calculation Sequence (data item CMTH).

cShiftDiffCalcSequenceCMTHcharOPTOUTPUT

A code that specifies how the system should calculate shift differential.    1       The pay type multiplier is applied to the shift differential: Gross 
= (rate + shift differential) x (multiplier) x hours.    2       The pay type multiplier is applied only to the hourly rate and does not include the shift 
differential: Gross = (rate x multiplier) + (shift differential) x hours.    Blank The system follows the shift differential method that is associated with the 
pay type from the Pay Type table (F069116). The multiplier is the pay rate multiplier from the Pay Type table (F069116). When the pay rate is 
derived from the Union Rate table, the multiplier is assumed to be 1 as it is built into the table. In this case, all methods produce the same 
result.

mnLimitOnPayPerDollarsPPDLMATH_NUMERICOPTOUTPUT

The maximum amount that can be withheld or accrued in a pay period for a deduction, benefit or accrual. This amount is expressed in 
dollars for deductions and benefits.  For accruals, this amount is expressed in hours.

mnLimitOnMonthlyDollarsMDLMATH_NUMERICOPTNONE

The maximum amount that can be withheld or accrued in a month for a deduction, benefit or accrual. This amount is expressed in dollars for 
deductions and benefits.  For accruals, this amount is expressed in hours.

mnLimitOnAnnualDollarsADLMATH_NUMERICOPTNONE

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.

mnLimitOnPayPeriodPerPPPLMATH_NUMERICOPTNONE

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.

mnNoOfDeductionPeriodsNPMATH_NUMERICOPTNONE

The number of periods for which a deduction or benefit should be taken. The system automatically decreases this number by one for each 
period taken. You must enter a value in this field if you automate the Number of Periods field. For PeopleSoft World: Enter a value in this field if 
you entered Y (Yes) in the Use Number of Periods field on the DBA Additional Information form.

mnAmountDueADMATH_NUMERICOPTNONE

The balance or amount due on an open invoice or voucher.  In the Address Book Master file (F0101), this is a memo amount field used to 
determine if a particular order exceeds a credit limit.  See the documentation for the Order Processing system. 

cAccruCarryovrOfAvailACOcharOPTNONE

This code is internally set by the system during DBA Setup. If a DBA has related pay types the code is set to Y. This tells the system that 
this is the available DBA. All other DBAs will have a code of N.

cSalesTypeAIcharOPTNONE

The following are the valid sale types:    C Cash    G Charge    S Sales    O Others

mnHoursMinimumAllowedHMINMATH_NUMERICOPTNONE

The minimum number of hours worked or pieces produced in order for a DBA to be calculated. If the number of hours worked or pieces 
produced is less than this amount, the system assumes zero hours when it calculates the DBA. The system uses this field only if the method of 
calculation is H or I.

mnHoursMaximumAllowedHMAXMATH_NUMERICOPTNONE

The maximum number of hours worked or pieces produced that a DBA can be based on. If the actual hours worked or pieces produced 
are greater than the specified maximum, the system bases the calculation on the maximum. The system uses this field only if the method of 
calculation is H or I.

cIncludeInAutoPayCodeIIAPcharOPTNONE

A code that determines how the system treats this pay type when computing automatically generated pay (typically for salaried 
employees). It also identifies supplemental pay. Valid codes are:    Y The dollars with this pay type are part of the employee's base pay, for example, 
regular, holiday, sick, and vacation pay.    N The dollars with this pay type are in addition to the employee's base pay, for example, overtime 
pay and time off without pay.    S The hours with this pay type are subtracted from the employee's base pay at standard rate and added back 
at the entered pay rate.    B The dollars with this pay type are in addition to the employee's base pay and are treated as supplemental pay 
for taxation purposes, for example, bonuses, commissions, and payoffs. Canadian bonuses, irregular comissions, and lump sums use auto 
pay method B.    C The hours or dollars entered using this pay type override all autopay instructions. For World: If multiple jobs are used, a Y in 
this field might cause the pay type to be paid in addition to the regular pay. For example, if the job code, job step,home business unit, or 
position have been overridden in time entry, and if multiple active jobs exist for the employee, and if the overridden information does not match 
an existing active job record, this system processes pay types with the Auto Pay Method set to Y as additional pay. J.D. Edwards 
recommends that you always use a pay type with N in this field when paying someone for work in addition to their regular pay. This ensures that the 
system processes the pay type the same in multiple-job or single-job situations. If your company docks employees' pay when they take leave in 
excess of what has been earned, you should have pay type 997 set up as the pay type to dock pay. Enter N as the autopay method for this 
pay type. If your company attaches contract calendars to employees to accumulate wages,you should have pay type 996 set up as the pay 
type to accumulate wages. Enter C as the autopay method for this pay type.

cDeductionPeriod001DEP1charOPTNONE

A code designating the pay period in which the system calculates the DBA/auto deposit.  Valid codes are: Y Take the DBA/auto deposit 
during the current period. N Do not take the DBA/auto deposit during the current period. * Take the DBA/auto deposit only during the first pay 
period for each month the employee works based on the ending date of this month's pay period. blank Continue to look for a code at the lower 
level.  The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA master level.  If 
the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M Applies only to benefits based on gross 
hours or dollars.  An M in the fifth field only tells the system to calculate the benefit during the special timecard post.  An M implies a Yes for a 
weekly withholding frequency.

cDeductionPeriod002DEP2charOPTNONE

A code designating the pay period in which the system calculates the DBA/auto deposit.  Codes are: Y  Take the DBA/auto deposit during 
the current period. N  Do not take the DBA/auto deposit during the current period. *        Take the DBA/auto deposit ONLY during the first pay 
period for each month the employee works based on the pay-period-end-date month. Blank  SPECIAL MEANING:  Continue to look for a code 
at the lower level.  The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA 
master level.  If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M  SPECIAL MEANING:  
Applies only to benefits based on gross hours or dollars.  An M in the fifth field only tells the system to calculate the benefit during the daily 
timecard post.  An M implies a yes for a weekly withholding frequency.

cDeductionPeriod003DEP3charOPTNONE

A code designating the pay period in which the system calculates the DBA/auto deposit.  Codes are: Y  Take the DBA/auto deposit during 
the current period. N  Do not take the DBA/auto deposit during the current period. *        Take the DBA/auto deposit ONLY during the first pay 
period for each month the employee works based on the pay-period-end-date month. Blank  SPECIAL MEANING:  Continue to look for a code 
at the lower level.  The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA 
master level.  If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M  SPECIAL MEANING:  
Applies only to benefits based on gross hours or dollars.  An M in the fifth field only tells the system to calculate the benefit during the daily 
timecard post.  An M implies a yes for a weekly withholding frequency.

cDeductionPeriod004DEP4charOPTNONE

A code designating the pay period in which the system calculates the DBA/auto deposit.  Codes are: Y  Take the DBA/auto deposit during 
the current period. N  Do not take the DBA/auto deposit during the current period. *        Take the DBA/auto deposit ONLY during the first pay 
period for each month the employee works based on the pay-period-end-date month. Blank  SPECIAL MEANING:  Continue to look for a code 
at the lower level.  The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA 
master level.  If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M  SPECIAL MEANING:  
Applies only to benefits based on gross hours or dollars.  An M in the fifth field only tells the system to calculate the benefit during the daily 
timecard post.  An M implies a yes for a weekly withholding frequency.

cDeductionPeriod005DEP5charOPTNONE

A code designating the pay period in which the system calculates the DBA/auto deposit.  Codes are: Y  Take the DBA/auto deposit during 
the current period. N  Do not take the DBA/auto deposit during the current period. *        Take the DBA/auto deposit ONLY during the first pay 
period for each month the employee works based on the pay-period-end-date month. Blank  SPECIAL MEANING:  Continue to look for a code 
at the lower level.  The system searches for DBA/auto deposit rules first at the employee level, then at the group level, and finally at the DBA 
master level.  If the field is blank at all levels, the system does not calculate the DBA/auto deposit in that period. M  SPECIAL MEANING:  
Applies only to benefits based on gross hours or dollars.  An M in the fifth field only tells the system to calculate the benefit during the daily 
timecard post.  An M implies a yes for a weekly withholding frequency.

cDeductionPeriod6DEP6charOPTNONE

A code designating the pay period in which the system calculates the DBA or auto deposit.  Valid codes are: Y  Calculate the DBA or auto 
deposit during the current period. N  Do not calculate the DBA or auto deposit during the current period. *        Calculate the DBA or auto deposit 
only during the first pay period for each month that the employee works based on the ending date of this month's pay period. Blank  Continue 
to look for a code at the lower level.  The system searches for DBA or auto deposit rules first at the employee level, then at the group level, 
and finally at the DBA master level.  If the field is blank at all levels, the system does not calculate the DBA or auto deposit in that period. M 
Use this value only in the fifth period field to calculate the benefit or accrual during the special, or manual timecard post.   M applies only to 
benefits or accruals based on gross hours or dollars.  An M implies a Yes for a weekly withholding frequency.  You should not use this value for 
any DBA with B in the Method of Calculation field.

szTaxExemptTypes01TT01charOPTNONE

You can specify up to 15 tax types for which the respective payroll tax is not to be computed for a pay, deduction, or benefit code. If you 
enter * in the first element of this list, no taxes are computed.

szTaxExemptTypes02TT02charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes03TT03charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes04TT04charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes05TT05charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes06TT06charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes07TT07charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes08TT08charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes09TT09charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes10TT10charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes11TT11charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes12TT12charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes13TT13charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes14TT14charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

szTaxExemptTypes15TT15charOPTNONE

You may specify up to 15 tax types for which the respective payroll tax is NOT to be computed for a pay, deduction, or benefit code. If you 
enter an asterisk (*) in the first element of this list, it signifies that no taxes are to be computed.

cEmployeeMemoHoursFlagNMTHcharOPTNONE

A code that indicates whether the system writes journal entries from the Payroll system to the general ledger, and the method to use. Valid 
values are:      H  Write only hours to the general ledger. This code is valid for generating timecard journals. The code should not be used 
when  journals are generated through the pay cycle.      M  Do not write monetary amounts or hours to the general ledger. Do not calculate 
workers' compensation and general liability.      N  Write monetary amounts and hours to the general ledger.      Y  Write only monetary amounts to 
the general ledger.      W  Do not write monetary amounts or hours to the general ledger, but calculate workers' compensation and general 
liability. Workers'  compensation and general liability amounts will be written to the general ledger.

mnPredecessorDeductionPDEDMATH_NUMERICOPTNONE

A code that identifies another DBA whose limit must be met first before this DBA calculates. For example; deduction 1400 has an annual 
limit of $2,000.00. After this limit is met, deduction 1500 begins calculation and withholding. The DBA number of the predecessor must be lower 
than the successor's number.

mnDeductionPriorityDPRIMATH_NUMERICOPTNONE

If an employee's gross pay does not cover deductions, a code in this field tells the system in what order it should satisfy deductions. Valid 
codes are 0001 through 9999. The system starts with the highest code. For example, 9999 is deducted before 0001.

szDeductionGroupDGRPcharOPTNONE

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. 

cDecliningBalanceDBALcharOPTNONE

A code that indicates whether you want the system to use the Amount Due at the DBA, group, or employee level to determine whether to 
use the specified deduction in a payroll cycle.   Clicking on the field enables the Amount Due field to continue the deduction until the amount is 
zero. When you choose this field, you must also enter a value in the Amount Due field, otherwise the system considers the deduction to be 
cleared or inactive.   If you do not click on this field, the Amount Due will not be used with the specified deduction.   For advance deductions, you 
must click this field. 

cArrearageRulesARRRcharOPTNONE

A code indicating how to adjust deductions when the employee is in a negative pay situation. Valid codes are:  P Do a partial or full 
deduction as needed. This is the default. F Do a full reduction or none at all. N Do not reduce. Q Same as code P. In addition, place the amount in 
arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history.  R Same as code P. In addition, place the 
amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to history.    G Same as code F. In addition, 
place the amount in arrears, but do not apply the limits when collecting the arrearage. Write the arrearage balance to history.    H Same as 
code F. In addition, place the amount in arrears and apply the limits when collecting the arrearage. Write the arrearage balance to 
history. S Same as code P. In addition, place the amount in arrears for the current pay period only but do not apply the limits when collecting the 
arrearage. Do not write the arrearage balance to history. T Same as code P. In addition, place the amount in arrears for the current pay period only and 
apply the limits when collecting the arrearage. Do not write arrearage balance to history. I Same as code F. In addition, place the amount in 
arrears for the current pay period only, but do not apply the limits when collecting the arrearage. Do not write arrearage balance to 
history. J Same as code F. In addition, place the amount in arrears for the current pay period only and apply the limits when collecting the arrearage. Do 
not write arrearage balance to history.

cUseNumberOfPeriodsNPERcharOPTNONE

When you set up a DBA that is not a wage attachment deduction, use this field to indicate whether you want the system to read the Number 
of Periods field to determine if this DBA should be included in the payroll cycle. If you enter a Y, the number of periods must be entered in the 
No. of Deductions field or the system considers the DBA to be inactive. When you set up a wage attachment DBA, leave this field blank. Use 
the Employee Wage Attachment Entry form to enter the number of periods for which the deduction should be taken. For One World valid 
values are: Click on the field if you want the system to read the Number of Periods field and continue the DBA only until the amount due is zero.    
Blank Do not read the Number of Periods field for this DBA. For World, valid values are:    Y        Yes, read the Number of Periods field and 
continue this DBA only until the amount due is zero.    N        No, do not read the Number of Periods field for this DBA.    Blank Do not read the 
Number of Periods field for this DBA.

jdDateServiceSVCDJDEDATEOPTNONE

The service date is a memorandum date to record the date of actual field service or activity.  If left blank, it will default to the General Ledger 
date.

mnLimitOnQuarterlyDlsQDLMATH_NUMERICOPTNONE

The maximum amount that can be withheld or accrued in a calendar quarter for a deduction, benefit or accrual. This amount is expressed in 
dollars for deductions and benefits.  For accruals, this amount is expressed in hours.

cSickVacationHolidaySVHcharOPTNONE

A user defined code (system 06, type SV) that specifies whether the benefit or accrual type is sick, vacation, holiday, leave, or other.

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.

cPayTypeCategoryPTCTcharOPTNONE

A user defined code (07/PC) that specifies the pay type categories you want to use:     o For regular pay     o To generate overtime     o For 
reporting purposes on the Certified Payroll Register (U.S. only).

mnCobraPlanEquivCPEMATH_NUMERICOPTNONE

A code to designate if a DBA is valid for COBRA. Valid vlaues are:    0   No    1   Yes

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.

mnAccrualEquivalentACEQMATH_NUMERICOPTNONE

The number of the Accrual or Pay Type which will be used in rolling one balance into the other or calculating the 'Remaining Balance' for 
Sick,Vacation or Holiday time.

mnAnnualLimitLevel2SADLMATH_NUMERICOPTNONE

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: This field represents the second level annual limitation. It is 
used when there is an initial annual limit which has been reached.  The DBA will calculate using amount rate 2.

mnSubsequentDeductionSDEDMATH_NUMERICOPTNONE

Deduction Number - Subsequent

mnAmountOrRateSecondAMTSMATH_NUMERICOPTNONE

The second amount or rate associated with a deduction, benefit, or accrual. Because many DBA types require multiple tiers, two levels of 
Amount (Rate) exist. The system uses the first level, Amount (Rate) 1, until the annual limit is reached. Then, the second level, Amount (Rate) 2, 
begins the next time the employee is paid. Amount (Rate) 2 continues until the second annual limit is reached. This field works in conjunction 
with the annual limit fields. The rate you enter in this field supersedes any other table rate for an employee, except for one-time overrides 
during time entry.

szTransReportCodesPR01charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes02PR02charOPTNONE

This code is used for Tip processing employees only.  If a code 'MIN' is here, the DBA is a company required deduction and cannot bring 
the employee below minimum wage.  If the employee is below minimum wage and one or more of this type of deduction exist, they will be 
backed out first to get the employee up to minimum wage.

szTransReportCodes03PR03charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes04PR04charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes05PR05charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

cAutoSetUpFlagTASFcharOPTNONE

A code that indicates which history file the system uses for DBA limits.  Values are: Blank  The system applies monthly, quarterly and annual 
limits to calendar month history. The system stores fiscal and anniversary history by pay period ending date. Table F06145 (Calendar 
Month DBA Summary History File) will be updated (default). 1  The system applies monthly, quarterly and annual limits to payroll month history. 
Use this method for retirement plans such as 401 (k) or RRSP. The system stores fiscal and anniversary history by check date. Table F06146 
(Employee Transaction History Summary) will be updated. 2  The system applies monthly and quarterly limits to calendar month history and 
updates table F06145 (Calender Month DBA Summary History File).  It applies annual limits to fiscal and anniversary history.  It stores fiscal 
and anniversary history by pay period ending date and updates table F06147 (Fiscal and Anniversary Year History). 

cRequiredPlanFlagTRPFcharOPTNONE

A code that specifies whether the DBA is required.  Valid values are: Y Yes  N No For advance deductions, this field must be set to N (no).  
When you enter Y (Yes) in this field, the system automatically processes the DBA for all qualifying employees. When this field is set to Y, you 
reduce the information that you must maintain for DBAs that you set up for plans or employees because it is not necessary to define the DBA 
at any level other than the DBA setup level.  To define qualifying employees, complete the following fields on Advanced DBA Information:     
o Employee Pay Class - (SALY)     o Tax Area - (TARA)     o Home Company - (HMCO) A blank in any of these fields will include all 
employees. NOTE: The system also uses Tax Area (TARA) and Home Company (HMCO) as screening criteria for DBAs that are not required. If either 
of these two fields contain data, and Calculate for All Employees is set to Y (yes), the system uses the tax areas and home companies to 
qualify employees for the DBA.

cPayTypeHSPSALYcharOPTNONE

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

mnCoverageAmountCOVAMATH_NUMERICOPTNONE

The dollar amount of coverage that this plan provides to every employee enrolled in the plan.

szTransactionIDTRIDcharOPTNONE

Transaction Code Indentifier not currently used.

cTransactionStatusTYSTcharOPTNONE

Trans. Code - Status Code

cBeneficiaryFlagBENFcharOPTNONE

A code that indicates whether beneficiary information is required for employees participating in the plan or plan additional option. Valid 
codes are: Blank No dependent or beneficiary information is required   D Dependent information is required   B Beneficiary information is required

mnMinimumPeriodPercentPPPMMATH_NUMERICOPTNONE

The minimum percentage amount that can be specified for the DBA. The amount of the transaction can never be less than this minimum.

cPriorityEffectEPRIcharOPTNONE

A code that specifies when the system adjusts, or backs an amount out of, deductions. Valid values are: 0 Adjust deductions marked with 0 
before payroll taxes. 1 Adjust deductions marked with 0, then adjust those marked with 1 before payroll taxes. 2 Adjust payroll taxes before the 
deductions marked with 2. (This value is for future use.)

cTerminationFlagPTERcharOPTNONE

An option that specifies whether the pay type will be allocated to the current payroll period for EI calculations. Valid values are: 1 Allocate 
earnings to the end date of current pay period of the current pay run. 0 Do not allocate to the current pay period. Instead, allocate earnings to the 
period in which it was earned.

szSecondaryTableSTABcharOPTNONE

A code that specifies the method under which the DBA is to be calculated.  This calculation table serves as the secondary calculation table 
for the system.  You must enter a code in this field if you enter a code in the secondary method field.

mnCarryoverMaximumCMAXMATH_NUMERICOPTNONE

The maximum amount of dollars or hours that an accrual can have at any one time.   For example, your company might have a vacation 
policy that allows an employee to rollover 40 hours each year, but the accrued balance cannot exceed a total of 300 hours at any one time. The 
system calculates both the payroll cycle and year-end rollover up to the limit, taking into account the amounts that have been used. NOTE:  If 
the system rolls over the accrual at the end of a standard year, it applies the limit against payroll month history.  If it rolls the accrual over at 
the end of a fiscal or anniversary year, it applies the limit against fiscal and anniversary history. 

szRolloverTableRTABcharOPTNONE

This is the identification number of the rollover table that will be used to limit the amount that can be rolled over for an accrual. The limit is 
based on an employee's months of service. For example, the table can be setup so an employee with 0 thru 12 months can roll over up to 40 
hours at year end and an employee with 13 thru 999 can roll over up to 80 hours.

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.

szCompanyHomeHMCOcharOPTNONE

The company number where the employee records generally reside.

szProgramCall1PGM1charOPTNONE

The program name of the external user defined program to be called to execute a special DBA calculation routine.

szProgramCall2PGM2charOPTNONE

The program name of the external user defined program to be called to maintain external tables or definition parameters for a user defined 
DBA calculation.

cTaxAreaDbaTDBAcharOPTNONE

An option used for Year-End purposes only. An option that indicates whether the deduction, benefit, or accrual is to be tracked historically 
by the work state tax area. If Y (Yes), a record is created in the Tax Area Transaction Summary History file (F06148) during final update for 
each tax area that the employee works in a calendar year. If you set this flag to Y (Yes) during the middle of a calendar year, the F06148 will 
contain only partial year information. To create a full year of history in the F06148, the Tax Area History Repost program (P06148) would need to 
be run. This option would need to be set to Y (Yes) if you need to add this DBA back to state reportable wages for specific states only. You 
would typically need to set this flag to Y (Yes) for taxable benefits from which you did not withhold tax.

cCalendarMonthUpdateCMHUcharOPTNONE

This method determines how transition months are stored for calendar month history. Transition months occur when the pay period crosses 
into another month. Valid codes are:    blank This is the default. DBAs are prorated to the pay period ending date and the last day of the 
previous month if timecards exist for both months.    1       DBAs are allocated to the pay period ending date.

szBaseDateFromBDTcharOPTNONE

A code that indicates when you want the fiscal period to begin.

cDbaPeriodSelectDBAScharOPTNONE

A code that indicates whether the deduction, benefit, or accrual should be calculated only once in a pay period if the employee receives 
more than one check.

cUnionDbaUDBAcharOPTNONE

A code that indicates if a DBA is associated with a union or group plan. If you enter Y, the union/group plan, job type, and job step from the 
Employee Master are carried into the DBA Detail table (F0609) when the DBA is created from the Employee DBA Instructions. Adding the 
union/group plan, job type, and job step to a DBA affects the following:    1   Which timecards the DBA is allocated to during the payroll journal 
process. For more information on the allocation, see the help for P062902 (U.S.) or P07290 (Canada).    2   Historical reporting, which uses the 
information for selection purposes.

cAccrualInvestGroupAIGRcharOPTNONE

A user defined code system (06/type AI) that indicates the grouping to be used when balancing accruals for investing in various funds. For 
"split"investments, the total deduction must total 100% of the amount specified. For example, an employee has a 401(k) deduction which has 
been elected to be split three ways:        10%        20%        70%  These "splits" are three additional DBAs. To ensure that the three "splits" (or 
accruals) total 100%, you must:     o Use the same accrual investment group code for all three     o Ensure that the total of the individual 
percentages is 100     o Not use the accrual investment group code on the DBA upon which the splits are based     o Varify that the splits have no effect 
on net or gross     o Verify that the split DBAs are not cash benefits

szTransReportCodes06PR06charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes07PR07charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes08PR08charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes09PR09charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes10PR10charOPTNONE

This ia a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes11PR11charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes12PR12charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes13PR13charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes14PR14charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes15PR15charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes16PR16charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes17PR17charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes18PR18charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes19PR19charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

szTransReportCodes20PR20charOPTNONE

This is a Payroll system category code for Deductions, Benefits and Accruals. You may define the use and description of this code to fit the 
needs of your organization.

cOptionalDbaProcessingODBAcharOPTNONE

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

szSpendingAccountTypeSACCcharOPTNONE

Defines which type of spending account is being used. An example of a spending account type setup might be:    MED   Medical expenses 
spending account (where the annual amount is accrued on Jan 1 or year begin.)    DCR   Dependent care expenses (where accrual of 
available funds is on a pay period by pay period basis.)

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. 

cProcessDuringPrePayrollPPRYcharOPTNONE

A code specifying whether a benefit is calculated during pre-payroll processing.  Valid codes are: Y Yes, calculate the benefit during 
pre-payroll processing. N No, calculate the benefit during the journal entry step of the payroll cycle. In general, all benefits and accruals are 
calculated during the processing of journal entries because they do not affect the gross-to-net calculation.  However, certain benefits, such as group 
life insurance and the corresponding excess life insurance benefit, must be calculated in pre-payroll because they affect the gross-to-net 
calculation. If you want the benefit or accrual to print on the employee's paystub, use Y and complete the Method of Printing field. 

cGenerateVoucherFlagGVCHcharOPTNONE

A code used to determine whether the system should generate a voucher for the DBA, tax, or wage attachment during the final update 
phase of the payroll processing cycle. Valid codes are:  N No, do not generate a voucher      Y Yes, generate a voucher

szPreTaxDeductionPRTXcharOPTNONE

Enter one of the predetermined user defined codes to allow Vertex to use current tax laws in the various jurisdictions to determine whether 
the DBA is pretax in that tax area.  Using these codes eliminates the need to set up tax-exempt status in the P06TAX window or to have multiple 
deductions to accommodate pre-tax status in one state but not another. For Canadian users, code RPP represents Canadian Registered 
Pension Plans (RPP) or Registered Retirement Savings Plans (RRSP). Code UN represents Canadian union dues.  For both US and Canada 
code GTL represents the Fringe Benefit for Group Term Life. In the following example we pass 1000 Gross, and 20 GTL. Tax          Passed   
Taxable   Subject   Adjusted Type        Gross      Gross      Gross     Current Fed With  1000        1000        1020      1000 FUTA        1000        1000        
1000      1000 Soc Sec   1000        1020        1020      1020 Federal Withholding and FUTA will store the Gross that was passed in, while Social 
Security and Medicare will have the Gross adjusted to 1020 so as not to display -20 as excess.  This will cause your Taxable gross to be stored 
in our system as 1020

sz415TestIndicatorF415charOPTNONE

This code is used to indicate whether a particular accrual is used to track the eligible earnings or deferrals necessary for Benefit 
Nondiscrimination Testing.

cCalculateDuringInterimPrCLCIcharOPTNONE

This data item is for future use.

cRolloverYearTypeRYTPcharOPTNONE

This code is used to determine if the accrual or benefit is rolled over at the completion of a standard, fiscal or anniversary year.    blank This 
is the default.  Roll the accrual over at the end of a standard year (December 31, XXXX).    1       Roll the accrual over at the end of the fiscal or 
anniversary year.

szAnniversaryFiscalBeginniAFDTcharOPTNONE

A user-defined code (07/AF) that specifies when the rollover year begins.  If blank, the system rolls the accrual over at the end of the 
standard calendar year (December 31, XXXX).   To specify a fiscal year, enter user defined code FISC.  The system will use the fiscal year setup for 
the employee's home company. To specify an anniversary year, enter any of the other codes in the user defined code table.  For example, 
if you want the rollover year to begin on the employee's date of birth, use code DOB. To create related DBAs, use the same date code on 
both the DBA for the accrual, and the DBA for the available balance. 

szW2SpecialHandlingDescripSHDLcharOPTNONE

A field that has several purposes in the W-2 system.  Valid codes are:  1 The system prints the first three characters of this field as the 
amount description for Special Handling items placed in box 14.  2  Vertex does not calculate all school district taxes.  Some clients have created 
special deductions to withhold these taxes.  You must add a specific description on the school district tax deduction.  This description is 
printed with the tax amount on the W-2.  For school districts, use all four characters of the description.  If the school district is in Ohio, enter the 
four-digit code of the school district here.  3  The first position of the W-2 Special Handling Description field represents the IRS Distribution Code that 
prints in box 7 on the 1099-R form. Enter Code EPP in this field to print excess golden parachute amounts on form 1099-Misc. For PeopleSoft 
EnterpriseOne: The payroll-tax calculation system made by Vertex does calculate all school district taxes.  It is not necessary to create 
special deductions to withhold these taxes. 

cEffectonCheckCHCKcharOPTNONE

A code that specifies the effect a benefit has on gross and net income. Valid values are:  1 A non-cash benefit that is non-taxable. The 
benefit, which is a journal entry only, has no effect on gross or net income. 2 A cash benefit that is taxable. The system adds the benefit to gross and 
net income.  3 A non-cash benefit that is taxable. The system adds the benefit to the taxable gross income, but there is no effect on net 
income other than the tax that is withheld. 4 A cash benefit that is non-taxable. There is no effect on gross income, and the system adds the benefit to 
net income as an adjustment to net pay. In addition, the system adds this type of benefit to gross wages on the payroll register so that gross - 
deductions = net.

szErrorMessageIDDTAIcharOPTNONE

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

Related Functions

None

Related Tables

None