Description | Query Business Partners |
Name | QueryBusinessPartnerIn |
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 query business partner master data.
The web service interface Query Business Partner In enables you to connect external applications to your solution and to query and read business partners and their assigned contacts in your system. The web service interface Query Business Partner In is relevant if your company wants to access and manage business partner data from external applications.
The web service interface Query Business Partner In offers the operation Find By Identification.
Here is an example of a simple web service request, which seeks for all business partner organizations with an ID matching "A*", returning at maximum 50 business partner instances:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global"> <soapenv:Header/> <soapenv:Body> <glob:BusinessPartnerByIdentificationQuery_sync> <BusinessPartnerSelectionByIdentification> <SelectionByInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>A*</LowerBoundaryIdentifier> </SelectionByInternalID> <SelectionByCategoryCode> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <!-- 2 = business partner organizations --> <LowerBoundaryCode>2</LowerBoundaryCode> </SelectionByCategoryCode> </BusinessPartnerSelectionByIdentification> <ProcessingConditions> <QueryHitsMaximumNumberValue>50</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID></LastReturnedObjectID> </ProcessingConditions> </glob:BusinessPartnerByIdentificationQuery_sync> </soapenv:Body> </soapenv:Envelope>
All data (complete response):
Expected result:
<BusinessPartner> <all... except address information node /> </BusinessPartner>
Request:
<RequestedElements businessPartnerTransmissionRequestCode='1'>
or (default is '1')
<RequestedElements />
or just omit it (default is all)
... empty ...
Return everything except address information:
Expected result:
<BusinessPartner> <all... except address information node /> </BusinessPartner>
Request:
<RequestedElements businessPartnerTransmissionRequestCode='2'> <BusinessPartner addressInformationTransmissionRequestCode='4' /> </RequestedElements>
Return business partner general data and address information:
Expected result:
<BusinessPartner> <InternalID>...</InternalID> <…/> <AddressInformation> <…/> </AddressInformation> </BusinessPartner>
Request:
<RequestedElements businessPartnerTransmissionRequestCode='2'> <BusinessPartner addressInformationTransmissionRequestCode='1'/> </RequestedElements>
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.
Description | Find business partner using identification data |
Name | FindByIdentification |
Synchronous | yes |
Release Status | Released |
To find business partner master data by identification.
The request message of the operation FindByIdentification contains the BusinessPartnerSelectionByIdentification node that groups all possible selection parameters.
This node groups all selection parameters. The selection parameters are:
Selection Parameter | Remark |
---|---|
SelectionByInternalID | Selection by internal ID (Account ID) |
SelectionByUUID | Selection by UUID |
SelectionByCategoryCode | Selection by category code: 1 Person, 2 Organization |
SelectionByBusinessPartnerID | Selection by business partner ID should be used together with SelectionByPartyIdentifierTypeCode |
SelectionByPartyIdentifierTypeCode | Selection by party identifier type code; valid values are BUP001 Dun & Bradstreet number, BUP005 Global Location Number |
SelectionByBusinessPartnerName | Selection by business partner name; for persons: last name, for organizations: business partner name |
SelectionByBusinessPartnerAdditionalName | Selection by business partner additional name; for persons: first name, for organizations: additional name |
SelectionByFormattedName | Selection by formatted name |
SelectionBySortingFormattedName | Selection by sorting formatted name |
SelectionByLifeCycleStatusCode | Selection by life cycle status code: 1 in preparation, 2 active, 3 blocked, 4 obsolete |
SelectionByCreatedSinceDate | Selection of all business partners that were created since the specified date |
SelectionByChangedSinceDate | Selection of all business partners that were changed since the specified date. The "changed since" date does not take into account changes of the response nodes ContactPerson and Relationship |
SelectionBySearchText | Selection by search text (basic search) |
The response contains the list of found business partners, log items, and processing conditions.
In this node, all found business partners are contained, including their business partner data according to the RequestedElements provided in the query request. This includes the ChangeStateID that may be needed for subsequent change requests via web services as well.
For each address of business partners and contact persons the address UUID and the most current address snapshot UUID is returned by this service. Note that the address snapshot UUID is not available for business partners and contact persons with status In Preparation.
If you want to change or display address data of business partners, use the AddressInformationUUID element.
In all other cases use the current address snapshot UUID (CurrentAddressSnapshotUUID and CurrentWorkplaceAddressSnapshotUUID elements) representing an address snapshot of this business partner address with the currently valid data. This applies to all usages of the address within business processes or business transaction documents, such as sales orders, purchasing orders, outbound deliveries, or invoices.
The address snapshot contains exactly the same data as the business partner address, but it cannot be changed: If the business partner’s address changes, the address snapshot does not change, but a new address snapshot is created for each change of the business partner address instead.
Example: A business partner has an address in Paris. A sales order is created with a ship-to party using the currently valid address snapshot AddressSnapshotUUID_1. Then the business partner address is changed to Marseille. A new address snapshot AddressSnapshotUUID_2 with the address "Marseille" is created. However, the sales order is still referring to the older address snapshot with the address in Paris. This is intended behavior from a business point of view, since, for example, taxes and prices have been determined for Paris. However, if goods ordered now have to be delivered to Marseille instead, then the sales order needs to be updated with the new address referring to AddressSnapshotUUID_2.
Note that for all SAP-delivered business transaction documents, you must use the address snapshot UUID; you cannot use the address UUID.
Release | Change Description | Details |
1902 | BusinessPurposeComplete | In Segement ContactPerson of the response the field BusinessPurposeComplete was added |