Description | Manage Business Partners |
Name | ManageBusinessPartnerIn |
Namespace | http://sap.com/xi/A1S/Global |
Process Component Description | Business Partner Data Management |
Process Component Name | BusinessPartnerDataManagement |
Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
Deployment Unit Description | Foundation |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Released |
An interface to manage business partner master data from an external application.
The web service interface Manage Business Partner In enables you to connect external applications to your SAP Business ByDesign system and to create and edit business partners and their assigned contacts in your system. The web service interface Manage Business Partner In is relevant if your company wants to access and manage business partner data from external applications.
The web service interface Manage Business Partner In offers the operations MaintainBundle and CheckMaintainBundle.
Here is an example of a simple web service request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global"> <soapenv:Header/> <soapenv:Body> <glob:BusinessPartnerBundleMaintainRequest_sync> <BasicMessageHeader> <ID>00000000000102dcade9bcb0aa000c68</ID> </BasicMessageHeader> <BusinessPartner actionCode="01"> <InternalID>FRSENT</InternalID> <Person> <GivenName>Frank</GivenName> <FamilyName>Sent</FamilyName> </Person> </BusinessPartner> </glob:BusinessPartnerBundleMaintainRequest_sync> </soapenv:Body> </soapenv:Envelope>
For this web service, the change state ID does not apply to the ContactPerson and Relationship node elements.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Possible scenarios include the following:
Create business partners
The MaintainBundle operation is used to create business partner persons and business partner organizations.
Update business partners
The MaintainBundle operation is used to update existing business partner persons and business partner organizations.
Here is an example web service request to create a business partner person:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global"> <soapenv:Header/> <soapenv:Body> <glob:BusinessPartnerBundleMaintainRequest_sync> <BasicMessageHeader> <ID>1234567890ABCDEF0123456789ABCDEF</ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> </BasicMessageHeader> <BusinessPartner actionCode="04" addressInformationListCompleteTransmissionIndicator="true" relationshipListCompleteTransmissionIndicator="false" contactPersonListCompleteTransmissionIndicator="false" textListCompleteTransmissionIndicator="false"> <ObjectNodeSenderTechnicalID>010</ObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <InternalID>CPSENT</InternalID> <CategoryCode>1</CategoryCode> <ContactPersonIndicator>true</ContactPersonIndicator> <CompetitorIndicator>false</CompetitorIndicator> <CarrierIndicator>false</CarrierIndicator> <SalesAndServicePartnerIndicator>false</SalesAndServicePartnerIndicator> <EmployeeFamilyMemberIndicator>true</EmployeeFamilyMemberIndicator> <SocialInsuranceFundHeadOfficeIndicator>false</SocialInsuranceFundHeadOfficeIndicator> <SocialInsuranceFundLocalOfficeIndicator>false</SocialInsuranceFundLocalOfficeIndicator> <PrivateInsuranceProviderIndicator>false</PrivateInsuranceProviderIndicator> <Person> <GivenName>Frank</GivenName> <FamilyName>Sent</FamilyName> </Person> <AddressInformation actionCode="04" addressUsageListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>005</ObjectNodeSenderTechnicalID> <UUID>00163e04-ed39-1ed3-9098-636cfaa0f60e</UUID> <AddressUsage actionCode="04"> <ObjectNodeSenderTechnicalID>006</ObjectNodeSenderTechnicalID> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address actionCode="04" telephoneListCompleteTransmissionIndicator="true"> <EmailURI>mail@customer.com</EmailURI> <PostalAddress> <CountryCode>DE</CountryCode> <RegionCode>08</RegionCode> <CityName>Heidelberg</CityName> <StreetPostalCode>61234</StreetPostalCode> <StreetName>Main Street</StreetName> <HouseID>42</HouseID> </PostalAddress> <WebURI>http://www.customer.com</WebURI> </Address> </AddressInformation> </BusinessPartner> </glob:BusinessPartnerBundleMaintainRequest_sync> </soapenv:Body> </soapenv:Envelope>
Here is an example web service request to create a business partner organization:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global"> <soapenv:Header/> <soapenv:Body> <glob:BusinessPartnerBundleMaintainRequest_sync> <BasicMessageHeader> <ID>1234567890ABCDEF0123456789ABCDEF</ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> </BasicMessageHeader> <BusinessPartner actionCode="04" addressInformationListCompleteTransmissionIndicator="true" relationshipListCompleteTransmissionIndicator="false" contactPersonListCompleteTransmissionIndicator="false" textListCompleteTransmissionIndicator="false"> <ObjectNodeSenderTechnicalID>001</ObjectNodeSenderTechnicalID> <!-- ChangeStateID is only relevant for changing <ChangeStateID>20101201082957.5189460</ChangeStateID> --> <!-- The UUID cannot be changed <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID> --> <InternalID>1000042</InternalID> <CategoryCode>2</CategoryCode> <ContactPersonIndicator>false</ContactPersonIndicator> <CompetitorIndicator>false</CompetitorIndicator> <CarrierIndicator>false</CarrierIndicator> <SalesAndServicePartnerIndicator>true</SalesAndServicePartnerIndicator> <EmployeeFamilyMemberIndicator>false</EmployeeFamilyMemberIndicator> <SocialInsuranceFundHeadOfficeIndicator>false</SocialInsuranceFundHeadOfficeIndicator> <SocialInsuranceFundLocalOfficeIndicator>false</SocialInsuranceFundLocalOfficeIndicator> <PrivateInsuranceProviderIndicator>false</PrivateInsuranceProviderIndicator> <Organisation> <FirstLineName>Silverstar Wholesale Corp</FirstLineName> <SecondLineName>Name Second Line</SecondLineName> </Organisation> <AddressInformation actionCode="04" addressUsageListCompleteTransmissionIndicator="true"> <ObjectNodeSenderTechnicalID>005</ObjectNodeSenderTechnicalID> <UUID>00163e04-fba1-1ed3-8ffc-cecb35f3286c</UUID> <AddressUsage actionCode="04"> <ObjectNodeSenderTechnicalID>006</ObjectNodeSenderTechnicalID> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address actionCode="04" telephoneListCompleteTransmissionIndicator="true"> <CorrespondenceLanguageCode>NL</CorrespondenceLanguageCode> <EmailURI>customer01@bydmail.com</EmailURI> <PostalAddress> <CountryCode>DE</CountryCode> <RegionCode>08</RegionCode> <CityName>Heidelberg</CityName> <StreetPostalCode>61234</StreetPostalCode> <StreetName>Main Street</StreetName> <HouseID>42</HouseID> </PostalAddress> <WebURI>http://www.company.com</WebURI> </Address> </AddressInformation> <ContactPerson actionCode="04" workplaceTelephoneListCompleteTransmissionIndicator="false"> <ObjectNodeSenderTechnicalID>002</ObjectNodeSenderTechnicalID> <BusinessPartnerContactInternalID>FRSENT</BusinessPartnerContactInternalID> <GivenName>Frank</GivenName> <FamilyName>Sent</FamilyName> </ContactPerson> </BusinessPartner> </glob:BusinessPartnerBundleMaintainRequest_sync> </soapenv:Body> </soapenv:Envelope>
Description | Check business partners |
Name | CheckMaintainBundle |
Synchronous | yes |
Release Status | Released |
To check if business partner master data can be created, updated, or deleted without errors.
The web service request- and response message types for the CheckMaintainBundle operation are the same as those of the MaintainBundle operation. The explanations given can therefore also be applied to the CheckMaintainBundle operation.
Description | Maintain business partners |
Name | MaintainBundle |
Synchronous | yes |
Release Status | Released |
To create, update, or delete business partner master data
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a BusinessPartner node element that contains the business partner data to be created or updated. The detailed structure of the BusinessPartner node will be explained in the following sub-chapters. The BusinessPartner node can occur multiple times in the request message – this means that multiple business partners 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 specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as business partner InternalID and UUID.
The BusinessPartner node element contains all general business partner information such as ID, UUID and business partner characteristics.
For business partner persons, the CategoryCode is 1. For business partner organizations, the CategoryCode is 2.
The following elements are relevant for business partner organizations only:
Organization node element
IndustrialSectorCode node element
The Person node element is relevant for person business partners only.
The InternalID element corresponds to the Business Partner ID on the UI - the UUID element is not visible on the UI, but can be retrieved using query and read web services.
The AddressInformation node element can be used to create and change business partner addresses.
The AddressUsage sub-node element corresponds to the usages in the table of addresses on the account UI. The usages are modeled as a list of AddressUsageCodes in the request message. The main address has AddressUsageCode XXDEFAULT.
The Telephone sub-node element allows two entries at maximum - one with MobilePhoneNumberIndicator = true and one with MobilePhoneNumberIndicator = false. This corresponds to the Phone and Mobile fields on the user interface. The DefaultIndicator element is not relevant for the usage code XXDEFAULT. In case of multiple addresses, instances have the same usage code (for example, two ship-to addresses); one address has to be indicated as the default address for that particular address usage - which means the DefaultIndicator has to be true for exactly one of these addresses. On the user interface, the default address for a given usage has the value Yes (Standard).
If changes to node element Telephone are requested, the telephoneListCompleteTransmissionIndicator has to be set to true (and the complete list has to be transmitted).
Note: An address that has been saved cannot be deleted, and hence instances of the AddressInformation node element cannot be deleted in this case, either.
The Relationship node element can be used to create, change, and delete relations to an existing business partner.
The data of the Relationship node corresponds to the Relationships data on the UI.
The ContactPerson node element can be used to create and change business partner contact person relations.
The ContactPerson node element is relevant for corporate business partner only. Data of this node is related to Contacts data on the UI (Business Address, Business Communication and Details sections).
The ContactPerson node element creates or updates a contact person and directly assigns it to the corresponding business partner.
Existing contact persons can be assigned to business partner organizations using the ContactPerson node element:
ContactPerson node element: Provide elements BusinessPartnerContactUUID or the BusinessPartnerContactInternalID to identify the related contact. In addition, the actionCode must be set to 04 (save).
Contact person relations can be removed from a business partner organization using the ContactPerson node elements.
The WorkplaceTelephone sub-node element allows two entries at maximum - one with MobilePhoneNumberIndicator = true and one with MobilePhoneNumberIndicator = false.
By default, the contact person workplace address refers to the main/default address of the business partner organization to which the contact person is assigned. If a business partner organization has multiple addresses, the workplace address of the contact person can be related to a business partner organization address of your choice. To assign a contact person workplace address, enter the AddressInformation UUID of the business partner organization address in the WorkplaceBusinessAddressUUID element of the contact person.
If changes to the WorkplaceTelephone are to be performed, the workplaceTelephoneListCompleteTransmissionIndicator must be set to true, and the complete list has to be transmitted.
The Text node element can be used to maintain business partner notes.
Data for this node element can be found as Notes on the account UI. Possible text type codes include the following:
Type code | Description |
---|---|
10030 | Business Partner Note |
10032 | Contact Person Note |
10036 | Sales & Service Partner Note |
10037 | Competitor Note |
10041 | Health Insurance Fund Note |
If an update operation on the Text node is to be performed, the textListCompleteTransmissionIndicator must be set to true, and the complete list has to be transmitted. Notes in business partner can be changed by the creator only.
Note: If a web service call is performed using a communication user, then created texts cannot be changed afterwards through the UI, because it is not possible to log on with the communication user.
The AttachmentFolder node element can be used to add and remove business partner attachments.
Data for this node can be found on the business partner UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
Category code | Description |
---|---|
2 | Document |
3 | Link |
The different types of attachments are differentiated by the TypeCode:
Type code | Description |
---|---|
10001 | Standard attachment |
10016 | Business partner image |
10017 | Business card |
To create link attachments, document elements must be as follows:
Element | Value |
---|---|
VisibleIndicator | true |
CategoryCode | 3 |
TypeCode | <none> |
AlternativeName | <Document Title> |
ExternalLinkWebURI | <link URI> |
Description | <Comment> |
To create file attachments, document elements must be as follows:
Element | Value |
---|---|
VisibleIndicator | true |
CategoryCode | 2 |
TypeCode | <none> |
Name | <Document Title> |
AlternativeName | <Document Title> |
Description | <Comment> |