Definition
An interface to create, update or delete business partner hierarchies.
Business Context and Use
The web service interface Manage Business Partner Hierarchy In enables you to connect external applications to your SAP Business ByDesign system and to create and edit business partner hierarchies in your system. The web service interface Manage Business Partner Hierarchy In is relevant if your company wants to access and manage business partner hierarchy data from external applications.
The web service interface Manage Business Partner Hierarchy In offers the operations MaintainBundle and CheckMaintainBundle.
Here is an example of a simple web service request:
<n0:BusinessPartnerHierarchyBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<BusinessPartnerHierarchy actionCode="01" groupListCompleteTransmissionIndicator="true">
<Name>A2X_TEST</Name>
<Group actionCode="01" businessPartnerListCompleteTransmissionIndicator="true" businessAreaListCompleteTransmissionIndicator="true">
<ID>A2X_TEST_1</ID>
<Name>A2X_TEST_1</Name>
</Group>
<Group actionCode="01" businessPartnerListCompleteTransmissionIndicator="true" businessAreaListCompleteTransmissionIndicator="true">
<ID>A2X_TEST_1_1</ID>
<Name>A2X_TEST_1_1</Name>
<ParentGroupID>A2X_TEST_1</ParentGroupID>
</Group>
</BusinessPartnerHierarchy>
</n0:BusinessPartnerHierarchyBundleMaintainRequest_sync>
Prerequisites
Existence of referenced business documents:
The following business documents are only referenced and will not be created by the service operations. They must exist in the system already at the time the web service is called:
Constraints and Integrity Conditions
Currently only Account Hierarchies can be handled by this web service.
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Scenarios
Possible scenarios include the following:
The MaintainBundle operation is used to create business partner hierarchies.
The MaintainBundle operation is used to update existing business partner hierarchies.
Definition
To create, update, or delete business partner hierarchies.
Business Context and Use
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Business Partner Hierarchy node element that contains the business partner hierarchy data to be created or updated. The detailed structure of the business partner hierarchy node will be explained in the following sub-chapters. The business partner hierarchy node can occur multiple times in the request message – this means that multiple business partner hierarchies can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a business partner hierarchy node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as business partner hierarchy ID and UUID.
Structure
Business Partner Hierarchy
The Business Partner Hierarchy node element contains the general information about the hierarchy such as ID and name. This information is not visible on the UI, however required.
Group
The Group node element contains the hierarchy node information such as ID, name, a note. Moreover, the element ParentGroupID or ParentGroupUUID is used to maintain the hierarchical relationship.
Business Partner
The Business Partner node element can be used to assign existing business partners to a group of the hierarchy. The element InternalID is used to identify a business partner.
Note:
As the web service currently only creates/maintains Account Hierarchies, only business partners with role Customer can be assigned here.
Business Area
The Business Area node element is not relevant and must be omitted.
Note
Currently the service only allows the maintenance of Account Hierarchies.
Definition
To check whether business partner hierarchies can be created, updated, or deleted without errors.
Business Context and Use
The web service request- and response message types for the CheckMaintainBundle operation are the same as those of the Maintain Bundle operation. The explanation given there can therefore also be applied to the CheckMaintainBundle operation.
Show full documentation
Show full documentation