CalculateBenefitDBABasis_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040F - Benefit DBA Basis Calculation

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICREQINPUT

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

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.

jdDateEffectiveRatesEFTJDEDATEREQINPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

mnNextNumberNMATH_NUMERICREQINPUT

The number which the system will use next for automatically assigning numbers. Next numbers can be used for many types of documents 
including voucher numbers, invoice numbers, journal entry numbers, employee numbers, address numbers and so on.  You must adhere to 
the next numbers that have been preestablished unless custom programming has been provided.

mnRtSalarySALMATH_NUMERICOPTINPUT

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

mnWorkHoursPerYearIHMATH_NUMERICOPTINPUT

The number of work hours in the year. When you do not set your payroll company constants to use the Pay Grade Step table as the 
pay-rate source, the system uses this number to compute the hourly rate when you supply the annual salary (or to compute the annual salary when 
you supply the hourly rate). When you set your constants to use the Pay Grade Step table as the pay rate source, the system uses the 
following sequence to search for the standard number of hours that it uses to calculate the salary or hourly rate per pay period:     o Employee entry 
forms (this field)     o Pay Grade Step table (hours per day multiplied by days per year)     o Payroll company constants for the employee's 
company     o Payroll company constants for the default company (company 00000)     o Data dictionary     o System default value of 2080 
standard hours per year

mnFrequencyFREQMATH_NUMERICOPTINPUT

The number of months from the last obligation or action date until the next one. For example, 12 indicates an annual cycle, and 01 indicates 
a monthly cycle.

mnCalculatedGrossPayBWBBMATH_NUMERICOPTOUTPUT

The balance at the beginning of the year for the gross pay associated with a pay, deduction, benefit, or accrual.

mnCalculatedHoursIHMATH_NUMERICOPTOUTPUT

The number of work hours in the year. When you do not set your payroll company constants to use the Pay Grade Step table as the 
pay-rate source, the system uses this number to compute the hourly rate when you supply the annual salary (or to compute the annual salary when 
you supply the hourly rate). When you set your constants to use the Pay Grade Step table as the pay rate source, the system uses the 
following sequence to search for the standard number of hours that it uses to calculate the salary or hourly rate per pay period:     o Employee entry 
forms (this field)     o Pay Grade Step table (hours per day multiplied by days per year)     o Payroll company constants for the employee's 
company     o Payroll company constants for the default company (company 00000)     o Data dictionary     o System default value of 2080 
standard hours per year

cDeductionBasisDESQcharREQINPUT

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.

Related Functions

None

Related Tables

None
CalculateDBAInterfaceToPayroll_C

CalculateDBAInterfaceToPayroll_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040C - Calculate DBA Interface To Payroll

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICREQINPUT

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

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.

mnAmtOrRateRTAMMATH_NUMERICREQBOTH

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. 

jdSalaryPointInTimeDateEFTOJDEDATEOPTNONE

A future date when all changes will take effect or the date when the changes went into effect. If you do not enter a date in this field, the system 
uses the current date as the effective date.

mnAmountGrossAGMATH_NUMERICOPTINPUT

A value that specifies the total amount of the invoice or voucher pay item. The gross amount might include the tax amount, depending on 
the tax explanation code. The system does not decrease the gross amount when payments are applied. When you void a transaction, the 
system clears the gross amount field.

mnAmountHoursCHRWMATH_NUMERICOPTINPUT

Hours - Current Period.

mnAmtGrossPayGPAMATH_NUMERICOPTOUTPUT

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

cErrorCodeERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

mnEnrollmentEventTypeEVETMATH_NUMERICOPTINPUT

A field that indicates the event during which the enrollment occurs. Valid values include:    1   Open Enrollment    2   Enrollment for current plan 
year

jdDateEffectiveRatesEFTJDEDATEREQINPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

jdAgePointInTimeDateEFTOJDEDATEOPTNONE

This parameter is only used for Open Enrollment.  The purpose is to calculate the employees age from 
history as of this date, which is then used to calculate the plan's DBA.  The AGE and FAGE 

specifically are the parameters calculated as of this date.

^

szBenefitDeductionTableDTABcharREQINPUT

The table used if the calculation requires table values.

cDeductionBenefitMethodDEDMcharREQINPUT

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.

mnLimitOnAnnualDollarsADLMATH_NUMERICREQINPUT

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_NUMERICREQINPUT

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.

mnHoursMinimumAllowedHMINMATH_NUMERICREQINPUT

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_NUMERICREQINPUT

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.

cPayFrequencyPFRQcharREQINPUT

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.

mnRtDistributionOrBillPBRTMATH_NUMERICREQINPUT

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

mnRtSalarySALMATH_NUMERICREQINPUT

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

mnRtHourlyPHRTMATH_NUMERICREQINPUT

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_NUMERICREQINPUT

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.

jdDateBirthDOBJDEDATEREQINPUT

The employee's date of birth.

jdDateOriginalEmploymentDSIJDEDATEREQINPUT

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.

jdDateEmploymentStartDSTJDEDATEREQINPUT

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.

jdDateLoaStartsLSDTJDEDATEREQINPUT

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.

jdDateParticipationPADTJDEDATEREQINPUT

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.

mnAnnualSalaryLifeLSALMATH_NUMERICREQINPUT

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.

mnAgeFixedFAGEMATH_NUMERICREQINPUT

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_NUMERICREQINPUT

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.

mnPayPeriodsPerYearPPPYMATH_NUMERICREQINPUT

This is the number of pay periods per year. This value is used in all annualization and deannualization routines.

Related Functions

None

Related Tables

None
CalculatePlanAmount_C

CalculatePlanAmount_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040 - Calculate Plan Amount

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICREQINPUT

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

szPlanIdPLANcharREQINPUT

An abbreviation or number that identifies a specific employee benefit. Examples are:   o  Employee Health Insurance   o  Accidental Death 
and Dismemberment   o  Health Club Expense Reimbursement   o  Employee Stock Appreciation Rights  A benefit plan typically is associated 
with a deduction, benefit, or accrual. For example, a medical plan is a benefit that might also require a deduction to withhold premiums from 
an employee's pay.

szPlanAdditionalOptionAOPTcharOPTINPUT

A code that identifies any additional options available for a benefit plan that have been defined in the Plan Additional Options table 
(F083202). Note: Additional options must have the same provider, policy number, and enrollment and eligibility rules as the benefit plan to which they 
are associated.

jdDateEffectiveRatesEFTJDEDATEREQINPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

mnEnterAmountRatePayrollDedEEAMMATH_NUMERICOPTINPUT

The employee's additional payroll deduction (employee share amount) for optional coverage.

mnEnterAmountRateEmployerCostERAMMATH_NUMERICOPTINPUT

An additional amount that the employer contributes toward the cost of a benefit option. For example, an employer might pay 100.00 toward 
the cost of the option for family medical coverage.

mnEnterAmountRateFlexCostEEPTMATH_NUMERICOPTINPUT

The additional points or credits the employee contributed for optional coverage.

mnEnterAmountRateFlexCreditERPTMATH_NUMERICOPTINPUT

The additional points or credits the employer contributed for optional coverage.

mnCalculatedPayrollDeductionRTA1MATH_NUMERICOPTOUTPUT

This is the plan deduction amount.
^

mnCalculatedEmployerCostRTA2MATH_NUMERICOPTOUTPUT

This is the Employer GL cost of providing the plan for employees.
^

mnCalculatedFlexCostRTA3MATH_NUMERICOPTOUTPUT

This is the Employee Flex Cost of selecting the plan.
^

mnCalculatedFlexCreditRTA4MATH_NUMERICOPTOUTPUT

These are the Employee Flex Credits awarded to the employee for choosing the plan.
^

cDataFieldErrorCodeERRcharOPTOUTPUT

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the 
external parameter data structure of the Data Dictionary Server.

cResetDataFlagRSTHcharOPTINPUT

A code that identifies how to handle future sales when a customer reaches a rebate threshold. Valid values are:    Yes  Reset sales history 
totals (F4078) and rebate paid to date to zero when you create a credit order for the given customer/rebate total.    No    Do not reset sales 
history totals and rebate paid when you create a credit order, but leave them at their current values. You may also use 1 for Yes and 0 for No.

mnNextNumberNMATH_NUMERICREQINPUT

The number which the system will use next for automatically assigning numbers. Next numbers can be used for many types of documents 
including voucher numbers, invoice numbers, journal entry numbers, employee numbers, address numbers and so on.  You must adhere to 
the next numbers that have been preestablished unless custom programming has been provided.

mnEnrollmentEventTypeEVETMATH_NUMERICOPTINPUT

A field that indicates the event during which the enrollment occurs. Valid values include:    1   Open Enrollment    2   Enrollment for current plan 
year

jdSalaryPointInTimeDateEFTOJDEDATEOPTNONE

This parameter is only used for Open Enrollment.  The purpose is to retreive the employees salary 
from history as of this date, which is then used to calculate the plan's DBA.  The SAL, LSAL, and FSAL 

specifically are the parameters retreived as of this date.  If there are not any salary (SAL, LSAL, or 

FSAL) records as of this date, the current value is retreived from the Employee Master Table.

^

jdAgePointInTimeDateEFTOJDEDATEOPTNONE

This parameter is only used for Open Enrollment.  The purpose is to calculate the employees age from 
history as of this date, which is then used to calculate the plan's DBA.  The AGE and FAGE 

specifically are the parameters calculated as of this date.

^

cDetermineRateChangeFlagEV01charOPTINPUT

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

cRateChangeFlagEV01charOPTOUTPUT

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

cDoNotCalculateDBAAmountEV01charOPTINPUT

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

mnPlanEEPayrollDedDBAFDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnPlanERPaidBenDBASDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnPlanEEFlexCostDBAPDDPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnPlanERFlexCreditDBAPDCPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnOptEEPayrollDedDBAFDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnOptERPaidBenDBASDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnOptEEFlexCostDBAPDDPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnOptERFlexCreditDBAPDCPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

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

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

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

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

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

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

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

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

mnPlanOptInfoCacheNumberJOBSMATH_NUMERICOPTBOTH

The job number (work station ID) which executed the particular job.

cPlanTypeCodePLNTcharOPTINPUT

A code which indicates whether the rates are Benefit Plans or COBRA Plans.

Related Functions

None

Related Tables

None
CalculatePlanDBA_C

CalculatePlanDBA_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040A - Calculate DBA Amount Share or Points

Parameter NameData ItemData TypeReq/OptI/O/Both
szInputPlanIdPLANcharREQINPUT

An abbreviation or number that identifies a specific employee benefit. Examples are:   o  Employee Health Insurance   o  Accidental Death 
and Dismemberment   o  Health Club Expense Reimbursement   o  Employee Stock Appreciation Rights  A benefit plan typically is associated 
with a deduction, benefit, or accrual. For example, a medical plan is a benefit that might also require a deduction to withhold premiums from 
an employee's pay.

szInputPlanAdditionalOptionAOPTcharOPTINPUT

A code that identifies any additional options available for a benefit plan that have been defined in the Plan Additional Options table 
(F083202). Note: Additional options must have the same provider, policy number, and enrollment and eligibility rules as the benefit plan to which they 
are associated.

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

jdInputDateEffectiveRatesEFTJDEDATEREQINPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

mnInputOverrideAmtOrRateRTAMMATH_NUMERICREQINPUT

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. 

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

cResultCanNotProcessFlagSFLGcharOPTOUTPUT

A code of V signifies that the record has been processed through the void check program.

szDBANotFoundFlagPEFcharOPTOUTPUT

cDollarYesOrNoEntryYNcharREQINPUT

The Yes or No Entry field is a common single character entry field for simple yes or no responses on prompt screens.

mnNextNumberNMATH_NUMERICREQINPUT

The number which the system will use next for automatically assigning numbers. Next numbers can be used for many types of documents 
including voucher numbers, invoice numbers, journal entry numbers, employee numbers, address numbers and so on.  You must adhere to 
the next numbers that have been preestablished unless custom programming has been provided.

mnInputAddressNumberAN8MATH_NUMERICREQINPUT

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

mnEnrollmentEventTypeEVETMATH_NUMERICOPTINPUT

A field that indicates the event during which the enrollment occurs. Valid values include:    1   Open Enrollment    2   Enrollment for current plan 
year

jdSalaryPointInTimeDateEFTOJDEDATEOPTINPUT

This parameter is only used for Open Enrollment.  The purpose is to retreive the employees salary 
from history as of this date, which is then used to calculate the plan's DBA.  The SAL, LSAL, and FSAL 

specifically are the parameters retreived as of this date.  If there are not any salary (SAL, LSAL, or 

FSAL) records as of this date, the current value is retreived from the Employee Master Table.

^

jdAgePointInTimeDateEFTOJDEDATEOPTINPUT

This parameter is only used for Open Enrollment.  The purpose is to calculate the employees age from 
history as of this date, which is then used to calculate the plan's DBA.  The AGE and FAGE 

specifically are the parameters calculated as of this date.

^

cPlanTypeCodePLNTcharOPTINPUT

A code which indicates whether the rates are Benefit Plans or COBRA Plans.

Related Functions

None

Related Tables

None
DetermineAppropriateDBAs_C

DetermineAppropriateDBAs_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040B - Determine Appropriate DBA's for Plan Amount Calculation

Parameter NameData ItemData TypeReq/OptI/O/Both
mnPlanEEPayrollDedDBAFDBAMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnPlanERPaidBenefitDBASDBAMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnPlanEEFlexCostDBAPDDPMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnPlanERFlexCreditDBAPDCPMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnOptEEPayrollDedDBAFDBAMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnOptERPaidBenefitDBASDBAMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnOptEEFlexCostDBAPDDPMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnOptERFlexCreditDBAPDCPMATH_NUMERICOPTINPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnXrefPlanPayDedDBAFDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnXrefPlanPaidBenDBASDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnXrefPlanFlexCostDBAPDDPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnXrefPlanFlexCrdtDBAPDCPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnXrefOptPayDedDBAFDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee 
contributes by enrolling in the plan. In most cases, this DBA is defined to deduct pay from the enrolled employee's check.

mnXrefOptPaidBenDBASDBAMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the 
employer contributes to the employee enrolled in the plan. In most cases, this DBA is defined as a benefit to add pay to the enrolled employee's 
check.

mnXrefOptFlexCostDBAPDDPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee 
contributes by enrolling in the plan in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two requirements: 1. 
  The DBA must have blanks in the specification for Gross Effect and Net Effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry (Y/N/M) 
(see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

mnXrefOptFlexCrdtDBAPDCPMATH_NUMERICOPTOUTPUT

The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer 
contributes to an employee enrolled in a flexible spending environment. DBAs used for points in a benefit plan or option must meet two 
requirements: 1.   The DBA must have blanks in the specification for gross effect and net effect (see data items PAYG and PAYN) so that the use of 
(non-dollar) points does not add or subtract dollars from employee pay. 2.   The DBA must have an M in the specification for Journal Entry 
(Y/N/M) (see data item NMTH) so that the use of (non-dollar) points does not affect the G/L system.

Related Functions

None

Related Tables

None
DetermineIfValidBenefitDBA_C

DetermineIfValidBenefitDBA_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040E - Determine If Valid Benefit DBA

Parameter NameData ItemData TypeReq/OptI/O/Both
cTransactTypeTimePayDISOcharOPTINPUT

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.

mnPredecessorDeductionPDEDMATH_NUMERICOPTINPUT

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.

cUseNumberOfPeriodsNPERcharOPTINPUT

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.

cDecliningBalanceDBALcharOPTINPUT

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. 

cGrossPayEffectPAYGcharOPTINPUT

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.

cNetPayEffectPAYNcharOPTINPUT

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.

cDeductionBasisDESQcharOPTINPUT

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.

cDollarYesOrNoYNcharOPTINPUT

The Yes or No Entry field is a common single character entry field for simple yes or no responses on prompt screens.

cBypassGrossAndHoursCalcEV01charOPTOUTPUT

This flag returns a '1' if the Gross and Hours cannot be calculated for the DBA.  Limit testing 
should be performed next.

^

cDeductPointsDolsYNDPYNcharOPTINPUT

A code that defines whether the combined deduction/benefit amount for this plan contributes to the enrolled employee's reimbursable 
spending account. The code also identifies whether the spending account is for medical or other types of expenses. Valid codes are:    0   Not part 
of a flex plan, not a spending account    1   Not part of a flex plan, a medical spending account    2   Not part of a flex plan, a spending account 
not for medical expenses    3   Part of a flex plan, not a spending account    4   Part of a flex plan, a medical spending account    5   Part of a 
flex plan, a spending account not for medical expenses

cErrorCodeERRCcharOPTOUTPUT

This item returns a 'C' if the DBA cannot be calculated.  
^

Related Functions

None

Related Tables

None
ResetPlanCalculationCache_C

ResetPlanCalculationCache_C

Calculate Plan Amount

Minor Business Rule

Object Name: B0800040

Parent DLL: CHRM

Location: Client/Server

Language: C

Data Structure

DN0800040D - Reset Plan Calculation Cache

Parameter NameData ItemData TypeReq/OptI/O/Both
mnNextNumberNMATH_NUMERICREQINPUT

The number which the system will use next for automatically assigning numbers. Next numbers can be used for many types of documents 
including voucher numbers, invoice numbers, journal entry numbers, employee numbers, address numbers and so on.  You must adhere to 
the next numbers that have been preestablished unless custom programming has been provided.

mnAddressNumberAN8MATH_NUMERICREQINPUT

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

jdDateEffectiveRatesEFTJDEDATEREQINPUT

The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost 
effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.

cResetHistoryFlagRSTHcharREQINPUT

If this is set to '1' the reset will automatically occur.
^

cErrorCodeERRCcharOPTNONE

Not currently used.
^

mnEnrollmentEventTypeEVETMATH_NUMERICREQINPUT

A field that indicates the event during which the enrollment occurs. Valid values include:    1   Open Enrollment    2   Enrollment for current plan 
year

Related Functions

None

Related Tables

None