EmployeeBenefit

The business object Employee - benefits contains information on
the benefits plans offered by the employer and selected by the employee.
An employee - benefits contains several items.


Comment
An employee may select a benefits plan per benefits plan type from the
benefits program that is valid for him or her.

Example
Benefits for the employee Peter Moore:

Valid from January 1, 1990 to December 31, 9999:

Item 1
"General medical care" benefits plan type:
Standard Medical Plan without deductible for the employee and his
entire family

The following are also covered:
Spouse, Donna Moore
1st child, Steven Moore
2nd child, Harry Moore

Item 2
"Dental care" benefits plan type:
Dental Care without deductible for the employee and his entire family

The following are also covered:
Spouse, Donna Moore
1st child, Steven Moore
2nd child, Harry Moore

Item 3
"Vision care" benefits plan type:
Vision Care without deductible for the employee and his entire family

The following are also covered:
Spouse, Donna Moore
1st child, Steven Moore
2nd child, Harry Moore

Item 4
"Life insurance" benefits plan type:
Eagle Star 2x salary life insurance

The beneficiary is the spouse, Donna Moore

Available Methods

• CheckSelection : Consistency check [ BAPI_BEN_BUS3029_CHECK_SELECT ]
  
• CreateOffer : Define benefits offer [ BAPI_BEN_BUS3029_GET_OFFER ]
  
• CreatePlans : Enroll employee [ BAPI_BEN_BUS3029_CREATE_PLANS ]
  
• DeletePlans : Cancel EE enrollment [ BAPI_BEN_BUS3029_DELETE_PLANS ]
  
• GetCorequisitePlans : Determine plans required simultaneously [ BAPI_BEN_BUS3029_GET_COREQ ]
  
• GetEventList : Determine the currently valid events of an employee [ BAPI_BEN_BUS3029_GET_EVT_LIST ] (Obsolete in 40C)
  
• GetOffer : Define benefits offer [ BAPI_BEN_BUS3029_GET_OFFER ] (Obsolete in 40C)
  
• GetOpenEnrollmentPeriod : Check if open enrollment period exists and period is indicated [ BAPI_BEN_BUS3029_GET_OPEN_PERI ] (Obsolete in 40C)
  
• GetParticipation : Benefit participation of an employee [ BAPI_BEN_BUS3029_GET_PARTICIP ]
  

CheckSelection

This function module is used as the basis for the BAPI method EmployeeBenefit.CheckSelection.

This method checks that the elections made for the employee areconsistent with what is permitted by company rules. ALL elections must be correct for the method to approve the entries.

The main checks that the method makes are that:

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

CreateOffer

This function module is used as the basis for the BAPI method EmployeeBenefit.CreateOffer.

This method creates and delivers a Benefits Offer for the employee on aspecified date. The Offer is a list of plans with their options of all categories, which the employee is eligible for.

Before it creates an offer, the method considers the following:

1. If it is an Adjustment reason enrollment, and the employee has a validadjustment reason on the specified date, depending on the adjustmenttype, certain restrictions on possible changes and enrollments apply to the offer made.


2. If it is an Open enrollment, the offer allows all enrollments and changes, according to standard eligibility.
3. If it is Default enrollment, the offer allows only the default plans defined for the employee.
4. If it is Automatic enrollment, the offer allows only the default plans defined for the employee.


5. If none of these is the case, no offer is made.

The validity dates of the employee enrollments created are as follows;

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

CreatePlans

This function module is used as the basis for the BAPI method EmployeeBenefit.CreatePlans.

This method writes the employee's elections to the database.

Notes

Prior to this method, SAP recommends that you use the methodEmployeeBenefit.CheckSelection, which is a consistency check for the elections the employee has made.

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

DeletePlans

This function module is used as the basis for the BAPI method EmployeeBenefit.DeletePlans.

This method delimits on the database the employee enrollments. This deletion is done precisely for the period specified.

Example

An employee has two enrollments in the Standard Medical plan, one for
1997 and another for 1998. The employee then decides in October 1997,due to an active adjustment reason, to cancel his enrollment in theStandard Medical plan. The employee cancels the plan for the remainderof 1997. The method EmployeeBenefit.DeletePlans thus deletes the
enrollment from October 1997 until the end of the year. The enrollmentfor 1998 remains and becomes valid at the start of the following year.

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

GetCorequisitePlans

This function module is used as the basis for the BAPI method EmployeeBenefit.GetCorequisitePlans.

Certain plans within the complete benefits offer specify other plans inwhich the employee must also concurrently enroll. These are known as corequisite plans and are delivered by this method.

The method uses the plans detailed in the complete benefits offer to fetch corequisites for these plans.

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

GetEventList

This function module is used as the basis for the BAPI method EmployeeBenefit.GetEventList.

This method delivers a list of all active benefits adjustment reasonsfor an employee on the date specified. Active adjustment reasons allowemployees to make changes to their benefits elections, which are otherwise not usually allowed.

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

GetOffer

This function module is used as the basis for the BAPI method EmployeeBenefit.CreateOffer.

This method creates and delivers a Benefits Offer for the employee on aspecified date. The Offer is a list of plans with their options of all categories, which the employee is eligible for.

Before it creates an offer, the method considers the following:

1. If it is an Adjustment reason enrollment, and the employee has a validadjustment reason on the specified date, depending on the adjustmenttype, certain restrictions on possible changes and enrollments apply to the offer made.


2. If it is an Open enrollment, the offer allows all enrollments and changes, according to standard eligibility.
3. If it is Default enrollment, the offer allows only the default plans defined for the employee.
4. If it is Automatic enrollment, the offer allows only the default plans defined for the employee.


5. If none of these is the case, no offer is made.

The validity dates of the employee enrollments created are as follows;

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

GetOpenEnrollmentPeriod

This function module is used as the basis for the BAPI method EmployeeBenefit.GetOpenEnrollmentPeriod.

This method delivers the dates of the open enrollment period, for anemployee on a specified date. The method also delivers IF the specifieddate falls within the open enrollment period. In this period, the employee can make changes to future benefit enrollments.

Example

On July 1st 1997, the open enrollment period for Julie Watanabe isSeptember 1st to October 15th. However on August 1st, company policychanged and shortened the open enrollment period to September 1st toSeptember 30th. Thus on August 2nd, the open enrollment period for Julie Watanabe is September 1st to 30th.

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.

GetParticipation

This function module is used as the basis for the BAPI method EmployeeBenefit.GetParticipation.

This method returns the details of the enrollments an employee has forthe specified date. It reads the enrollments from all plan categories,and returns information such as cost and validity dates of the enrollments.

Notes

Messages are returned in the RETURN parameter. You will find the returncodes and their definitions in the documentation for this parameter.