An operation that retrieves one or more business partners as a person, organization, or group.
Entity Type |
Service Operation |
Released |
|
BusinessPartnerDataManagementManageBusinessPartnerIn.RetrieveBusinessPartner |
|
Synchronous |
|
Not applicable |
|
Not applicable |
For more information about the business context, see the Business Partner business object.
Related Operations
Business-Related Operations
Not applicable
Compensation Operation
Not applicable
Counterpart Operation
Not applicable
One of the following identifiers must be provided for each request to read a business partner’s data:
A unique identifier (UUID element)
An internal identifier (InternalID element)
A valid unique alternative identifier for the business partner required for the identification node (PartyIdentifierTypeCode and BusinessPartnerID elements) such as a passport number or ID card
For each successfully retrieved business partner, the operation returns a list of the identifying elements of the business partner as well as further details. If a business partner cannot be found, an error message is sent to the log.
The response message also includes the ChangeStateID element for each business partner, which is needed for the Update Business Partner operation.
For more information, see Error Handling in Financial Services .
The following main error messages are recorded in the log of the response message:
DCE.VME (Value Mapping Error):
FSBP_MAIN_ERROR_MSG 013 (Error occurred during mapping (inbound))
FSBP_MAIN_ERROR_MSG 014 (Error occurred during mapping (outbound))
FOE.SVE (Scheme Violation Error): FSBP_MAIN_ERROR_MSG 011 (Error during validation (inbound))
PRE (Processing Error): FSBP_MAIN_ERROR_MSG 001 (Cannot execute the operation; the relevant authorizations are missing)
PRE.IDE (Identification Error): FSBP_MAIN_ERROR_MSG 002 (Business partner &1 does not exist or authorization is missing)
For more information about the individual error categories, see the code list for the global data type LogItemCategoryCode.
BusinessPartnerFSRetrievalByIdentifyingElementsQuery_V1
BusinessPartnerFSRetrievalByIdentifyingElementsResponse_V1
Authorization
The user must be authorized to retrieve a business partner. The following authorization objects are checked in the SAP back-end system:
B_BUPA_GRP
B_BUPA_PGM
B_BUPA_RLT
B_CCARD
Enhancements
You can find the Business Add-In (BAdI) BAdI for RetrieveBusinessPartner(FSBP_FND_SE_RETRIEVE) for this operation through Transaction SIMGH. Choose . Depending on the application, the BAdIs for XI Interfaces structure could also be available in the IMG of your system such as SAP Policy Management.