Functional Description
Purpose
This NER determines if an entered Benefit Plan is found in F08320. If the Plan is not found, the NER
returns an error code of '1'. If the record is found, the NER returns an error code of '0' and the
information related to that plan.
Setup Notes and Prerequisites
Special Logic
Technical Specification
szPlanID - Required input field.
cErrorCode values are as follows:
0 = No Errors, Plan found.
1 = Error, Plan not found.
D0800079 - Get Benefit Plan Information
Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
---|---|---|---|---|
szPlanId | PLAN | char | REQ | INPUT |
An abbreviation or number that identifies a specific employee benefit. Examples are:
o Employee Health Insurance
o Accidental Death
| ||||
cErrorCode | EV01 | char | OPT | OUTPUT |
An option that specifies the type of processing for an event. | ||||
szNameAlphaExplanation | EXA | char | OPT | OUTPUT |
A description, remark, explanation, name, or address. | ||||
szDescripCompressed | DC | char | OPT | OUTPUT |
The compressed description contains the alpha name without slashes, dashes, commas, and other special characters. The compressed
| ||||
mnAddressNumberPayee | ANN8 | MATH_NUMERIC | OPT | OUTPUT |
The address book number for the supplier who receives the final payment.
In Benefits administration, this is the address book number of the
| ||||
jdDateEffectiveRates | EFT | JDEDATE | OPT | OUTPUT |
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
| ||||
jdDateEndingEffective | EFTE | JDEDATE | OPT | OUTPUT |
The date on which the item, transaction, or table becomes inactive, or through which you want transactions to appear. This field is used
| ||||
cStatCode | STUS | char | OPT | OUTPUT |
A user defined code (system 08/type ST) that defines the current state of the benefit plan. For example, you can use A to define the plan as
| ||||
szPlanType | PLTY | char | OPT | OUTPUT |
A user defined code (system 08/type PT) that identifies the specific type of plan. For example, L can be used to identify a life insurance
| ||||
cBeneficiaryFlag | BENF | char | OPT | OUTPUT |
A code that indicates whether beneficiary information is required for employees participating in the plan or plan additional option. Valid
| ||||
szCertificateNumber | CERN | char | OPT | OUTPUT |
The certificate or policy number of the benefit plan. | ||||
mnCoverageAmount | COVA | MATH_NUMERIC | OPT | OUTPUT |
The dollar amount of coverage that this plan provides to every employee enrolled in the plan. | ||||
mnPremiumPayment | PREP | MATH_NUMERIC | OPT | OUTPUT |
The premium payment amount that applies to this plan. | ||||
szVestingTable | VTAB | char | OPT | OUTPUT |
A user defined code (table 06/VT) that identifies the table that applies to this plan. | ||||
mnDbaEmployeePercent | EDBA | MATH_NUMERIC | OPT | OUTPUT |
This is the employee percentage for the plan contribution. (50% = .50) | ||||
mnEmployeeDbaId | FDBA | MATH_NUMERIC | OPT | OUTPUT |
The DBA defined in the Payroll Transactions Constants table (F069116) that is used to calculate the dollar amount that the employee
| ||||
mnDbaEmployerPercent | RDBA | MATH_NUMERIC | OPT | OUTPUT |
The Employer Percentage for the plan contribution. | ||||
mnDbaEmployerId | SDBA | MATH_NUMERIC | OPT | OUTPUT |
The DBA defined in the Payroll Transactions Constants table (F069116) that the system uses to calculate the dollar amount that the
| ||||
cMandatoryParticipation | MANP | char | OPT | OUTPUT |
A code that tells indicates whether the plan is required for all employees. Valid codes are:
Y
Yes, all employees must participate in this plan.
| ||||
mnPerCoverageDollars | PCDO | MATH_NUMERIC | OPT | OUTPUT |
The amount of coverage that is paid for by the amount in the Monthly Premium field (data item PREP). For example, a premium charge can
| ||||
mnSalaryFactor | SALF | MATH_NUMERIC | OPT | OUTPUT |
A multiplier (factor) that the system uses to calculate the amount of coverage provided to an employee, based on the employee's
| ||||
szBenefitDeductionTable | DTAB | char | OPT | OUTPUT |
The table used if the calculation requires table values. | ||||
mnPayrollDedPoints | PDDP | MATH_NUMERIC | OPT | OUTPUT |
The DBA defined in the Payroll Transactions Constants file (F069116) that is used to calculate the points amount that the employee
| ||||
mnPayrollCreditPoints | PDCP | MATH_NUMERIC | OPT | OUTPUT |
The DBA defined in the Payroll Transactions Constants table (F069116) that will be used to calculate the points amount that the employer
| ||||
cDeductPointsDolsYN | DPYN | char | OPT | OUTPUT |
A code that defines whether the combined deduction/benefit amount for this plan contributes to the enrolled employee's reimbursable
| ||||
szVestingCalculationRule | VCRL | char | OPT | OUTPUT |
A user defined code to describe the vesting calculation rule. Note: This field is for future use. | ||||
szPtTableVestingHours | PTVH | char | OPT | OUTPUT |
The pay type table used to calculate the hours worked for vesting service. | ||||
mnVestingMinHours | VSMH | MATH_NUMERIC | OPT | OUTPUT |
The minimum number of hours required during a specified period of time to be eligible for a year of vesting service. | ||||
cVestingCompPer | VCPE | char | OPT | OUTPUT |
The computation period used to calculate if a person has fullfilled the minimum requirements to qualify for a year of vesting service.
C
| ||||
szReportCodePlanMstr001 | PH01 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B1. | ||||
szReportCodePlanMstr002 | PH02 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B2. | ||||
szReportCodePlanMstr003 | PH03 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B3. | ||||
szReportCodePlanMstr004 | PH04 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B4. | ||||
szReportCodePlanMstr005 | PH05 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B5. | ||||
szReportCodePlanMstr006 | PH06 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B6. | ||||
szReportCodePlanMstr007 | PH07 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B7. | ||||
szReportCodePlanMstr008 | PH08 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B8. | ||||
szReportCodePlanMstr009 | PH09 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B9. | ||||
szReportCodePlanMstr010 | PH10 | char | OPT | OUTPUT |
A code you can define for reporting on benefit plans. You can define this code using user defined code table 08/B0. | ||||
szEligibilityTable1 | XET1 | char | OPT | OUTPUT |
The table used to specify the rules, if any, for the employee's initial enrollment in the plan.
Even when a plan has no eligibility criteria, J. D.
| ||||
szEligibilityTable2 | XET2 | char | OPT | OUTPUT |
A code used to specify the rules, if any, for an employee's continuing enrollment in the plan.
Even when a plan has no eligibility criteria, J.D.
| ||||
cAmountOrRateYn | EAOR | char | OPT | OUTPUT |
A code that indicates whether you can enter an amount or rate when you enroll an employee in a benefit plan. Typically, you enter Y (yes)
| ||||
cAgeRateFlag | ARFL | char | OPT | OUTPUT |
A code that determines whether the employee's age/salary will be taken as the age/salary at enrollment time or the current
| ||||
szPrerequisitePlan | PPLN | char | OPT | OUTPUT |
The benefit plan, if any, in which the employee must be enrolled before the employee is eligible to participate in this plan. | ||||
mnMaximumPremium | MXPR | MATH_NUMERIC | OPT | OUTPUT |
The maximum premium amount permitted. | ||||
mnRoundingAmount | RNDA | MATH_NUMERIC | OPT | OUTPUT |
The amount that the system uses to round the coverage dollars to the nearest whole number. For example, if the coverage dollars are
| ||||
cTransferToCobra | CBRA | char | OPT | OUTPUT |
A code that specifies one of the following:
o Whether the system should place an employee being terminated from the plan in COBRA
o
| ||||
szSecondary401kPlan | PLN2 | char | OPT | OUTPUT |
Secondary 401(k) Plan. | ||||
cFlexibleSpendingAcct | FSAF | char | OPT | OUTPUT |
A code that determines whether or not the combined deduction/benefit amount for this plan will contribute to the reimbursable spending
| ||||
mnPayTypeForFlexibleSpending | PAYF | MATH_NUMERIC | OPT | OUTPUT |
This is the Pay Type used when making reimbursements from the Flexible Spending Accounts.
Note: It is Critical that the Category Code 10
| ||||
cEePointsAllowanceFor | FLXA | char | OPT | OUTPUT |
This flag is used to identify the EE Points that are given to the employee so they can "purchase" the benefits that they want.
For instance, if a
| ||||
szPrerequisitePlanType | PLTZ | char | OPT | OUTPUT |
The Plan Type code which is a prerequisite for an employee to be eligible to enroll in this plan. | ||||
cFlagEmployeeEmployer | EFL1 | char | OPT | OUTPUT |
Indicate whether this DBA is an employee or employer contribution. | ||||
cFlagEmployeeEmployer2 | EFL2 | char | OPT | OUTPUT |
Indicate whether this DBA is an employee or employer contribution. | ||||
cFlagEmployeeEmployer3 | EFL3 | char | OPT | OUTPUT |
Indicate whether this DBA is an employee or employer contribution. | ||||
cFlagEmployeeEmployer4 | EFL4 | char | OPT | OUTPUT |
Indicate whether this DBA is an employee or employer contribution. | ||||
cFlagPointsMoney | EFP1 | char | OPT | OUTPUT |
Indicate whether this DBA represents a point value or a monetary value. | ||||
cFlagPointsMoney2 | EFP2 | char | OPT | OUTPUT |
Indicate whether this DBA represents a point value or a monetary value. | ||||
cFlagPointsMoney3 | EFP3 | char | OPT | OUTPUT |
Indicate whether this DBA represents a point value or a monetary value. | ||||
cFlagPointsMoney4 | EFP4 | char | OPT | OUTPUT |
Indicate whether this DBA represents a point value or a monetary value. | ||||
cFlagRateEntry | EFR1 | char | OPT | OUTPUT |
A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily
| ||||
cFlagRateEntry2 | EFR2 | char | OPT | OUTPUT |
A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily
| ||||
cFlagRateEntry3 | EFR3 | char | OPT | OUTPUT |
A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily
| ||||
cFlagRateEntry4 | EFR4 | char | OPT | OUTPUT |
A code that indicates whether you are allowed to enter an amount or rate during employee benefit enrollment. This code is used primarily
|
None |
None |