EmployeeFamilyID

The business object Employee Family/Related Person - ID contains
details about an employee's family members and persons related to an employee.

Information about the family members and related persons is stored in the Family/Related Person infotype (0021).

More than one family member and related person can be assigned to an employee.

Structure

Employee Family/Related Person - ID contains the following
pieces of information about the family member or related person:

Available Methods

• Approve : Unlock family [ BAPI_FAMILY_APPROVE ]
  
• Change : Family ID: Change record [ BAPI_FAMILYID_CHANGE ]
  
• Create : Family ID: Create record [ BAPI_FAMILYID_CREATE ]
  
• CreateSuccessor : Family ID: Create subsequent family record [ BAPI_FAMILYID_CREATESUCCESSOR ]
  
• Delete : Delete Family [ BAPI_FAMILY_DELETE ]
  
• GetDetail : Family ID: Read Record [ BAPI_FAMILYID_GETDETAIL ]
  
• GetDetailedList : Family ID: Read instances with data [ BAPI_FAMILYID_GETDETAILEDLIST ]
  
• GetList : Read Instances [ BAPI_FAMILY_GETLIST ]
  
• Request : Family ID: Create locked record [ BAPI_FAMILYID_REQUEST ]
  
• SimulateCreation : Family ID: Simulate record creation [ BAPI_FAMILYID_SIMULATECREATION ]
  

Approve

You can use this method to unlock a Family/Related Person record (0021).

It enables you to implement the "double verification principle" inconjunction with the REQUEST method. According to this principle, atleast two users must take part in writing an active record to the
database. One user creates a locked record using the REQUEST method.The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the REQUEST method, read the documentation on the function module BAPI_FAMILY_REQUEST.

Change

You can use this method to change family/related-person records for ID employees (infotypes 0021/0318).

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUEmethod of the business object EMPLOYEE beforehand. For more informationon the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Create

You can use this method to create family/related-person records for ID employees (infotypes 0021/0318).

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUEmethod of the business object EMPLOYEE beforehand. For more informationon the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

CreateSuccessor

You can use this method to create family/related-person records for ID employees (infotypes 0021/0318).

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUEmethod of the business object EMPLOYEE beforehand. For more informationon the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

Delete

You can use this method to delete a Family/Related Person record (0021).

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUE method of the business object EMPLOYEE beforehand. For more information on the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

GetDetail

You can use this method to read family/related-person records for ID employees (infotypes 0021/0106).

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

GetDetailedList

You can use this method to read family/related-person records for ID employees (infotypes 0021/0318).

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

GetList

You can use this method to read the keys (instances) of Family/ Related Person records (0021) which are within the specified time interval.

Notes

Messages are transferred to the RETURN parameter. The relevantparameter documentation contains the return values and their meanings.

The key fields used by the method are described in the parameter documentation.

Request

You can use this method to create locked family/related-person records for ID employees (infotypes 0021/0318).

It enables you to implement the "double verification principle" inconjunction with the APPROVE method. According to this principle, atleast two users must take part in writing an active record to the database. One user creates a locked record using the
REQUEST method. The other user unlocks or 'activates' this record using the APPROVE method.

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.

You can use this method only if you have called the ENQUEUEmethod of the business object EMPLOYEE beforehand. For more informationon the ENQUEUE method, read the documentation on the function module BAPI_EMPLOYEE_ENQUEUE.

For more information on the APPROVE method, read the documentation on the function module BAPI_FAMILY_APPROVE.

SimulateCreation

You can use this method to simulate the creation of family/related-person records for ID employees (infotypes 0021/0318).

During the simulation all necessary consistency checks are performed, but the record is not written to the database.

Notes

Messages are returned in the parameter return. The parameterdocumentation shows the return codes and their meanings.

The key fields used by the method are described in the parameter documentation.