SAP Function BAPI_FAMILYHK_GETDETAIL - Family Hong Kong: Read record

Parameter Reference Type Length Default Optional Text
EMPLOYEENUMBER BAPIP0021HK-EMPLOYEENO N 8 Personnel number
LOCKINDICATOR BAPIP0021HK-LOCKINDIC C 1 Lock indicator for HR master record
OBJECTID BAPIP0021HK-OBJECTID C 2 Object identification
RECORDNUMBER BAPIP0021HK-RECORDNR N 3 Number of infotype record
SUBTYPE BAPIP0021HK-SUBTYPE C 4 Subtype
VALIDITYBEGIN BAPIP0021HK-VALIDBEGIN D 8 Valid from date
VALIDITYEND BAPIP0021HK-VALIDEND D 8 Valid to date

Parameter Reference Type Length Text
ADDRESSLINE1 BAPIP0021HK-ADDRESSLINE1 C 30 Addrese line 1
ADDRESSLINE2 BAPIP0021HK-ADDRESSLINE2 C 30 Addrese line 2
ADDRESSLINE3 BAPIP0021HK-ADDRESSLINE3 C 25 Addrese line 3
AMOUNT BAPIP0021HK-AMOUNT P 5 Amount
AREACODE BAPIP0021HK-AREACODE C 3 Area code
BIRTHNAME BAPIP0021HK-BIRTHNAME C 40 Birth name
CONAME BAPIP0021HK-CONAME C 25 CO name
CONTACT1NUMBER BAPIP0021HK-CONTACT1NUMBER C 20 Communication number 1
CONTACT1TYPE BAPIP0021HK-CONTACT1TYPE C 4 Communication type 1
CONTACT2NUMBER BAPIP0021HK-CONTACT2NUMBER C 20 Communication number 2
CONTACT2TYPE BAPIP0021HK-CONTACT2TYPE C 4 Communication type 2
CONTACT3NUMBER BAPIP0021HK-CONTACT3NUMBER C 20 Communication number 3
CONTACT3TYPE BAPIP0021HK-CONTACT3TYPE C 4 Communication type 3
CONTACT4NUMBER BAPIP0021HK-CONTACT4NUMBER C 20 Communication number 4
CONTACT4TYPE BAPIP0021HK-CONTACT4TYPE C 4 Communication type 4
CONTACT5NUMBER BAPIP0021HK-CONTACT5NUMBER C 20 Communication number 5
CONTACT5TYPE BAPIP0021HK-CONTACT5TYPE C 4 Communication type 5
CONTACT6NUMBER BAPIP0021HK-CONTACT6NUMBER C 20 Communication number 6
CONTACT6TYPE BAPIP0021HK-CONTACT6TYPE C 4 Communication type 6
COUNTRYCODE BAPIP0021HK-COUNTRYCODE C 3 Country code
COUNTRYISSUEI1 BAPIP0021HK-COUNTRYISSUEI1 C 3 Issue by country 1
COUNTRYISSUEI2 BAPIP0021HK-COUNTRYISSUEI2 C 3 Issue by which country 2
COUNTRYOFBIRTH BAPIP0021HK-COUNTRYOFBIRTH C 3 Country
COUNTRYOFID1 BAPIP0021HK-COUNTRYOFID1 C 3 Which country ID1
COUNTRYOFID2 BAPIP0021HK-COUNTRYOFID2 C 3 Which country ID2
DATEOFBIRTH BAPIP0021HK-DATEOFBIRTH D 8 Date of birth
DISTRICTCODE BAPIP0021HK-DISTRICTCODE C 3 District code
EDUCATION BAPIP0021HK-EDUCATION C 2 Education
EDUCATIONTEXT BAPIP0021HK-EDUCATIONTEXT C 40 Education name
EMPLOYERADDRESS BAPIP0021HK-EMPLOYERADDR C 8 Employer of family member
EMPLOYERADDRTX BAPIP0021HK-EMPLOYERADDRTX C 60 Employer address
FIRSTNAME BAPIP0021HK-FIRSTNAME C 40 First name
GENDER BAPIP0021HK-GENDER C 1 Gender
ID1EXPIRYDATE BAPIP0021HK-ID1EXPIRYDATE D 8 Expiry date 1
ID1ISSUEBY BAPIP0021HK-ID1ISSUEBY C 30 Issue by place 1
ID1ISSUEDATE BAPIP0021HK-ID1ISSUEDATE D 8 Issue date 1
ID1NUMBER BAPIP0021HK-ID1NUMBER C 20 Identification number 1
ID1TYPE BAPIP0021HK-ID1TYPE C 2 Identification type 1
ID2EXPIRYDATE BAPIP0021HK-ID2EXPIRYDATE D 8 Expiry date 2
ID2ISSUEBY BAPIP0021HK-ID2ISSUEBY C 30 Issue by where 2
ID2ISSUEDATE BAPIP0021HK-ID2ISSUEDATE D 8 Issue date 2
ID2NUMBER BAPIP0021HK-ID2NUMBER C 20 Identification number 2
ID2TYPE BAPIP0021HK-ID2TYPE C 2 Identification type 2
IDTYPE1TEXT BAPIP0021HK-IDTYPE1TEXT C 30 Text of ID1 type
IDTYPE2TEXT BAPIP0021HK-IDTYPE2TEXT C 30 Text of ID2 type
INITIALS BAPIP0021HK-INITIALS C 10 Initials
INSTITUTE BAPIP0021HK-INSTITUTE C 20 Institute
LASTNAME BAPIP0021HK-LASTNAME C 40 Last name
MARITALSTATUS BAPIP0021HK-MARITALSTATUS C 1 Marital status
MARITALTEXT BAPIP0021HK-MARITALTEXT C 6 Marital text
MEMBERTYPE BAPIP0021HK-MEMBERTYPE C 4 Type of family record
NAMECOUNTRYID1 BAPIP0021HK-NAMECOUNTRYID1 C 15 Name of country for ID1
NAMECOUNTRYID2 BAPIP0021HK-NAMECOUNTRYID2 C 15 Name of country for ID2
NAMEISSUEID1CO BAPIP0021HK-NAMEISSUEID1CO C 15 Name of issue country ID1
NAMEISSUEID2CO BAPIP0021HK-NAMEISSUEID2CO C 15 Name of issue country ID2
NAMELANDBIRTH BAPIP0021HK-NAMELANDBIRTH C 15 Name of land birth
NAMEOFAREA BAPIP0021HK-NAMEOFAREA C 20 Name of area
NAMEOFCOUNTRY BAPIP0021HK-NAMEOFCOUNTRY C 15 Name of country
NAMEOFDISTRICT BAPIP0021HK-NAMEOFDISTRICT C 20 Name of district
NAMEOFEMPLOYER BAPIP0021HK-NAMEOFEMPLOYER C 50 Employer name
NAMEOFGENDER BAPIP0021HK-NAMEOFGENDER C 60 Name of gender
NAMEOFMEMBERTY BAPIP0021HK-NAMEOFMEMBERTY C 40 Name of family member type
NAMESTATEBIRTH BAPIP0021HK-NAMESTATEBIRTH C 20 Name of state birth
NAMETYPE1 BAPIP0021HK-NAMETYPE1 C 40 Name of type 1
NAMETYPE2 BAPIP0021HK-NAMETYPE2 C 40 Name of type 2
NATIONALITY BAPIP0021HK-NATIONALITY C 3 First nationality
NATIONALITY1TEXT BAPIP0021HK-NATIONALITY_1 C 15 Name of first nationality
NATIONALITY2 BAPIP0021HK-NATIONALITY2 C 3 Second nationality
NATIONALITY2TEXT BAPIP0021HK-NATIONALITY_2 C 15 Name of second nationality
NATIONALITY3 BAPIP0021HK-NATIONALITY3 C 3 Third nationality
NATIONALITY3TEXT BAPIP0021HK-NATIONALITY_3 C 15 Name of third nationality
OCCUPATION BAPIP0021HK-OCCUPATION C 25 Occupation
OCCUPATIONCODE BAPIP0021HK-OCCUPATIONCODE C 4 Occupation code
OCCUPATIONSTAT BAPIP0021HK-OCCUPATIONSTAT P 3 Employment percentage
OTHERFSTNAME1 BAPIP0021HK-OTHERFSTNAME1 C 25 Other First name 1
OTHERFSTNAME2 BAPIP0021HK-OTHERFSTNAME2 C 25 Other First name 2
OTHERLASTNAME1 BAPIP0021HK-OTHERLASTNAME1 C 25 Other last name 1
OTHERLASTNAME2 BAPIP0021HK-OTHERLASTNAME2 C 25 Other last name 2
OTHERNAME1TYPE BAPIP0021HK-OTHERNAME1TYPE C 4 Other name type 1
OTHERNAME2TYPE BAPIP0021HK-OTHERNAME2TYPE C 4 Other name type 2
PLACEOFBIRTH BAPIP0021HK-PLACEOFBIRTH C 40 Place of birth
REFEREMPLOYEENUMBER BAPIP0021HK-REFEREMPLOYEE C 12 Reference employee number
RETURN BAPIRETURN1 u 470 Structure for return code
SEPARATIONDATE BAPIP0021HK-SEPARATIONDATE D 8 Separate date
STATEOFBIRTH BAPIP0021HK-STATEOFBIRTH C 3 State

Functionality
You can use this method to read a Family/Related Person record (0021<(>&<)> 0344) for an employee in Hong Kong.

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 parameterdocumentation.
INCLUDE ADDRESSLINE1 OBJECT DOKU ID TX
INCLUDE ADDRESSLINE2 OBJECT DOKU ID TX
INCLUDE ADDRESSLINE3 OBJECT DOKU ID TX
INCLUDE AMOUNT2 OBJECT DOKU ID TX
INCLUDE AREACODE OBJECT DOKU ID TX
INCLUDE BIRTHNAME OBJECT DOKU ID TX
INCLUDE CONAME OBJECT DOKU ID TX
INCLUDE CONTACT1NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT1TYPE OBJECT DOKU ID TX
INCLUDE CONTACT2NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT2TYPE OBJECT DOKU ID TX
INCLUDE CONTACT3NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT3TYPE OBJECT DOKU ID TX
INCLUDE CONTACT4NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT4TYPE OBJECT DOKU ID TX
INCLUDE CONTACT5NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT5TYPE OBJECT DOKU ID TX
INCLUDE CONTACT6NUMBER OBJECT DOKU ID TX
INCLUDE CONTACT6TYPE OBJECT DOKU ID TX
INCLUDE COUNTRYCODE OBJECT DOKU ID TX
INCLUDE COUNTRYISSUEI1 OBJECT DOKU ID TX
INCLUDE COUNTRYISSUEI2 OBJECT DOKU ID TX
INCLUDE COUNTRYOFBIRTH OBJECT DOKU ID TX
INCLUDE COUNTRYOFID1 OBJECT DOKU ID TX
INCLUDE COUNTRYOFID2 OBJECT DOKU ID TX

Description
For more information on the definition of date of birth, see thecorresponding data element documentation:Date of birth

Default
INCLUDE DISTRICTCODE OBJECT DOKU ID TX
INCLUDE EDUCATION OBJECT DOKU ID TX
INCLUDE EDUCATIONTEXT OBJECT DOKU ID TX
INCLUDE EMPLOYERADDRESS OBJECT DOKU ID TX
INCLUDE EMPLOYERADDRTX OBJECT DOKU ID TX
INCLUDE FIRSTNAME OBJECT DOKU ID TX
INCLUDE GENDER OBJECT DOKU ID TX
INCLUDE ID1EXPIRYDATE OBJECT DOKU ID TX
INCLUDE ID1ISSUEBY OBJECT DOKU ID TX
INCLUDE ID1ISSUEDATE OBJECT DOKU ID TX
INCLUDE ID1NUMBER OBJECT DOKU ID TX
INCLUDE ID1TYPE OBJECT DOKU ID TX
INCLUDE ID2EXPIRYDATE OBJECT DOKU ID TX
INCLUDE ID2ISSUEBY OBJECT DOKU ID TX
INCLUDE ID2ISSUEDATE OBJECT DOKU ID TX
INCLUDE ID2NUMBER OBJECT DOKU ID TX
INCLUDE ID2TYPE OBJECT DOKU ID TX
INCLUDE IDTYPE1TEXT OBJECT DOKU ID TX
INCLUDE IDTYPE2TEXT OBJECT DOKU ID TX

Description
For more information on the definition of date of birth, see thecorresponding data element documentation:Date of birth

Default
INCLUDE INSTITUTE OBJECT DOKU ID TX
INCLUDE LASTNAME OBJECT DOKU ID TX
INCLUDE MARITALSTATUS OBJECT DOKU ID TX
INCLUDE MARITALTEXT OBJECT DOKU ID TX

Description
For information on the type of family member record, read the relevantdata element documentation: Type of family member record

INCLUDE NAMECOUNTRYID1 OBJECT DOKU ID TX
INCLUDE NAMECOUNTRYID2 OBJECT DOKU ID TX
INCLUDE NAMEISSUEID1CO OBJECT DOKU ID TX
INCLUDE NAMEISSUEID2CO OBJECT DOKU ID TX
INCLUDE NAMELANDBIRTH OBJECT DOKU ID TX
INCLUDE NAMEOFAREA OBJECT DOKU ID TX
INCLUDE NAMEOFCOUNTRY2 OBJECT DOKU ID TX
INCLUDE NAMEOFDISTRICT OBJECT DOKU ID TX
INCLUDE NAMEOFEMPLOYER OBJECT DOKU ID TX
INCLUDE NAMEOFGENDER OBJECT DOKU ID TX
INCLUDE NAMEOFMEMBERTY OBJECT DOKU ID TX
INCLUDE NAMESTATEBIRTH OBJECT DOKU ID TX
INCLUDE NAMETYPE1 OBJECT DOKU ID TX
INCLUDE NAMETYPE2 OBJECT DOKU ID TX
INCLUDE NATIONALITY OBJECT DOKU ID TX
INCLUDE NATIONALITY OBJECT DOKU ID TX
INCLUDE NATIONALITY2 OBJECT DOKU ID TX
INCLUDE NATIONALITY2 OBJECT DOKU ID TX
INCLUDE NATIONALITY3 OBJECT DOKU ID TX
INCLUDE NATIONALITY3 OBJECT DOKU ID TX
INCLUDE OCCUPATION OBJECT DOKU ID TX
INCLUDE OCCUPATIONCODE OBJECT DOKU ID TX
INCLUDE OCCUPATIONSTAT OBJECT DOKU ID TX
INCLUDE OTHERFSTNAME1 OBJECT DOKU ID TX
INCLUDE OTHERFSTNAME2 OBJECT DOKU ID TX
INCLUDE OTHERLASTNAME1 OBJECT DOKU ID TX
INCLUDE OTHERLASTNAME2 OBJECT DOKU ID TX
INCLUDE OTHERNAME1TYPE OBJECT DOKU ID TX
INCLUDE OTHERNAME2TYPE OBJECT DOKU ID TX
INCLUDE PLACEOFBIRTH OBJECT DOKU ID TX
INCLUDE REFEREMPLOYEENUMBER OBJECT DOKU ID TX

Description
Method return code
INCLUDE SEPARATIONDATE OBJECT DOKU ID TX
INCLUDE STATEOFBIRTH OBJECT DOKU ID TX

Description
For information on the personnel number, read the relevant data elementdocmentation: Personnel number

Description
For information on the lock indicator for the HR master data record,read the data element documentation: Lock indicator

Description
For information on the object identification, read the relevant dataelement documentation: Object identification
This field is only available to the subtype where the OBJRQ field ismarked in table T591A.

Description
For information on the infotype record number for the same key, readthe relevant data element docmentation: Number of infotyperecord for same key

Description
For information on the subtype, read the relevant data elementdocumentation: Subtype
INCLUDE VALIDITYBEGIN OBJECT DOKU ID TX
INCLUDE VALIDITYEND OBJECT DOKU ID TX