Show full documentation

 Show full documentation

Definition

An interface to migrate supplier master data from a source system or file.

Business Context and Use

The web service interface "Manage Supplier In" enables you to connect external applications to your SAP Business ByDesign system and to create and edit suppliers and their assigned contacts in your system.

The web service interface "Manage Supplier In" is relevant if your company wants to access and manage business partner data from external applications.

The web service interface "Manage Supplier In" offers the operations "MaintainBundle_V1" and "CheckMaintainBundle_V1".

Here is an example of a simple web service request:

<n0:SupplierBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
    <BasicMessageHeader>
        <ID>00000000000102dcade9bcb0aa000c68</ID>
    </BasicMessageHeader>
    <Supplier actionCode="01">
        <SupplierIndicator>true</SupplierIndicator>
        <FirstLineName>Frank</FirstLineName>
    </Supplier>
</n0:SupplierBundleMaintainRequest_sync_V1>

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:

• Bank directory entries (used in Bank Details node)

• Org units (used in Payment Data node)

Constraints and Integrity Conditions

More Information

General Information

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.

Scenarios

Possible scenarios include the following:

• Create Suppliers

The MaintainBundle_V1 operation is used to create suppliers.

• Update Suppliers

The MaintainBundle_V1 operation is used to update existing suppliers.

Here is an example web service request for a supplier:

<n0:SupplierBundleMaintainRequest_sync_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
  <!-- Creating a supplier -->
    <BasicMessageHeader>
        <ID>1234567890ABCDEF</ID>
        <UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
    </BasicMessageHeader>

    <Supplier actionCode="01" addressInformationListCompleteTransmissionIndicator="true" communicationArrangementListCompleteTransmissionIndicator="true" relationshipListCompleteTransmissionIndicator="true" contactPersonListCompleteTransmissionIndicator="true" paymentDataListCompleteTransmissionIndicator="true" bankDetailsListCompleteTransmissionIndicator="true" deviantTaxClassificationListCompleteTransmissionIndicator="true" withholdingTaxClassificationListCompleteTransmissionIndicator="true" generalProductTaxExemptionListCompleteTransmissionIndicator="true" textListCompleteTransmissionIndicator="true">

        <ObjectNodeSenderTechnicalID>01</ObjectNodeSenderTechnicalID>
  <!--Only relevant for changing
  <ChangeStateID>20101201082957.5189461</ChangeStateID>-->
        <InternalID>SCP100110</InternalID>
  <!--The UUID cannot be changed-->
  <!--<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>-->

  <!-- General information -->
        <FirstLineName>First Name</FirstLineName>
        <SecondLineName>First Name</SecondLineName>
        <SupplierIndicator>true</SupplierIndicator>
        <ABCClassificationCode>A</ABCClassificationCode>
        <IndustrialSectorCode>11</IndustrialSectorCode>
        <MinimumOrderValue currencyCode="EUR">3</MinimumOrderValue>
        <QualityManagementISOStandardCode>Z01</QualityManagementISOStandardCode>
        <QualityManagementValidToDate>2999-01-24</QualityManagementValidToDate>

  <!-- Maintain company adress information-->
        <AddressInformation actionCode="01" addressUsageListCompleteTransmissionIndicator="true">
            <ObjectNodeSenderTechnicalID>02</ObjectNodeSenderTechnicalID>
            <AddressUsage actionCode="01">
                <ObjectNodeSenderTechnicalID>03</ObjectNodeSenderTechnicalID>
                <AddressUsageCode>XXDEFAULT</AddressUsageCode>
                <DefaultIndicator>false</DefaultIndicator>
            </AddressUsage>
            <Address actionCode="01">
                <PostalAddress>
                    <CountryCode>US</CountryCode>
                    <CareOfName>CareOfName</CareOfName>
                    <StreetPrefixName>StrPreName</StreetPrefixName>
                    <AdditionalStreetPrefixName>AddStrPreName</AdditionalStreetPrefixName>
                    <StreetName>StrName</StreetName>
                    <HouseID>42</HouseID>
                    <StreetSuffixName>StrSufName</StreetSuffixName>
                    <AdditionalStreetSuffixName>AddStrSufName</AdditionalStreetSuffixName>
                    <CityName>CitName</CityName>
                    <RegionCode>AL</RegionCode>
                    <StreetPostalCode>12345</StreetPostalCode>
                    <AdditionalCityName>AddCitName</AdditionalCityName>
                    <DistrictName>DisName</DistrictName>
                    <CountyName>CouName</CountyName>
                    <POBoxIndicator>true</POBoxIndicator>
                    <POBoxID>POB01</POBoxID>
                    <POBoxPostalCode>23456</POBoxPostalCode>
                    <POBoxDeviatingCountryCode>DE</POBoxDeviatingCountryCode>
                    <POBoxDeviatingCityName>DevCitName</POBoxDeviatingCityName>
                    <POBoxDeviatingRegionCode>11</POBoxDeviatingRegionCode>
                    <TaxJurisdictionCode>AL</TaxJurisdictionCode>
                    <TimeZoneCode>CET</TimeZoneCode>
                </PostalAddress>
                <PhoneFormattedNumberDescription>+1 23456789</PhoneFormattedNumberDescription>
                <FacsimileFormattedNumberDescription>+1 98765432</FacsimileFormattedNumberDescription>
                <EMailURI>mail@sap.com</EMailURI>
                <WebURI>http://sap.com/</WebURI>
                <CorrespondenceLanguageCode>EN</CorrespondenceLanguageCode>
            </Address>
        </AddressInformation>

  <!-- Manage supplier contact person relations -->
        <ContactPerson actionCode="01" workplaceTelephoneListCompleteTransmissionIndicator="true">
            <ObjectNodeSenderTechnicalID>04</ObjectNodeSenderTechnicalID>
            <DefaultContactPersonIndicator>true</DefaultContactPersonIndicator>
            <FormOfAddressCode>0002</FormOfAddressCode>
            <AcademicTitleCode>0002</AcademicTitleCode>
            <GivenName>Contact</GivenName>
            <MiddleName>Middle</MiddleName>
            <FamilyName>Test</FamilyName>
            <BirthName>Birth</BirthName>
            <NickName>Nick</NickName>
            <GenderCode>1</GenderCode>
            <BirthDate>1999-01-24</BirthDate>
            <NonVerbalCommunicationLanguageCode>DE</NonVerbalCommunicationLanguageCode>
            <OccupationCode>0004</OccupationCode>
            <BusinessPartnerFunctionTypeCode>0028</BusinessPartnerFunctionTypeCode>
            <BusinessPartnerFunctionalAreaCode>0003</BusinessPartnerFunctionalAreaCode>
            <VIPReasonCode>A</VIPReasonCode>
            <MaritalStatusCode>1</MaritalStatusCode>
            <LifeCycleStatusCode>2</LifeCycleStatusCode>
            <WorkplacePreferredCommunicationMediumTypeCode>LET</WorkplacePreferredCommunicationMediumTypeCode>
            <WorkplaceEmailURI>mr.test@test.com</WorkplaceEmailURI>
            <WorkplaceFacsimileFormattedNumberDescription>+49 129398182</WorkplaceFacsimileFormattedNumberDescription>
            <WorkplaceTelephone>
                <ObjectNodeSenderTechnicalID>05</ObjectNodeSenderTechnicalID>
                <FormattedNumberDescription>+1 23324324</FormattedNumberDescription>
                <MobilePhoneNumberIndicator>true</MobilePhoneNumberIndicator>
            </WorkplaceTelephone>
            <WorkplaceTelephone>
                <ObjectNodeSenderTechnicalID>06</ObjectNodeSenderTechnicalID>
                <FormattedNumberDescription>+1 123456777</FormattedNumberDescription>
                <MobilePhoneNumberIndicator>false</MobilePhoneNumberIndicator>
            </WorkplaceTelephone>
            <WorkplaceWebURI>http://www.sap.com</WorkplaceWebURI>
            <WorkplaceFunctionalTitleName>Manager</WorkplaceFunctionalTitleName>
            <WorkplaceDepartmentName>TestDepartment</WorkplaceDepartmentName>
            <WorkplaceBuildingID>WDF</WorkplaceBuildingID>
            <WorkplaceFloorID>250</WorkplaceFloorID>
            <WorkplaceRoomID>R341</WorkplaceRoomID>
            <AddressInformation actionCode="01">
                <Address actionCode="01" telephoneListCompleteTransmissionIndicator="true">
                    <ObjectNodeSenderTechnicalID>10</ObjectNodeSenderTechnicalID>
                    <EmailURI>private@firstline.com</EmailURI>
                    <FacsimileFormattedNumberDescription>987</FacsimileFormattedNumberDescription>
                    <PostalAddress>
                        <CountryCode>US</CountryCode>
                        <RegionCode>AL</RegionCode>
                        <CountyName>County2</CountyName>
                        <CityName>City2</CityName>
                        <AdditionalCityName>AddCity2</AdditionalCityName>
                        <DistrictName>Distr2</DistrictName>
                        <StreetPostalCode>12346</StreetPostalCode>
                        <POBoxPostalCode>23457</POBoxPostalCode>
                        <CompanyPostalCode/>
                        <StreetPrefixName>StrPrefix2</StreetPrefixName>
                        <AdditionalStreetPrefixName>AddPrefix2</AdditionalStreetPrefixName>
                        <StreetName>Street2</StreetName>
                        <StreetSuffixName>Street Sufix2</StreetSuffixName>
                        <AdditionalStreetSuffixName>AddStrSuffix2</AdditionalStreetSuffixName>
                        <HouseID>98</HouseID>
                        <CareOfName>CareOf2</CareOfName>
                        <POBoxDeviatingCountryCode>DE</POBoxDeviatingCountryCode>
                        <POBoxDeviatingRegionCode>02</POBoxDeviatingRegionCode>
                        <POBoxDeviatingCityName>DevCity2</POBoxDeviatingCityName>
                        <POBoxID>box2</POBoxID>
                        <POBoxIndicator>true</POBoxIndicator>
                        <TaxJurisdictionCode>AL</TaxJurisdictionCode>
                        <TimeZoneCode>EST</TimeZoneCode>
                    </PostalAddress>
                    <Telephone>
                        <ObjectNodeSenderTechnicalID>11</ObjectNodeSenderTechnicalID>
                        <FormattedNumberDescription>7</FormattedNumberDescription>
                        <MobilePhoneNumberIndicator>true</MobilePhoneNumberIndicator>
                    </Telephone>
                    <Telephone>
                        <ObjectNodeSenderTechnicalID>12</ObjectNodeSenderTechnicalID>
                        <FormattedNumberDescription>13</FormattedNumberDescription>
                        <MobilePhoneNumberIndicator>false</MobilePhoneNumberIndicator>
                    </Telephone>
                </Address>
                <AddressUsage actionCode="01">
                    <ObjectNodeSenderTechnicalID>13</ObjectNodeSenderTechnicalID>
                    <AddressUsageCode>XXDEFAULT</AddressUsageCode>
                    <DefaultIndicator>false</DefaultIndicator>
                </AddressUsage>
            </AddressInformation>
            <AddressInformation actionCode="01">
                <Address actionCode="01" telephoneListCompleteTransmissionIndicator="true">
                    <ObjectNodeSenderTechnicalID>14</ObjectNodeSenderTechnicalID>
                    <EmailURI>private2@firstline.com</EmailURI>
                </Address>
            </AddressInformation>
        </ContactPerson>

    <!-- Add bank accounts -->
        <BankDetails actionCode="01">
            <ObjectNodeSenderTechnicalID>17</ObjectNodeSenderTechnicalID>
            <ID>BD01</ID>
            <BankInternalID>76</BankInternalID>
            <BankAccountID>12345678</BankAccountID>
            <BankAccountIDCheckDigitValue>90</BankAccountIDCheckDigitValue>
            <BankAccountTypeCode>10</BankAccountTypeCode>
            <BankAccountHolderName>Silverstar Wholesale Corp</BankAccountHolderName>
            <ValidityPeriod>
                <StartDate>1999-01-24</StartDate>
                <EndDate>9999-01-25</EndDate>
            </ValidityPeriod>
        </BankDetails>

  <!-- Add purchasing data -->
        <PurchasingData actionCode="01">
            <ObjectNodeSenderTechnicalID>16</ObjectNodeSenderTechnicalID>
            <CashDiscountTermsCode>0004</CashDiscountTermsCode>
            <IncotermsCode>FCA</IncotermsCode>
            <IncotermsLocationName>IncotermsLocation</IncotermsLocationName>
            <PurchaseOrderCurrencyCode>EUR</PurchaseOrderCurrencyCode>
            <PurchasingBlockIndicator>true</PurchasingBlockIndicator>
            <CustomerIDAtSupplier>SUPPLIER01</CustomerIDAtSupplier>
            <PurchaseOrderConfirmationRequiredCode>02</PurchaseOrderConfirmationRequiredCode>
            <EvaluatedReceiptSettlementIndicator>true</EvaluatedReceiptSettlementIndicator>
        </PurchasingData>

        <DeviantTaxClassification actionCode="01">
            <ObjectNodeSenderTechnicalID>02</ObjectNodeSenderTechnicalID>
            <CountryCode>AT</CountryCode>
            <TaxIdentificationNumberTypeCode>2</TaxIdentificationNumberTypeCode>
            <PartyTaxID schemeID="">123456789</PartyTaxID>
        </DeviantTaxClassification>

        <WithholdingTaxClassification actionCode="01">
            <ObjectNodeSenderTechnicalID>03</ObjectNodeSenderTechnicalID>
            <CountryCode>CN</CountryCode>
            <TaxTypeCode listID="">2</TaxTypeCode>
            <TaxRateTypeCode listID="">1</TaxRateTypeCode>
        </WithholdingTaxClassification>

  <!-- Maintain tax exemption details -->
        <GeneralProductTaxExemption actionCode="01">
            <ObjectNodeSenderTechnicalID>04</ObjectNodeSenderTechnicalID>
            <CountryCode>CH</CountryCode>
            <RegionCode>AG</RegionCode>
            <TaxTypeCode listID="">1</TaxTypeCode>
            <ReasonCode listID="">1</ReasonCode>
        </GeneralProductTaxExemption>

  <!--  Add supplier notes or financial data notes -->
        <Text actionCode="01">
            <ObjectNodeSenderTechnicalID>24</ObjectNodeSenderTechnicalID>
            <TypeCode>10035</TypeCode>
            <ContentText>English Text</ContentText>
        </Text>

  <!--  Maintain supplier attachments like documents, images, links... -->
        <AttachmentFolder DocumentListCompleteTransmissionIndicator="true" ActionCode="01">
   <!--  Link attachment -->
            <Document ActionCode="01">
                <VisibleIndicator>true</VisibleIndicator>
                <CategoryCode>3</CategoryCode>
                <TypeCode>10001</TypeCode>
                <Name>SAP AG</Name>
                <AlternativeName>SAP AG Homepage</AlternativeName>
                <Description languageCode="EN">Hyperlink to SAP AG</Description>
                <ExternalLinkWebURI>http://www.sap.com/</ExternalLinkWebURI>
            </Document>
   <!--  File attachment -->
            <Document ActionCode="01">
                <VisibleIndicator>true</VisibleIndicator>
                <CategoryCode>2</CategoryCode>
                <TypeCode>10001</TypeCode>
                <MIMECode>image/jpg</MIMECode>
                <Name>Logo</Name>
                <AlternativeName>Company Logo</AlternativeName>
                <Description languageCode="EN">The Company`s logo</Description>
                <FileContent ActionCode="01">
                    <BinaryObject mimeCode="image/png" characterSetCode="" format="" fileName="" uri="">AQIDBAUGBwgJAA==</BinaryObject>
                </FileContent>
            </Document>
        </AttachmentFolder>

    </Supplier>
</n0:SupplierBundleMaintainRequest_sync_V1>

 Show full documentation

 Show full documentation

Definition

To create, update or delete supplier master data.

Business Context and Use

The request message of the operation MaintainBundle_V1 contains a BasicMessageHeader node element as well as a Supplier node element that contains the supplier data to be created or updated. The detailed structure of the supplier node will be explained in the following sub-chapters. The supplier node can occur multiple times in the request message – this means that multiple suppliers can be created and updated through a single web service request.

The response message type of the operation MaintainBundle_V1 contains log items, processing information and an account-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as supplier InternalID and supplier UUID.

Structure

Supplier

The Supplier node element contains general supplier information. The data for this node is related to General data on the supplier UI.

The InternalID element corresponds to the Supplier ID on the user interface - the UUID element is not visible on the user interface but may be known out of the response of a read service. The elements SupplierIndicator, BidderIndicator, FreightForwarderIndicator and the WarehouseProviderIndicator correspond to the four check boxes on the General tab of the user interface. The QualityManagementISOStandardCode and the QualityManagementValidToDate elements correspond to the Certified According To/Valid To fields on the user interface.

The element CreateFromBusinessPartnerIndicator can be used to assign the role supplier to existing business partners.

If this element is supplied with value "true", then the following constraints have to be considered:

The actionCode attribute in message node Supplier shall have value "02" (Update) or "04" (Save), otherwise an error message is returned.

If the actionCode attribute in message node Supplier has value "02" or "04" and the elements InternalID or the UUID are filled, then the system assigns the role supplier to the business partner with the given InternalID or UUID.

If the actionCode attribute in message node Supplier has value "04" and the elements InternalID and UUID are both empty, then the system creates a new supplier using internal numbering.

When the PaymentData of a Customer should be transferred to Supplier, the CompanyID and AccountDeterminationCreditorGroupCode must be set for the PaymentData with ActionCode attribute value "04".

The additional identifiers can be found on the General tab of the user interface after clicking on Additional Identifiers. The message includes:

• DunAndBradSteetNumberID, (corresponds to D-U-N-S (Data Universal Numbering System))

• GlobalLocationNumberID (corresponds to Global Location Number)

• StandardCarrierAlphaCode (corresponds to Standard Carrier Alpha-Code)

• GermanCustomsNumberCode (corresponds to German Customs Number)

• PeppolParticipantID (corresponds to Peppol Participant Identifier)

Script Dependant Organizational Data

The ScriptDependantOrganizationalData node element can be used to create, change and delete the supplier name with other scripts.

For this, the scoping element "Multiple Scripts" must be in scope in the system.

Via the element ScriptCode the script is specified. The supplier name for this script is then maintained in elements FirstLineName and SecondLineName.

The supplier name for the "default script" is maintained in the section "Supplier".

Address Information

The AddressInformation node element can be used to create and change supplier addresses.

Data for the AddressInformation node element is related to Communication Addresses data on the supplier UI.

The elements of the Address sub-node element in the request message are located in the Address- and Communication details section on the UI.

The AddressUsage sub-node element corresponds to the usages in the table of addresses on the supplier UI. The usages are modeled as a list of AddressUsageCodes in the request message:

User Interface	AddressUsageCode
Main address	XXDEFAULT
Ship-From address	SHIP_FROM
Invoicer address	BILL_FROM
Payee address	SRM001
Remittance Advice To address	PAY001

The PhoneFormattedNumberDescription corresponds to the Phone field on the user interface.

The DefaultIndicator element is not relevant for the usage code "XXDEFAULT".

If multiple addresses exist with the same usage code (e.g. two ship to addresses) one of them has to be the default for that particular 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)".

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.

Relationship

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. Added contact persons can be found on the Contacts data on the UI.

Contact Person

The ContactPerson node element can be used to create and change supplier contact person relations.

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 supplier.

Existing contact persons can be assigned to suppliers using the Relationship and ContactPerson node elements:

• Relationship node element: Provide the RelationshipBusinessPartnerUUID or RelationshipBusinessPartnerInternalID elements to identify the related contact and set RoleCode "BUR001-1".

• 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 an supplier using the Relationship and ContactPerson node elements. If it is removed via the ContactPerson node, the BusinessPartnerContactUUID or the BusinessPartnerContactInternalID have to be filled and the actionCode must be "03" or "05".

The WorkplaceTelephone 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 supplier UI.

By default, the contact person workplace address refers to the main/default supplier address of the supplier to which the contact person is assigned. If a supplier has multiple supplier addresses, the workplace address of the contact person can be related to an supplier address of your choice.

To assign a contact person workplace address, enter the AddressInformation UUID of the supplier address in the WorkplaceBusinessAddressUUID element of the contact person.

The Main Private Address and additional Private Addresses can be provided in the AddressInformation sub-node element of the ContactPerson node element. The Main Private Address is the address with the AddressUsageCode = "XXDEFAULT". All other Private Addresses do not have an AddressUsage at all.

If changes to the WorkplaceTelephone are to be performed, the workplaceTelephoneListCompleteTransmissionIndicator must be set to “true”, and the complete list has to be transmitted.

Communication Arrangement

The CommunicationArrangement node element can be used to create and change supplier collaboration business document settings.

The data for this node element is related to Communication - Collaboration data on the supplier UI.

Relation between UI and request message:

User Interface	Request Message
Business Document Name	CompoundServiceInterfaceCode
Output Channel	CommunicationMediumTypeCode
E-Mail	EMailURI
Fax	FacsimileFormattedNumberDescription
Number of Copies	OutputCopyNumberValue
Template	OutputRequestFormTemplateCode
Print Queue ID	PrintQueueIdentifier

Communication Arrangement MultiChannel

The node CommunicationArrangementMultiChannel replaces the node CommunicationArrangement in case business feature MultiChannel-output is scoped.

Relation between UI and request message:

User Interface	Request Message
Business Document Name	CompoundServiceInterfaceCode
	EnabledIndicator
Output Channel Settings (row of table)	CommunicationChannel
Output Channel	CommunicationMediumTypeCode
Template	OutputRequestFormTemplateCode
Duplicate	DuplicateIndicator
Print Queue ID	PrintQueueIdentifier
Number of Copies	OutputCopyNumberValue
Fax	FacsimileFormattedNumberDescription
Channel Settings (row of table)	CommunicationEmail
Recipient Type	RecipientFieldTypeCode
E-Mail	EMailURI

Note that the EnabledIndicator is ignored for suppliers. It only exists to enable reuse of segment CommunicationArrangementMultiChannel in the "customer" context.

Possible values for Business Document Type Codes are listed below:

Business Document Name	CompoundServiceInterfaceCode
Purchase Order	1
Dunning Outbound	108
Invoice Exception Clarification	36
Purchasing Contract	39
ERS Invoice	5
Drop-Ship Order	507
Request for Quotation	6
Quote Result Notification or Request for Quote Revision	8
Remittance Advice Outbound	11

The valid Recipient Type Codes are listed below:

User Interface	Request Message
To	TO
Cc	CC
Bcc	BCC

For a given Business Document all Output Channels can only be changed jointly, i.e. communicationChannelListCompleteTransmissionIndicator = true is mandatory.

Purchasing Data

The PurchasingData node element can be used to create and change purchasing details of the supplier.

Data for this node element is related to Purchasing on the supplier UI.

Relation between UI and request message:

User Interface	Request Message
Payment Terms	CashDiscountTermsCode
PurchaseOrderConfirmationRequiredCode	Purchase Order Acknowledgement Expected

The other message elements have names that are similar to those on the user interface.

Bank Details

The BankDetails node element can be used to add bank accounts to suppliers.

Data for this node element is related to Financial Data – Bank Data on the UI.

To add a bank account, you must provide the relevant bank from the bank directory. Bank directory entries are identified according the following algorithm:

1. If the BankUUID is supplied, it is used to identify the bank directory entry; all other bank IDs are not checked.

2. If the BankInternalID is supplied, it is used to identify the respective bank directory entry; bank routing ID and bank standard ID is not checked.

3. Identify the bank directory entry by BankRoutingID, BankRoutingIDTypeCode and BankStandardID.

4. If only the BankRoutingID and BankRoutingIDTypeCode are supplied, the system queries bank directory entries based on the bank routing information. In the case that there are multiple bank directory entries with the same bank routing information, the system queries for a lead bank directory entry. If no lead bank directory entry is available, an arbitrary bank directory entry is selected and a warning message stating that the reference is not uniquely determined is returned as log item.

5. If only the BankStandardID is supplied, the bank directory entry is determined based on the bank standard ID. In the case that there are multiple bank directory entries with the same bank standard ID, the system queries for a lead bank directory entry. If no lead bank directory entry is available, an arbitrary bank directory entry is selected and a warning message stating that the reference is not uniquely determined is returned as a log item.

The UI field "IBAN" relates to element "BankAccountStandardID".

For bank accounts in Switzerland the "ISR Subscriber Number" and the "ISR Customer Number" can be maintained via the elements PaymentServiceSubscriberID and PaymentServiceCustomerID.

Payment Data

The PaymentData node element can be used to create and change company-specific supplier payment data.

Data for this node element is related to Financial Data - Payment Data on the UI.

The Payment Methods list is modeled as list of PaymentFormCodes in the request message.

Note: To maintain payment data, the LifeCycleStatusCode of the related account must be "2” (Active).

Deviant Tax Classification

The Deviant Tax Classification node element can be used to maintain supplier tax numbers.

Data for this node element is related to Financial Data – Tax Data – Tax Numbers on the UI.

Withholding Tax Classification

The WithholdingTaxClassification node element can be used to maintain withholding tax classification details.

Data for this node element is related to Financial Data – Tax Data – Withholding Tax Classification on the UI.

General Product Tax Exemption

The GeneralProductTaxExemption node element can be used to maintain tax exemption details.

Data for this node element is related to Financial Data – Tax Data – Tax Exemptions on the UI.

Text

The Text node element can be used to maintain supplier notes and financial data notes.

Data for this node element can be found as supplier Notes on the supplier UI.

Possible text type codes include the following:

Type code	Description
10035	Supplier note
10039	Financial data 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 suppliers 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.

Attachment Folder

The AttachmentFolder node element can be used to add and remove supplier attachments.

Data for this node can be found on the supplier 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
10015	Technical Drawing
10016	Business partner image
10082	Supplier-specific attachment

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>

Change Log:

Release	Change Description	Details
1905	segment CommunicationArrangement is changed	fields OutputRequestFormTemplateCode and PrintQueueId are added
1905	segment CommunicationArrangementMultiChannel is added	This segment should be used when business feature MultiChannel-Output is scoped
2102	Element OutgoingBankTransferRelevanceIndicator is added to segment DeviantTaxClassification	This element can only be set for tax country Ukraine and must be set only once per country
2102	Elements PaymentServiceSubscriberID and PaymentServiceCustomerID are added to segment BankDetails	These elements can only be used for bank accounts in Switzerland
2105	Element AuthorisationToDeferTaxIndicator is added to segment Supplier
2108	Element SupplierNonCompanyIndicator is added to segment Supplier
2111	Element PaymentPurpose is added to segment PaymentData	This element can be only used for TIS relevant processing.
2202	New Additional Identifier	The Supplier node is enhanced with the element PeppolParticipantIdentifier.
2202	Element PaymentPurposeCode is added to segment PaymentData
2208	Segment ScriptDependentOrganizationData is added	Only relevant if "Multiple Scripts" is scoped in the system
2211	Elements WithholdingTaxLobTreatyCode, WithholdingTaxChapterCode and WithholdingTaxCertificateDefaultIndicator are added to segment WithholdingTaxClassification	The first two elements are relevant for US1042S Tax Reporting, the third is relevant for Israel

 Show full documentation

 Show full documentation

Definition

To check if supplier master data can be created, updated or deleted without errors.

Business Context and Use

The web service request- and response message types for the “CheckMaintainBundle_V1” operation are the same as those of the “Maintain Bundle_V1” operation. The explanations given there can therefore also be applied to the “CheckMaintainBundle_V1” operation.