Description | Query Suppliers |
Name | QuerySupplierIn |
Namespace | http://sap.com/xi/A1S/Global |
Product | SAP Business ByDesign |
Process component | Business Partner Data Management |
Process component namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
Deployment unit | Foundation |
Endpoint Activation | By Scoping of Process Component | Operations |
|
Release Status | Released |
Technical documentation on the SAP API Business Hub | Query Suppliers |
General web service documentation | A2X Web Services (SOAP) |
An interface to query suppliers.
The web service interface Query Supplier in enables you to connect external applications to your SAP Business ByDesign system and to query suppliers in your system.
This web service interface is relevant if external parties or systems want to access supplier's data from external applications.
The web service interface Query Supplier in offers the operation Find by Elements.
Existence of referenced business documents:
The following business documents are only queried and will not be created by the service operations:
Supplier
They must already exist in the system when the web service is called.
Here is an example of a simple web service request:
Example
The following request queries a supplier with the following information:
Internal ID as GCMXS20124.
Request
<n0:SupplierByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <SupplierSelectionByElements> <SelectionByInternalID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>GCMXS20124</LowerBoundaryIdentifier> </SelectionByInternalID> </SupplierSelectionByElements> </n0:SupplierByElementsQuery_sync>
The response message contains the result of the above operation.
In case of successful execution, the response contains the Supplier's UUID, InternalID, SystemAdministrativeData, FirstLineName, Address Information and other details of the Supplier.
The following is the response for successful execution of the above request.
Response
<nm:SupplierByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS0F17D06D0E9C8CFABA3E:804"> <Supplier> <ChangeStateID> 20101104093440.9346860</ChangeStateID> <UUID>00163e01-14be-1def-b5a5-b0b1962d45a5</UUID> <InternalID>GCMXS20124</InternalID> <SystemAdministrativeData> <CreationDateTime>2010-10-11T11:51:43.322562Z</CreationDateTime> <CreationIdentityUUID>00163e01-0b99-1def-9fef-cdcec6d2e398</CreationIdentityUUID> <LastChangeDateTime>2010-11-04T09:34:40.934686Z</LastChangeDateTime> <LastChangeIdentityUUID>00163e01-0b99-1def-9fef-cdcec6d2e398</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>Bimbo</FirstLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <AddressInformation> <UUID>00163e01-14be-1def-b5a5-b0b1962d85a5</UUID> <CurrentAddressSnapshotUUID>00163e01-14be-1def-b5a5-b0b1962d85a5</CurrentAddressSnapshotUUID> <AddressUsage> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address> <PostalAddress> <CountryCode>MX</CountryCode> <StreetName>Av. Vasco de Quiroga</StreetName> <HouseID>110</HouseID> <CityName>Mexico City</CityName> <RegionCode listID="MX">MEX</RegionCode> <StreetPostalCode>50120</StreetPostalCode> <TimeZoneCode>UTC-6</TimeZoneCode> </PostalAddress> <PhoneFormattedNumberDescription>+1 613 580-2400</PhoneFormattedNumberDescription> <EMailURI>info@byd-excellence.com</EMailURI> <WebURI>www.byd-excellence.com</WebURI> <CorrespondenceLanguageCode>EN</CorrespondenceLanguageCode> <FormattedAddress> <FormattedAddressDescription>Bimbo / Av. Vasco de Quiroga 110 / 50120 Mexico City / MX</FormattedAddressDescription> <FormattedPostalAddressDescription>Av. Vasco de Quiroga 110 / 50120 Mexico City / MX</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>Bimbo</FirstLineDescription> <SecondLineDescription>Av. Vasco de Quiroga 110</SecondLineDescription> <ThirdLineDescription>50120 Mexico City</ThirdLineDescription> <FourthLineDescription>Mexico</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>Av. Vasco de Quiroga 110</FirstLineDescription> <SecondLineDescription>50120 Mexico City</SecondLineDescription> <ThirdLineDescription>Mexico</ThirdLineDescription> </FormattedPostalAddress> </FormattedAddress> </Address> </AddressInformation> <Relationship> <RelationshipBusinessPartnerUUID>00163e01-14be-1ddf-b5d7-6375aa6a8955</RelationshipBusinessPartnerUUID> <RelationshipBusinessPartnerInternalID>8000000561</RelationshipBusinessPartnerInternalID> <RoleCode>BUR025-1</RoleCode> </Relationship> <Relationship> <RelationshipBusinessPartnerUUID>00163e01-14be-1def-b5a5-bcf4ea9285b6</RelationshipBusinessPartnerUUID> <RelationshipBusinessPartnerInternalID>1000371</RelationshipBusinessPartnerInternalID> <RoleCode>BUR001-1</RoleCode> </Relationship> <ContactPerson> <BusinessPartnerContactUUID>00163e01-14be-1def-b5a5-bcf4ea9285b6</BusinessPartnerContactUUID> <BusinessPartnerContactInternalID>1000371</BusinessPartnerContactInternalID> <DefaultContactPersonIndicator>true</DefaultContactPersonIndicator> <GivenName>Dario</GivenName> <FamilyName>Silva</FamilyName> <GenderCode>0</GenderCode> <WorkplaceBusinessAddressUUID>00163e01-14be-1def-b5a5-b0b1962d85a5</WorkplaceBusinessAddressUUID> <WorkplaceFormattedAddress> <FormattedAddressDescription>Dario Silva / Av. Vasco de Quiroga 110 / 50120 Mexico City / MX</FormattedAddressDescription> <FormattedPostalAddressDescription>Av. Vasco de Quiroga 110 / 50120 Mexico City / MX</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>Bimbo</FirstLineDescription> <SecondLineDescription>Dario Silva</SecondLineDescription> <ThirdLineDescription>50120 Mexico City</ThirdLineDescription> <FourthLineDescription>Mexico</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>Av. Vasco de Quiroga 110</FirstLineDescription> <SecondLineDescription>50120 Mexico City</SecondLineDescription> <ThirdLineDescription>Mexico</ThirdLineDescription> </FormattedPostalAddress> </WorkplaceFormattedAddress> <LifeCycleStatusCode>2</LifeCycleStatusCode> </ContactPerson> <PaymentData> <UUID>00163e01-14be-1ddf-b8ea-af091d89a1cc</UUID> <CompanyID>GCMX-1000</CompanyID> <AccountDeterminationCreditorGroupCode>4010</AccountDeterminationCreditorGroupCode> <PaymentForm> <PaymentFormCode>06</PaymentFormCode> </PaymentForm> <PaymentForm> <PaymentFormCode>05</PaymentFormCode> </PaymentForm> </PaymentData> <PaymentData> <UUID>00163e01-2bcb-1ed0-aba5-01f04e5851e2</UUID> <CompanyID>GCMX-1000-1</CompanyID> <AccountDeterminationCreditorGroupCode>4010</AccountDeterminationCreditorGroupCode> </PaymentData> <PaymentData> <UUID>00163e01-2bcb-1ed0-aba5-02793d74d1e2</UUID> <CompanyID>GCMX-1000-2</CompanyID> <AccountDeterminationCreditorGroupCode>4010</AccountDeterminationCreditorGroupCode> </PaymentData> <BankDetails> <ID>0001</ID> <BankUUID>00163e01-14be-1ddf-b5d5-a1dd98c7c5c5</BankUUID> <BankInternalID>153</BankInternalID> <BankRoutingID>002</BankRoutingID> <BankRoutingIDTypeCode>MX</BankRoutingIDTypeCode> <BankStandardID>BNMXMXMMXXX</BankStandardID> <BankAccountID>112301000297518000</BankAccountID> <BankAccountHolderName>Bimbo</BankAccountHolderName> <ValidityPeriod> <StartDate>2010-11-04</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> </BankDetails> <DeviantTaxClassification> <CountryCode>MX</CountryCode> <TaxIdentificationNumberTypeCode listID="MX">1</TaxIdentificationNumberTypeCode> <PartyTaxID schemeID=" ">BIM550909528</PartyTaxID> </DeviantTaxClassification> <AttachmentFolder> <UUID>00163e01-14be-1ddf-b8d1-81ad2676f32d</UUID> </AttachmentFolder> </Supplier> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0114BE1DEFB5A5B0B1962D45A5</LastReturnedObjectID> </ProcessingConditions> </nm:SupplierByElementsResponse_sync>
In case of failed execution, the response contains error message(s).
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.
The following example scenario can be carried out using requested elements which returns all Suppliers with an e-mail address ending with "@sap.com" requesting for only supplier's node data, contact person information and address information.
Request
<n0:SupplierByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <SupplierSelectionByElements> <SelectionbyAddressEMailURI> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryEMailURI>*@sap.com</LowerBoundaryEMailURI> </SelectionbyAddressEMailURI> </SupplierSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>0</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements supplierTransmissionRequestCode="2"> <Supplier addressInformationTransmissionRequestCode="1" contactPersonTransmissionRequestCode="1"></Supplier> </RequestedElements> </n0:SupplierByElementsQuery_sync>
The response message contains the result of the above operation.
The following is the response for successful execution of the above request.
Response
<nm:SupplierByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS0F17D06D0E9C8CFABA3E:804"> <Supplier> <ChangeStateID> 20120905064246.0411560</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-bd314f5f03a9</UUID> <InternalID>1000024</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-09-05T06:42:46.041156Z</LastChangeDateTime> <LastChangeIdentityUUID>00145ef5-88e6-02db-bcaf-59a7175152b7</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AKRON Heating Technologies Inc.</FirstLineName> <SecondLineName>AHT Distribution Cntr. Philadelphia</SecondLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <AddressInformation> <UUID>00145ef5-88e6-02db-b8b3-e0e059fdd1f6</UUID> <CurrentAddressSnapshotUUID>00163e02-8660-1ed1-bde4-0342bc671be1</CurrentAddressSnapshotUUID> <AddressUsage> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address> <PostalAddress> <CountryCode>US</CountryCode> <StreetName>PO Box</StreetName> <HouseID>7853</HouseID> <CityName>Philadelphia</CityName> <RegionCode listID="US">PA</RegionCode> <StreetPostalCode>19102</StreetPostalCode> <TimeZoneCode>EST</TimeZoneCode> </PostalAddress> <PhoneFormattedNumberDescription>+1 (330) 244-4112</PhoneFormattedNumberDescription> <FacsimileFormattedNumberDescription>+49 62277842010</FacsimileFormattedNumberDescription> <EMailURI>A1S.Test.Mailbox@sap.com</EMailURI> <FormattedAddress> <FormattedAddressDescription>AKRON Heating Technologies Inc. / 7853 PO Box / Philadelphia PA 19102 / US</FormattedAddressDescription> <FormattedPostalAddressDescription>7853 PO Box / Philadelphia PA 19102 / US</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>AKRON Heating Technologies Inc.</FirstLineDescription> <SecondLineDescription>7853 PO Box</SecondLineDescription> <ThirdLineDescription>Philadelphia PA 19102</ThirdLineDescription> <FourthLineDescription>United States</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>7853 PO Box</FirstLineDescription> <SecondLineDescription>Philadelphia PA 19102</SecondLineDescription> <ThirdLineDescription>United States</ThirdLineDescription> </FormattedPostalAddress> </FormattedAddress> </Address> </AddressInformation> <ContactPerson> <BusinessPartnerContactUUID>00163e02-8660-1ed1-bde4-9089e22a9d46</BusinessPartnerContactUUID> <BusinessPartnerContactInternalID>1000820</BusinessPartnerContactInternalID> <DefaultContactPersonIndicator>true</DefaultContactPersonIndicator> <FormOfAddressCode>0001</FormOfAddressCode> <GivenName>susanna</GivenName> <FamilyName>Ewing</FamilyName> <GenderCode>2</GenderCode> <WorkplaceBusinessAddressUUID>00145ef5-88e6-02db-b8b3-e0e059fdd1f6</WorkplaceBusinessAddressUUID> <WorkplaceEMailURI>susanna.ewing@paramount-advertising.com</WorkplaceEMailURI> <WorkplaceFacsimileFormattedNumberDescription>+1 (330) 244-5990</WorkplaceFacsimileFormattedNumberDescription> <WorkplaceTelephone> <FormattedNumberDescription>+1 (330) 467-7543</FormattedNumberDescription> <MobilePhoneNumberIndicator>true</MobilePhoneNumberIndicator> </WorkplaceTelephone> <WorkplaceTelephone> <FormattedNumberDescription>+1 (330) 244-5664</FormattedNumberDescription> </WorkplaceTelephone> <WorkplaceFormattedAddress> <FormattedAddressDescription>susanna Ewing / 7853 PO Box / Philadelphia PA 19102 / US</FormattedAddressDescription> <FormattedPostalAddressDescription>7853 PO Box / Philadelphia PA 19102 / US</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>susanna Ewing</FirstLineDescription> <SecondLineDescription>AKRON Heating Technologies Inc.</SecondLineDescription> <ThirdLineDescription>Philadelphia PA 19102</ThirdLineDescription> <FourthLineDescription>United States</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>7853 PO Box</FirstLineDescription> <SecondLineDescription>Philadelphia PA 19102</SecondLineDescription> <ThirdLineDescription>United States</ThirdLineDescription> </FormattedPostalAddress> </WorkplaceFormattedAddress> <LifeCycleStatusCode>2</LifeCycleStatusCode> </ContactPerson> </Supplier> <Supplier> <ChangeStateID> 20120822060410.6122110</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-c091f35497e1</UUID> <InternalID>1000026</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-08-22T06:04:10.612211Z</LastChangeDateTime> <LastChangeIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AHT Japan</FirstLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <AddressInformation> <UUID>00145ef5-88e6-02db-b8b3-e10bfc695339</UUID> <CurrentAddressSnapshotUUID>00163e02-870c-1ed1-bb83-e52f5c4d3eff</CurrentAddressSnapshotUUID> <AddressUsage> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address> <PostalAddress> <CountryCode>JP</CountryCode> <StreetName>Fukaeminami 2cho-me</StreetName> <HouseID>8-35</HouseID> <CityName>Osaka</CityName> <StreetPostalCode>15370002</StreetPostalCode> <TimeZoneCode>UTC+9</TimeZoneCode> </PostalAddress> <EMailURI>pankajkumar.agrawal@sap.com</EMailURI> <FormattedAddress> <FormattedAddressDescription>AHT Japan / 8-35 Fukaeminami 2cho-me / Osaka 153-70002 / JP</FormattedAddressDescription> <FormattedPostalAddressDescription>8-35 Fukaeminami 2cho-me / Osaka 153-70002 / JP</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>AHT Japan</FirstLineDescription> <SecondLineDescription>8-35 Fukaeminami 2cho-me</SecondLineDescription> <ThirdLineDescription>Osaka 153-70002</ThirdLineDescription> <FourthLineDescription>Japan</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>8-35 Fukaeminami 2cho-me</FirstLineDescription> <SecondLineDescription>Osaka 153-70002</SecondLineDescription> <ThirdLineDescription>Japan</ThirdLineDescription> </FormattedPostalAddress> </FormattedAddress> </Address> </AddressInformation> </Supplier> <Supplier> <ChangeStateID> 20120906034846.4911420</ChangeStateID> <UUID>00163e01-02e3-02dd-b8be-6023b64dc03a</UUID> <InternalID>500013</InternalID> <SystemAdministrativeData> <CreationDateTime>2010-03-03T11:21:30.430292Z</CreationDateTime> <CreationIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</CreationIdentityUUID> <LastChangeDateTime>2012-09-06T03:48:46.491142Z</LastChangeDateTime> <LastChangeIdentityUUID>00300571-c924-02dc-82b8-534fcef680e9</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>Bürobedarf Lehmann AG</FirstLineName> <SupplierIndicator>true</SupplierIndicator> <ABCClassificationCode>A</ABCClassificationCode> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <AddressInformation> <UUID>00163e01-02e3-02dd-b8be-60242ca1003c</UUID> <CurrentAddressSnapshotUUID>00163e02-8638-1ee1-bdfa-b856319f5dba</CurrentAddressSnapshotUUID> <AddressUsage> <AddressUsageCode>XXDEFAULT</AddressUsageCode> </AddressUsage> <Address> <PostalAddress> <CountryCode>DE</CountryCode> <StreetName>Flughafenstrasse</StreetName> <HouseID>60</HouseID> <CityName>Hamburg</CityName> <RegionCode listID="DE">02</RegionCode> <StreetPostalCode>22335</StreetPostalCode> <TimeZoneCode>CET</TimeZoneCode> </PostalAddress> <PhoneFormattedNumberDescription>+1 (330) 244-4112</PhoneFormattedNumberDescription> <FacsimileFormattedNumberDescription>+49 62277842010</FacsimileFormattedNumberDescription> <EMailURI>A1S.Test.Mailbox@sap.com</EMailURI> <WebURI>www.lehmann.de</WebURI> <CorrespondenceLanguageCode>EN</CorrespondenceLanguageCode> <FormattedAddress> <FormattedAddressDescription>Bürobedarf Lehmann AG / Flughafenstrasse 60 / 22335 Hamburg / DE</FormattedAddressDescription> <FormattedPostalAddressDescription>Flughafenstrasse 60 / 22335 Hamburg / DE</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>Bürobedarf Lehmann AG</FirstLineDescription> <SecondLineDescription>Flughafenstrasse 60</SecondLineDescription> <ThirdLineDescription>22335 Hamburg</ThirdLineDescription> <FourthLineDescription>Germany</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>Flughafenstrasse 60</FirstLineDescription> <SecondLineDescription>22335 Hamburg</SecondLineDescription> <ThirdLineDescription>Germany</ThirdLineDescription> </FormattedPostalAddress> </FormattedAddress> </Address> </AddressInformation> <ContactPerson> <BusinessPartnerContactUUID>00163e01-02e3-02dd-b8be-79cb783f02a9</BusinessPartnerContactUUID> <BusinessPartnerContactInternalID>1000262</BusinessPartnerContactInternalID> <DefaultContactPersonIndicator>true</DefaultContactPersonIndicator> <GivenName>Philipp</GivenName> <FamilyName>Schilling</FamilyName> <GenderCode>0</GenderCode> <BusinessPartnerFunctionTypeCode>0015</BusinessPartnerFunctionTypeCode> <BusinessPartnerFunctionalAreaCode>0002</BusinessPartnerFunctionalAreaCode> <WorkplaceBusinessAddressUUID>00163e01-02e3-02dd-b8be-60242ca1003c</WorkplaceBusinessAddressUUID> <WorkplaceEMailURI>a1s.test.mailbox@EXCHANGE.SAP.CORP</WorkplaceEMailURI> <WorkplaceFacsimileFormattedNumberDescription>+49 (597) 330-323</WorkplaceFacsimileFormattedNumberDescription> <WorkplaceTelephone> <FormattedNumberDescription>+49 (597) 330-331</FormattedNumberDescription> </WorkplaceTelephone> <WorkplaceFormattedAddress> <FormattedAddressDescription>Philipp Schilling / Flughafenstrasse 60 / 22335 Hamburg / DE</FormattedAddressDescription> <FormattedPostalAddressDescription>Flughafenstrasse 60 / 22335 Hamburg / DE</FormattedPostalAddressDescription> <FormattedAddress> <FirstLineDescription>Bürobedarf Lehmann AG</FirstLineDescription> <SecondLineDescription>Philipp Schilling</SecondLineDescription> <ThirdLineDescription>22335 Hamburg</ThirdLineDescription> <FourthLineDescription>Germany</FourthLineDescription> </FormattedAddress> <FormattedPostalAddress> <FirstLineDescription>Flughafenstrasse 60</FirstLineDescription> <SecondLineDescription>22335 Hamburg</SecondLineDescription> <ThirdLineDescription>Germany</ThirdLineDescription> </FormattedPostalAddress> </WorkplaceFormattedAddress> <LifeCycleStatusCode>2</LifeCycleStatusCode> </ContactPerson> </Supplier> <ProcessingConditions> <ReturnedQueryHitsNumberValue>3</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E0102E302DDB8BE6023B64DC03A</LastReturnedObjectID> </ProcessingConditions> </nm:SupplierByElementsResponse_sync>
The following example scenario can be carried out using requested elements which returns at most two suppliers with an e-mail address ending with "@sap.com" requesting for only supplier's node data, purchasing information and payment information.
Request
<n0:SupplierByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <SupplierSelectionByElements> <SelectionbyAddressEMailURI> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryEMailURI>*@sap.com</LowerBoundaryEMailURI> </SelectionbyAddressEMailURI> </SupplierSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>2</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements supplierTransmissionRequestCode="2"> <Supplier purchasingDataTransmissionRequestCode="1" paymentDataTransmissionRequestCode="1"/> </RequestedElements> </n0:SupplierByElementsQuery_sync>
The response message contains the result of the above operation.
The following is the response for successful execution of the above request.
Response
<nm:SupplierByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS0F17D06D0E9C8CFABA3E:804"> <Supplier> <ChangeStateID> 20120905064246.0411560</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-bd314f5f03a9</UUID> <InternalID>1000024</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-09-05T06:42:46.041156Z</LastChangeDateTime> <LastChangeIdentityUUID>00145ef5-88e6-02db-bcaf-59a7175152b7</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AKRON Heating Technologies Inc.</FirstLineName> <SecondLineName>AHT Distribution Cntr. Philadelphia</SecondLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <PurchasingData> <CashDiscountTermsCode>0005</CashDiscountTermsCode> <PurchaseOrderCurrencyCode>USD</PurchaseOrderCurrencyCode> <PurchaseOrderConfirmationRequiredCode>04</PurchaseOrderConfirmationRequiredCode> <EvaluatedReceiptSettlementIndicator>true</EvaluatedReceiptSettlementIndicator> </PurchasingData> <PaymentData> <UUID>00163e02-8660-1ed1-bde4-bbcd1f105db0</UUID> <CompanyID>MDEC10000</CompanyID> <AccountDeterminationCreditorGroupCode>4040</AccountDeterminationCreditorGroupCode> <AccountCreditorExternalID>70000</AccountCreditorExternalID> </PaymentData> <PaymentData> <UUID>00163e02-8660-1ed1-bde4-bc35ed9e3db0</UUID> <CompanyID>MC10000</CompanyID> <AccountDeterminationCreditorGroupCode>4040</AccountDeterminationCreditorGroupCode> </PaymentData> </Supplier> <Supplier> <ChangeStateID> 20120822060410.6122110</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-c091f35497e1</UUID> <InternalID>1000026</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-08-22T06:04:10.612211Z</LastChangeDateTime> <LastChangeIdentityUUID>00300571-ce9b-1ded-8dc7-429a837d069a</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AHT Japan</FirstLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> </Supplier> <ProcessingConditions> <ReturnedQueryHitsNumberValue>2</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00145EF588E602EBB8B3C091F35497E1</LastReturnedObjectID> </ProcessingConditions> </nm:SupplierByElementsResponse_sync>
The following example scenario can be carried out using requested elements which returns only one supplier with an e-mail address ending with "@sap.com" requesting for only node data, communication arrangement information and relationship information.
Request
<n0:SupplierByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <SupplierSelectionByElements> <SelectionbyAddressEMailURI> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryEMailURI>*@sap.com</LowerBoundaryEMailURI> </SelectionbyAddressEMailURI> </SupplierSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements supplierTransmissionRequestCode="2"> <Supplier communicationArrangementTransmissionRequestCode="1" relationshipTransmissionRequestCode="1"/> </RequestedElements> </n0:SupplierByElementsQuery_sync>
The response message contains the result of the above operation.
The following is the response for successful execution of the above request.
Response
<nm:SupplierByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS0F17D06D0E9C8CFABA3E:804"> <Supplier> <ChangeStateID> 20120905064246.0411560</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-bd314f5f03a9</UUID> <InternalID>1000024</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-09-05T06:42:46.041156Z</LastChangeDateTime> <LastChangeIdentityUUID>00145ef5-88e6-02db-bcaf-59a7175152b7</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AKRON Heating Technologies Inc.</FirstLineName> <SecondLineName>AHT Distribution Cntr. Philadelphia</SecondLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-97db9c5ebd48</UUID> <CompoundServiceInterfaceCode>1</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> <CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-97db9c5edd48</UUID> <CompoundServiceInterfaceCode>11</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> <CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-97db9c5efd48</UUID> <CompoundServiceInterfaceCode>36</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> <CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-97db9c5f1d48</UUID> <CompoundServiceInterfaceCode>39</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> <CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-97db9c5f3d48</UUID> <CompoundServiceInterfaceCode>5</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> <CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-9800245add48</UUID> <CompoundServiceInterfaceCode>507</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-9800245afd48</UUID> <CompoundServiceInterfaceCode>6</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> </CommunicationArrangement> <CommunicationArrangement> <UUID>00163e02-8660-1ed1-bde4-9800245b1d48</UUID> <CompoundServiceInterfaceCode>8</CompoundServiceInterfaceCode> <EnabledIndicator>true</EnabledIndicator> </CommunicationArrangement> <Relationship> <RelationshipBusinessPartnerUUID>00163e02-8660-1ed1-bde4-9089e22a9d46</RelationshipBusinessPartnerUUID> <RelationshipBusinessPartnerInternalID>1000820</RelationshipBusinessPartnerInternalID> <RoleCode>BUR001-1</RoleCode> </Relationship> </Supplier> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00145EF588E602EBB8B3BD314F5F03A9</LastReturnedObjectID> </ProcessingConditions> </nm:SupplierByElementsResponse_sync>
The following example scenario can be carried out using requested elements which returns only one supplier with an e-mail address ending with "@sap.com" requesting for only node data, bank details information and deviant tax classification information.
Request
<n0:SupplierByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <SupplierSelectionByElements> <SelectionbyAddressEMailURI> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryEMailURI>*@sap.com</LowerBoundaryEMailURI> </SelectionbyAddressEMailURI> </SupplierSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> </ProcessingConditions> <RequestedElements supplierTransmissionRequestCode="2"> <Supplier bankDetailsTransmissionRequestCode="1" deviantTaxClassificationTransmissionRequestCode="1"/> </RequestedElements> </n0:SupplierByElementsQuery_sync>
The response message contains the result of the above operation.
The following is the response for successful execution of the above request.
Response
<nm:SupplierByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TAS0F17D06D0E9C8CFABA3E:804"> <Supplier> <ChangeStateID> 20120905064246.0411560</ChangeStateID> <UUID>00145ef5-88e6-02eb-b8b3-bd314f5f03a9</UUID> <InternalID>1000024</InternalID> <SystemAdministrativeData> <CreationDateTime>2008-05-20T11:48:34Z</CreationDateTime> <LastChangeDateTime>2012-09-05T06:42:46.041156Z</LastChangeDateTime> <LastChangeIdentityUUID>00145ef5-88e6-02db-bcaf-59a7175152b7</LastChangeIdentityUUID> </SystemAdministrativeData> <FirstLineName>AKRON Heating Technologies Inc.</FirstLineName> <SecondLineName>AHT Distribution Cntr. Philadelphia</SecondLineName> <SupplierIndicator>true</SupplierIndicator> <LegalCompetenceIndicator>true</LegalCompetenceIndicator> <LifeCycleStatusCode>2</LifeCycleStatusCode> <BankDetails> <ID>0001</ID> <BankUUID>00300571-c7cc-02db-b8b4-5e565d2ec980</BankUUID> <BankInternalID>87</BankInternalID> <BankRoutingID>031000053</BankRoutingID> <BankRoutingIDTypeCode>FW</BankRoutingIDTypeCode> <BankAccountID>8473014515</BankAccountID> <ValidityPeriod> <StartDate>2009-02-11</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> </BankDetails> </Supplier> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00145EF588E602EBB8B3BD314F5F03A9</LastReturnedObjectID> </ProcessingConditions> </nm:SupplierByElementsResponse_sync>
Note: The messages in the log vary from system to system based on the configuration.
Description | Find suppliers |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To find supplier details based on various selection parameters.
The request message of the operation Find by Elements contains the SupplierSelectionByElements node that groups all possible selection parameters. This node is described in the following sub-chapters.
This node groups all selection parameters. The selection parameters are:
Selection Parameter | Remark |
---|---|
SelectionByBusinessPartnerRoleCode | Selection by business partner role code: BBP000 Supplier BBP001 Bidder BBP001 Portal provider BBP006 Invoicing party BBP007 Payee BBP008 Potential supplier CRMS04 Freight forwarder SCM002 Warehouse provider |
SelectionByInternalID | Selection by internal ID (Supplier ID) |
SelectionByUUID | Selection by UUID |
SelectionByBusinessPartnerName | Selection by business partner name |
SelectionByBusinessPartnerAdditionalName | Selection by business partner additional name |
SelectionBySortingFormattedName | Selection by sorting formatted name |
SelectionByLegalCompetenceIndicator | Selection by legal competence indicator specifying whether the customer is legally competent |
SelectionByAddressDefaultIndicator | Selection by address default indicator. |
SelectionByPostalAddressCityName | Selection by a city in the postal address, for example, "Walldorf" |
SelectionByPostalAddressStreetPostalCode | Selection by a postal code in a postal address, for example, "69124" in the case of "Heidelberg" |
SelectionByPostalAddressStreetName | Selection by street name in a postal address |
SelectionByPostalAddressBuildingID | Selection by buildingID in postal address |
SelectionByPostalAddressFloorID | Selection by floorID in a postal address |
SelectionByPostalAddressCountryCode | Selection by country code in a postal address, for example, "DE" for "Germany" |
SelectionByPostalAddressRegionCode | Selection by region code in a postal address which is specific for a country, for example, with List ID "DE" the value "08" would stand for "Baden-Wuerttemberg" |
SelectionbyAddressEMailURI | Selection by e-mail address URI |
SelectionByABCClassificationCode | Selection by ABC classification code: A A-Supplier B B-Supplier C C-Supplier |
SelectionByIndustrialSectorCode | Selection by industrial sector code |
SelectionByContactPersonInternalID | Selection by internal ID of a contact person |
SelectionByContactPersonUUID | Selection by UUID of a contact person |
SelectionByContactPersonFamilyName | Selection by family name of a contact person |
SelectionByContactPersonGivenName | Selection by given name of a contact person |
SelectionByContactPersonSortingFormattedName | Selection by sorting formatted name of a contact person |
SelectionByIdentificationDunAndBradstreetNumberBusinessPartnerID | Selection by identification DunAndBradstreet number business partner ID |
SelectionByProcurementArrangementPurchasingTermsPurchasingBlockIndicator | Selection by procurement arrangement purchasing terms purchasing block indicator |
SelectionByCreatedSinceDate | Selection of suppliers created since a particular date. This selects all suppliers that have been created since a specific date |
SelectionByChangedSinceDate | Selection of all suppliers that were changed since the specified date. The "changed since" date does not take into account changes of the response nodes ContactPerson and Relationship |
SelectionByLifeCycleStatusCode | Selection by life cycle status code: 1 In Preparation 2 Active 3 Blocked 4 Obsolete 5 Deleted |
SelectionBySearchText | Selection by search text(Basic Search): Search scope includes 1.Sorting formatted name 2.City name in the postal address 3.Life cycle status code 4.Family name of a contact person 5.Given name of a contact person 6.Sorting formatted name of a contact person 7.Supplier ID |
Note: For selection by created since date time (element name SelectionByCreatedSinceDate), the time zone for provided date is always considered as UTC.
The response contains the list of found suppliers, log items, and processing conditions.
In this node contains all found suppliers including their data according to the requested elements provided in the query request. This includes the ChangeStateID that may be needed for subsequent change requests using web services as well.
Release | Change Description | Details |
1902 | ChangeDate | A selection criteria "ChangedSinceDate" was added |
2202 | Supplier Name | On the response, the attribute Supplier Name (formatted name of the busines partner) was added |
2208 | Element PaymentPurposeCode is added to segment PaymentData of the response | |
2211 | Elements WithholdingTaxLobTreatyCode, WithholdingTaxChapterCode and WithholdingTaxCertificateDefaultIndicator are added to segment WithholdingTaxClassification of the response message | The first two elements are relevant for US1042S Tax Reporting, the third is relevant for Israel |