Inbound Service Interface (public)

Description	Manage Service Order In
Name	ManageServiceOrderIn
Namespace	http://sap.com/xi/AP/CRM/Global
Process Component Description	Service Order Processing
Process Component Name	ServiceOrderProcessing
Process Component Namespace	http://sap.com/xi/AP/CRM/Global
Deployment Unit Description	Customer Relationship Management
Endpoint Activation	By Scoping of Process Component
Operations	Maintain service order Check service order

Definition

An interface to replicate or create service orders from a source system or file, to a target system.

Business Context and Use

This Web service is used to create, modify, and delete existing service orders.

It has the MaintainBundle and CheckMaintainBundle operations. The MaintainBundle is used to update one or more instances of the Service Order business object. The CheckMaintainBundle is used to check if the one or more instances of the Service Order business object can be maintained.

Prerequisites

For an Account to be used in a Service Order, its Sales Arrangement needs to be maintained. Otherwise currency will not be determined.
To provide PaymentCard (CreditCardPayment/ExternalPayment) information, the respective PaymentCardKey (CreditCardPayment) / HouseBankAccountKeyInternalID (ExternalPayment) information needs to be maintained in the system.
To create a simple consistent ServiceOrder, the consumer has to provide the Account Party information and one or more Items.

Example

The request below will create a service order with the following information:

Service order ID as 10,
Buyer ID as PSM CRM ABSL Test - Example_01,
Posting date as 2006-03-28T12:00:00.1234567Z,
Service order name as PSM CRM ABSL Test - CallSalesOrderExample1,
Item ID as 10,
Item date as 2006-03-28T12:00:00.1234567Z,
Item product as MCD-0492,
Buyer party as MC6049.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test Web Service</Name>
  <BuyerID>Test Web Service</BuyerID>
  <DateTime>2019-06-07T12:00:00.1234567Z</DateTime>
  <BuyerParty>
   <PartyID>MC6049</PartyID>
  </BuyerParty>
  <Item>
  <ID>10</ID>
   <ItemProduct>
    <ProductInternalID>MCD-0492</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

The response contains the result of the above operation.

In case of successful execution, the response will contain the Service order ID and UUID.

The following is the response for successful execution of the above request.

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS735F216FA2EBB96040B1:804">
 <ServiceOderConfirmation>
  <ChangeStateID> 20190607071027.9289000</ChangeStateID>
  <UUID>00163e07-3d62-1ed6-8bdb-9b95e8540ae3</UUID>
  <ID>00000000000000000000000000000003222</ID>
 </ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

In case of a failed execution, the response will contain an error message(s).

Invoke Action

The following is a sample XML request to call upon the items' actions ReleaseToExecute,RevokeFinishFulfilmentProcessing,FinishFulfilmentProcessing,AddServiceAndSpareParts,and ReleaseAllItemsToExecution.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test Action parameter</Name>
  <BuyerID>tested</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
  <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
   <ReleaseToExecuteActionIndicator>true</ReleaseToExecuteActionIndicator>
   <RevokeFinishFulfilmentProcessingActionIndicator>true</RevokeFinishFulfilmentProcessingActionIndicator>
   <FinishFulfilmentProcessingActionIndicator>true</FinishFulfilmentProcessingActionIndicator>
   <AddServiceAndSparePartsActionIndicator>true</AddServiceAndSparePartsActionIndicator>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

PricingTerms

PricingTerms are characteristics that are used for the pricing and valuation of goods and services in the Service

Order.

Elements	Description
CurrencyCode	Currency for the valuation of goods and services ordered (document currency).
PriceDateTime	Price date at which price specifications are determined using a rule for automatic scheduling.
GrossAmountIndicator	An indicator that specifies whether or not price and/or value is given
	as gross amount (including taxes).

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <PricingTerms>
   <CurrencyCode>USD</CurrencyCode>
   <GrossAmountIndicator>false</GrossAmountIndicator>
  </PricingTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <Quantity unitCode="HUR">5.0</Quantity>
  </Item>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

CashDiscountTermsCode

CashDiscountTermsCode is a coded representation of an agreement of cash discounts for a payment.

CashDiscountTermsCode is used in service orders, purchase orders, and invoices. The corresponding terms of payment deliver information for financial planning, dunning, and payment transactions. Examples of the possible semantics of the codes are:

· 14 days 3%, 30 2%, 45 net: Payable in 45 days without deduction or within 30 days with 2% cash discount or within 14 days with 3%

· Days 0%, 0/0, 0 net: Payable immediately without deductions

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode = "02">
  <ID>2642</ID>
  <CashDiscountTermsCode>1004</CashDiscountTermsCode>
  </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

PriceAndTaxCalculation

A price and tax calculation is the summary of the determined price and tax components for a business case. A specification of the general procedure for price and tax determination and valuation using

attributes those are characteristic or relevant for the whole object.

Note: PriceAndTaxCalculation cannot be created but can only be modified. So this means that if the consumer wishes to change the ‘Discount’ or ‘Freight’ charge, then the consumer has to create the order first and then make a second web-service request to the update this service order with the pricing information that is to be changed.

The two types of freights charges are

TypeCode – 7PR8 – An absolute amount which is maintained at the service order document level.

TypeCode – 7PRD – A net-weight depenedent amount which is deteremined automatically on item level (sample xml)

Request

<n0:ServiceOrderBundleMaintainRequest_sync
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<ServiceOrder>
<ObjectNodeSenderTechnicalID>72</ObjectNodeSenderTechnicalID>
<ChangeStateID>20111011112138.8012470</ChangeStateID>
<ID>3309</ID>
<PriceAndTaxCalculation>
<MainDiscount actionCode="04">
<Rate>
<DecimalValue>25</DecimalValue>
</Rate>
</MainDiscount>
<PriceComponent>
<UUID>00163e01-2e13-1ee0-bcff-65cddc6b117f</UUID>
<Rate>
<DecimalValue>70</DecimalValue>
</Rate>
</PriceComponent>
<PriceComponent>
<TypeCode>7PRB</TypeCode>
<Rate>
<DecimalValue>7</DecimalValue>
</Rate>
</PriceComponent>
</PriceAndTaxCalculation>
</ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

TextCollection

A TextCollection is a collection of all textual descriptions which are related to a Customer Quote. Each text can include formatting information.

Elements	Description
TypeCode	Defines the text type and thus main settings for the text.
	10011 Internal Comment
	10006 Detailed Description
	10024 Customer Information

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test SRVO A2X</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
    <ItemScheduleLine>
     <TypeCode>1</TypeCode>
    <Quantity>10</Quantity>
   </ItemScheduleLine>
  </Item>
   <TextCollection actionCode="01">
    <Text actionCode="01">
     <TypeCode >10006</TypeCode>
     <ContentText languageCode="EN">hqtest Description</ContentText>
    </Text>
    <Text actionCode="01">
     <TypeCode >10011</TypeCode>
     <ContentText languageCode="EN">Internal Note</ContentText>
    </Text>
   </TextCollection>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

AttachmentFolder

An Attachment Folder is the collection of all documents attached to a Service Order.

Elements	Description
TypeCode	Coded representation of the document category, such as Folder, File, or Link.
	Code Value Description
	1 Folder
	2 Document
	3 Link

*Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
<BuyerID>new_test</BuyerID>
<Name languageCode="EN">new_test</Name>
<AccountParty>
<PartyID>MC9785</PartyID>
</AccountParty>
<Item>
<ItemProduct>
<ProductInternalID>MCF-0001</ProductInternalID>
</ItemProduct>
</Item>
<AttachmentFolder>
<Document>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<TypeCode>10001</TypeCode>
<MIMECode>text/plain</MIMECode>
<Name>New Text Document(2).txt</Name>
<AlternativeName>Test Document (txt)</AlternativeName>
<Description>This is a file attachment</Description>
<FileContent ActionCode="01">
<BinaryObject
mimeCode="text/plain">VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQu</BinaryObject>
</FileContent>
</Document>
<Document>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<Name>www.testlink.com</Name>
<AlternativeName>Test Link</AlternativeName>
<Description>This is atest Link</Description>
<ExternalLinkWebURI>http://www.testlink.com</ExternalLinkWebURI>
<FileContentURI>http://www.testlink.com</FileContentURI>
</Document>
</AttachmentFolder>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Constraints and Integrity Conditions

General Rules for Using this Web Service

More Information

General Information

You can find general information about Web services, their structure and consumption in the Web Services documentation.

Please Note : An Item Quantity can be created/updated either directly using <Quantity> tag under <Item> tag or by using <ItemScheduleLine> tag. But using both in same payload are not allowed. We always recommend to use <ItemScheduleLine> tag.

Scenarios

Creation of service order with one item include affected product, delivery terms, invoice terms etc.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS735F216FA2EBB96040B1:804">
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">test_demo</Name>
  <BuyerID>DEMO BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <SalesUnitParty>
   <PartyID>MC45000</PartyID>
  </SalesUnitParty>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <PricingTerms>
   <CurrencyCode>USD</CurrencyCode>
   <GrossAmountIndicator>false</GrossAmountIndicator>
  </PricingTerms>
  <RequestInitialReceiptTimePoint>
   <DateTime>2016-05-23T08:28:40Z</DateTime>
  </RequestInitialReceiptTimePoint>
  <RequestedFulfillmentPeriodPeriodTerms>
   <StartDateTime>2016-05-30T08:28:40Z</StartDateTime>
  </RequestedFulfillmentPeriodPeriodTerms>
  <SalesAndServiceBusinessArea>
   <DistributionChannelCode>02</DistributionChannelCode>
  </SalesAndServiceBusinessArea>
  <ServiceReferenceObject>
   <MainIndicator>true</MainIndicator>
   <RegisteredProductKey>
    <ProductID>MCF-0040-01</ProductID>
   </RegisteredProductKey>
  </ServiceReferenceObject>
  <DeliveryTerms>
   <DeliveryPriorityCode>7</DeliveryPriorityCode>
   <Incoterms>
    <ClassificationCode>CIF</ClassificationCode>
    <TransferLocationName>NewYork</TransferLocationName>
   </Incoterms>
  </DeliveryTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <ItemScheduleLine>
     <TypeCode>1</TypeCode>
    <Quantity>10</Quantity>
   </ItemScheduleLine>
   <ItemTextCollection>
    <Text>
     <TypeCode>10011</TypeCode>
     <ContentText>Internal </ContentText>
    </Text>
    <Text>
     <TypeCode>10024</TypeCode>
     <ContentText>Customer Info</ContentText>
    </Text>
   </ItemTextCollection>
   <RequestedFulfilmentItemPeriod>
    <StartDateTime timeZoneCode="GMTUK">2016-05-29T08:28:40Z</StartDateTime>
   </RequestedFulfilmentItemPeriod>
  </Item>
  <TextCollection>
   <Text>
    <TypeCode>10011</TypeCode>
    <ContentText>test for internal</ContentText>
   </Text>
   <Text>
    <TypeCode>10006</TypeCode>
    <ContentText>Test for incident</ContentText>
   </Text>
  </TextCollection>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS735F216FA2EBB96040B1:804">
 <Log>
  <MaximumLogItemSeverityCode>2</MaximumLogItemSeverityCode>
  <Item>
   <TypeID>014(/CL_CDA_SRVHD/)</TypeID>
   <SeverityCode>1</SeverityCode>
   <Note>No warranty determined</Note>
  </Item>
  <Item>
   <TypeID>307(/CL_CDA_SCHED/)</TypeID>
   <CategoryCode>INC.BOI</CategoryCode>
   <SeverityCode>2</SeverityCode>
   <Note>Requested date must be in the future</Note>
  </Item>
 </Log>
 <ServiceOderConfirmation>
  <ChangeStateID>20160613065304.1341830</ChangeStateID>
  <UUID>00163e07-3d6a-1ed6-8ca6-6e395bbc4efe</UUID>
  <ID>00000000000000000000000000000003180</ID>
 </ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Quantity of Service Order Item using ItemSceduleLine tag

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="02">
  <ID>2535</ID>
  <Item actionCode="02">
   <ID>10</ID>
   <ItemScheduleLine actionCode="02">
    <ID>2</ID>
    <Quantity>60</Quantity>
   </ItemScheduleLine>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2535</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Service Order Description

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <actionCode>02</actionCode>
  <ID>2619</ID>
  <Name languageCode="EN">Webservice Order</Name>
  <Item actionCode="02">
   <ID>10</ID>
   <Quantity>20</Quantity>
   </Item>
  </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2619</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Cash Discount Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode = "02">
  <ID>2642</ID>
  <CashDiscountTermsCode>1004</CashDiscountTermsCode>
  </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2642</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item List Price

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder ItemListCompleteTransmissionIndicator="true" actionCode="02">
  <ID>2925</ID>
  <Item actionCode="02">
   <ID>10</ID>
   <PriceAndTaxCalculationItem>
    <ItemMainPrice>
     <Rate>
      <DecimalValue>5200</DecimalValue>
     </Rate>
    </ItemMainPrice>
   </PriceAndTaxCalculationItem>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2925</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Text Collection

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <actionCode>02</actionCode>
  <ID>2619</ID>
  <Item actionCode="04">
   <ID>10</ID>
   <Quantity>15</Quantity>
  </Item>
  <TextCollection actionCode="04">
   <Text actionCode="04">
    <TypeCode >10006</TypeCode>
    <ContentText languageCode="EN">Incident Description</ContentText>
   </Text>
   <Text actionCode="04">
    <TypeCode >10011</TypeCode>
    <ContentText languageCode="EN">Internal Note</ContentText>
   </Text>
   <Text actionCode="04">
    <TypeCode >10024</TypeCode>
    <ContentText languageCode="EN">Customer Info</ContentText>
   </Text>
  </TextCollection>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2619</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Ship To Party Address

When ever we are updating party address a new Address Snapshot is created which is retrived to the UI while displaying. Hence we need to provide entire details like display name, phone, email, etc while updating party address. If we have to pass '&' symbol in text we should pass it like &, else it will be treated as invalid charactor.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode = "02">
  <ID>2848</ID>
  <ShipToParty>
   <PartyID>MC6049</PartyID>
   <Address>
    <CorrespondenceLanguageCode>EN</CorrespondenceLanguageCode>
    <DisplayName>
     <FormattedName languageCode="EN">Luxury Heating &amp; Cooling</FormattedName>
    </DisplayName>
    <PostalAddress>
     <CountryCode>US</CountryCode>
     <CityName>Kentucky</CityName>
     <StreetPostalCode>56989</StreetPostalCode>
     <StreetName>String 1536</StreetName>
     <POBoxPostalCode>33101</POBoxPostalCode>
    </PostalAddress>
   </Address>
  </ShipToParty>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2848</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Sales Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
  <ID>2642</ID>
   <Item actionCode="02" >
  <ObjectNodeSenderTechnicalID>2</ObjectNodeSenderTechnicalID>
   <ID>10</ID>
   <ItemSalesTerms actionCode="02">
    <CancellationReasonCode>02</CancellationReasonCode>
   </ItemSalesTerms>
   </Item>
  </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2642</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Invoice Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <actionCode>02</actionCode>
  <ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
  <ID>2642</ID>
  <Item actionCode="02" >
   <ID>10</ID>
   <ItemInvoiceTerms actionCode="02">
    <ProposedInvoiceDate>2015-06-20</ProposedInvoiceDate>
   </ItemInvoiceTerms>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2642</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Pricing Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <actionCode>02</actionCode>
  <ObjectNodeSenderTechnicalID>1</ObjectNodeSenderTechnicalID>
  <ID>2642</ID>
  <Item actionCode="02" >
   <ID>10</ID>
   <ItemPricingTerms actionCode="02">
    <CurrencyCode>USD</CurrencyCode>
    <PriceDateTime timeZoneCode="GMTUK">2016-06-20T12:00:00.1234567Z</PriceDateTime>
    <GrossAmountIndicator>true</GrossAmountIndicator>
   </ItemPricingTerms>
    </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2642</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Service Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <actionCode>02</actionCode>
  <ID>2915</ID>
  <Item actionCode="02" >
   <ID>10</ID>
    <ItemServiceTerms actionCode="02" >
    <ConfirmationRelevanceIndicator>true</ConfirmationRelevanceIndicator>
    <ServiceWorkingConditionsCode>02</ServiceWorkingConditionsCode>
    <ServicePlannedDuration>PT7H</ServicePlannedDuration>
    <ResourceID>CM-TEN001</ResourceID>
   </ItemServiceTerms>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2915</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Delivery Terms

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator>
  <actionCode>02</actionCode>
  <ID>2914</ID>
  <Item actionCode="02" >
   <ID>10</ID>
   <ItemDeliveryTerms actionCode="02">
    <Incoterms>
     <ClassificationCode>CIF</ClassificationCode>
     <TransferLocationName>NewYork</TransferLocationName>
    </Incoterms>
   </ItemDeliveryTerms>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-6688b50b3cc2</UUID>
<ID>2914</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Adding Item ServiceOrder Reference

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <actionCode>02</actionCode>
  <ID>192</ID>
  <Item actionCode="02" >
   <ID>10</ID>
  <ServiceOrderItemReference>
    <ItemServiceOrderRef>
     <ID>101</ID>
     <ItemID>10</ItemID>
    </ItemServiceOrderRef>
   </ServiceOrderItemReference>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804"
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918045045.8758080</ChangeStateID>
<UUID>00163e5f-4da7-1ee9-9b95-668450b3cc2</UUID>
<ID>192</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Text Collection

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <actionCode>02</actionCode>
  <ID>2915</ID>
  <Item actionCode="02" >
   <ID>10</ID>
   <ItemTextCollection>
    <Text>
     <TypeCode>10011</TypeCode>
     <ContentText>Internal Information</ContentText>
    </Text>
    <Text>
     <TypeCode>10024</TypeCode>
     <ContentText>Customer Information</ContentText>
    </Text>
   </ItemTextCollection>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918062013.6831100</ChangeStateID>
<UUID>00163e94-2a34-1ee9-b6ba-bcd4c4e33b17</UUID>
<ID>2915</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Updating Item Service Performer Party

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <actionCode>02</actionCode>
  <ID>2914</ID>
  <Item actionCode="02" >
   <ID>10</ID>
   <ItemServicePerformerParty actionCode="02">
    <PartyID>MC6430</PartyID>
    </ItemServicePerformerParty>
   </Item>
  </ServiceOrder>
 </n0:ServiceOrderBundleMaintainRequest_sync>

Response

<n0:ServiceOrderBundleMaintainConfirmation_sync xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAE735F216FA2EBB96040B1:804" xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Log/>
<ServiceOderConfirmation>
<ChangeStateID> 20190918062013.6831100</ChangeStateID>
<UUID>00163e94-2a34-1ee9-b6ba-bcd4c4e33b17</UUID>
<ID>2914</ID>
</ServiceOderConfirmation>
</n0:ServiceOrderBundleMaintainConfirmation_sync>

Create Service Order by setting InvoicingIrrelevantIndicator to true

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2019-12-01T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <ItemInvoiceTerms>
    <InvoicingIrrelevantIndicator>true</InvoicingIrrelevantIndicator>
    <ProposedInvoiceDate>2016-05-11</ProposedInvoiceDate>
   </ItemInvoiceTerms>
   <Quantity unitCode="HUR">5.0</Quantity>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Update Service Order InvoicingIrrelevantIndicator to true

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ID>3116</ID>
  <Item ActionCode="02">
   <ID>10</ID>
   <ItemInvoiceTerms>
    <InvoicingIrrelevantIndicator>true</InvoicingIrrelevantIndicator>
   </ItemInvoiceTerms>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Update Service Order InvoicingIrrelevantIndicator to false

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder>
  <ID>3116</ID>
  <Item ActionCode="02">
   <ID>10</ID>
   <ItemInvoiceTerms>
    <InvoicingIrrelevantIndicator>false</InvoicingIrrelevantIndicator>
   </ItemInvoiceTerms>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Create Header Main Discount

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode = "02">
  <ID>3399</ID>
  <PriceAndTaxCalculation actionCode="02">
   <MainDiscount>
    <Rate>
     <DecimalValue>29</DecimalValue>
    </Rate>
   </MainDiscount>
  </PriceAndTaxCalculation>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Create Header Price Components

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
  <ServiceOrder actionCode="04">
  <ID>3417</ID>
  <PriceAndTaxCalculation>
  
<!-- Over All Discount(%)-->
   <PriceComponent actionCode="01">
    <TypeCode>0007</TypeCode>
     <Rate>
     <DecimalValue>-1</DecimalValue>
     <MeasureUnitCode>P1</MeasureUnitCode>
    </Rate>
   </PriceComponent>
   
<!-- Additional Over All Discount(%)-->
   <PriceComponent actionCode="01">
    <TypeCode>2007</TypeCode>
     <Rate>
     <DecimalValue>-2</DecimalValue>
     <MeasureUnitCode>P1</MeasureUnitCode>
    </Rate>
   </PriceComponent>
   
<!--  Additional Over All Discount-->
   <PriceComponent actionCode="01">
    <TypeCode>3007</TypeCode>
     <Rate>
     <DecimalValue>-3</DecimalValue>
    </Rate>
   </PriceComponent>
   
<!--  Restocking Fee-->
   <PriceComponent actionCode="01">
    <TypeCode>7PRB</TypeCode>
    <Rate>
     <DecimalValue>-4</DecimalValue>
    </Rate>
   </PriceComponent>
  </PriceAndTaxCalculation>

 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Update Header Price Component

The following request xml update price components for the ServiceOrder on the header level. For updating the price component we should provide the UUID for the corresponding price component for the web srevice to identify the right price component. We can get the UUID by executing the QueryServiceOrderIn service.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04">
  <ID>3417</ID>
  <PriceAndTaxCalculation actionCode="02">
   <PriceComponent actionCode="02">
  <UUID>00163e94-2a34-1eea-9ab3-c988c70206ff</UUID>
      <Rate>
     <DecimalValue>-5</DecimalValue>
     </Rate>
   </PriceComponent>
 </PriceAndTaxCalculation>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Delete Header Price Component

The following request xml delete price components for the ServiceOrder on the header level. For deleting the price component we should provide the UUID for the corresponding price component for the web srevice to identify the right price component. We can get the UUID by executing the QueryServiceOrderIn service.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04">
  <ID>3417</ID>
  <PriceAndTaxCalculation actionCode="04">
   <PriceComponent actionCode="03">
  <UUID>00163e94-2a34-1eea-9ab3-c988c70206ff</UUID>
       </PriceComponent>
 </PriceAndTaxCalculation>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Create Item Main Discount

The following request xml creates a Main Discount for the Service Order on the Item level. If we creating are discount via "ItemMainDiscount" tag then it will delete all the existing discounts and creates a new one.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04" itemListCompleteTransmissionIndicator="true">
  <ID>3387</ID>
  <Item actionCode="04">
   <ID>10</ID>
    <PriceAndTaxCalculationItem>
    <ItemMainDiscount>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemMainDiscount>
    </PriceAndTaxCalculationItem>
  </Item>
  </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Create Item Main Price

The following request xml creates a Main Price for the Service Order on the Item level. It will replace the existing price with the provided price as a product can have only one price.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04" itemListCompleteTransmissionIndicator="true">
  <ID>3653</ID>
  <Item actionCode="04">
   <ID>10</ID>
   <PriceAndTaxCalculationItem>
    <ItemMainPrice>
     <Rate>
      <DecimalValue>100</DecimalValue>
     </Rate>
    </ItemMainPrice>
   </PriceAndTaxCalculationItem>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Create Item Price Components

The following request xml creates price components for the Service Order on the item level.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
  <ServiceOrder actionCode="04">
  <ID>3420</ID>
  <Item actionCode="04">
   <ID>10</ID>
   <PriceAndTaxCalculationItem>

<!--   GoodWill-->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PRC</TypeCode>
     <Description>GoodWill</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>

<!--   Warranty -->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PR9</TypeCode>
     <Description>Warranty</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>

<!--    Quality Loss Fee-->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PRA</TypeCode>
     <Description>Quality Loss Fee</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
     </Rate>
    </ItemPriceComponent>

<!--    Surcharge(%)-->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PR2</TypeCode>
     <Description>Surcharge %</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>

<!--  Surcharge  -->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PR3</TypeCode>
     <Description>Surcharge</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      </Rate>
    </ItemPriceComponent>

    <!--  Working Condition  -->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PR7</TypeCode>
     <Description>Working Condtion</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>

     <!--  Product Discount  -->
    <ItemPriceComponent actionCode="01">
     <TypeCode>7PR6</TypeCode>
     <Description>Discount</Description>
     <Rate>
      <DecimalValue>-2</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>

   </PriceAndTaxCalculationItem>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Update Item Price Component

The following request xml update price components for the Service Order on the item level. For updating the item price component we should provide the UUID for the corresponding item price component for the web srevice to identify the right price component. We can get the UUID by executing the QueryServiceOrderIn service.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04">
  <ID>3420</ID>
  <Item actionCode="04">
   <ID>10</ID>
   <PriceAndTaxCalculationItem actionCode="02">
    <ItemPriceComponent actionCode="02">
      <UUID>00163e94-2a23-1eda-9ab4-A71ecbaf5bf8</UUID>
      <Rate>
      <DecimalValue>-1</DecimalValue>
      <MeasureUnitCode>P1</MeasureUnitCode>
     </Rate>
    </ItemPriceComponent>
   </PriceAndTaxCalculationItem>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Delete Item Price Component

The following request xml delete price components for the Service Order on the item level. For deleting the item price component we should provide the UUID for the corresponding item price component for the web srevice to identify the right price component. We can get the UUID by executing the QueryServiceOrderIn service.

Request

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader/>
 <ServiceOrder actionCode="04">
  <ID>3420</ID>
  <Item actionCode="04">
   <ID>10</ID>
   <PriceAndTaxCalculationItem actionCode="02">
    <ItemPriceComponent actionCode="03">
      <UUID>00163e94-2a23-1eda-9ab4-A71ecbaf5bf8</UUID>
    </ItemPriceComponent>
   </PriceAndTaxCalculationItem>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Description	Maintain service order
Name	MaintainBundle
Synchronous	yes

Definition

To maintain one or more service orders using imported structured data.

Business Context and Use

The MaintainBundle operation is used to maintain one or more service orders using imported structured data.

To create a simple, consistent ServiceOrder, the consumer has to provide the Account Party information, and information for one or more Items.

Structure

Root Node – Service Order

This is the root node for each order data being passed in the request. The following are the attributes and elements of this node.

Attributes	Description
itemListCompleteTransmissionIndicator	As mentioned above, ListCompleteTransmissionIndicator is available for child nodes with multiple cardinality and Item is one such child node of SalesOrder node. Values can be either true or false.
actionCode	Refer to General Rules for Using this Web Service section for more details.

Elements	Description
ID	The identifier for a specific service order (mandatory during modification of an existing service order).
BuyerID	External Reference ID
PostingDate	Posting Date of a service order
Name	Description for an Order

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – SalesAndServiceBusinessArea

A SalesAndServiceBusinessArea is the business or service specific area within an enterprise that is valid for a Service Order, for example, sales organization, service organization, distribution channel, division and so on. These elements are derived from the organizational unit Sales Unit or Service Unit (see Party) responsible for the Service Order, and can be overwritten manually.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
DistributionChannelCode	A distribution channel is a channel via which goods or services reach the customer. Code Value Description: 01 Direct sales; 02 Indirect sales

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <SalesAndServiceBusinessArea>
   <DistributionChannelCode>02</DistributionChannelCode>
  </SalesAndServiceBusinessArea>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node - Party

A Party is a natural or legal person, organization, organizational unit or group that is involved in a transaction, and a reference to a business partner or one of its specializations (such as Customer, Supplier, Employee, and so on).

Party occurs in the following incomplete and disjoint specializations:

Party	Description
BillToParty	A BillToParty is a party (Customer) to whom the invoice for goods or services is sent.
AccountParty	An AccountParty is a party (Customer) that purchases a product or service. It occurs in the role of the buyer or ordering party with whom the contractual agreement is concluded.
PayerParty	A PayerParty is a party (Customer) that pays for a product or a service.
ProductRecipientParty	A ProductRecipientParty is a party (Customer, Supplier, Company) to whom goods are delivered or services are provided. It fulfills the role of the customer who receives the goods or, in case of returns, the vendor or supplying company.
SalesUnitParty	A SalesUnitParty is a party (Sales Unit) that is responsible for the sales of goods and services.
ServiceExecutionTeamParty	A ServiceExecutionTeamParty is a party (Service Unit) that is responsible for executing the service orders.
ServicePerformerParty	A ServicePerformerParty is a party (Employee) that provides services for a company.
ProductRecipientItemParty (on Item child node)	A ProductRecipientItemParty is a party (Customer, Supplier or Company) to whom the item-specific goods are delivered or service are provided.
VendorItemParty (on Item child node)	A VendorItemParty is a party (Company, Customer or Supplier) who delivers goods or provides services. It performs the role of the delivering enterprise or of the external vendor or, in the case of returns, the customer.
ServicePerformerItemParty (on Item child node)	A ServicePerformerItemParty is a party (Employee) that provides services for a company.

The Party with the following specializations that are related to the company (seller) cannot have a change in address except for the respective contact party of these parties.

SalesUnitParty
ServiceExecutionTeamParty
ServicePerformerParty
VendorItemParty
ServicePerformerItemParty

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.
partyContactPartyListCompleteTransmissionIndicator	The ContactParty child node is of multiple cardinality, hence there is a ListCompleteTransmissionIndicator to handle this.

Elements	Description
PartyID	An identifier for a party

Child Node – Address

This node is used to maintain the address data for persons or organizations (including the postal address and communication data). It can also be used to maintain other address-specific information, such as the preferred method of communication, or a formatted address, display names in the user interfaces.

An address that is maintained via the web-service becomes a document address, that is, an address that is valid only for that service order document. An address in a document cannot be changed, but a new one can be created which will overwrite the previous document address. This would be mean that if the customer wants to change, for example, an email ID, the customer would have to read all information present in the current address and send it back along with the new email ID as an update request.

Attributes	Description
CorrespondenceLanguageCode	Communication preference language code

Child Nodes:

Email
Facsimile
Telephone
Web
DisplayName
Name
PostalAddress

Child Node – ContactParty (multiple cardinality)

The structure for this node is similar to its parent party node. Since a party could have multiple contact parties, there is an additional element to identify the main contact party.

Elements	Description
MainIndicator	An indicator to identify one of the many contact parties as the main contact party.

The structure for this node is similar to its parent Party node. Since a Party could have multiple contact parties, there is an additional element to identify the main contact party.

Elements	Description
MainIndicator	An indicator to identify one of the many contact parties as the main contact party.

Child Nodes:

Address (same as in section 4.3.1)

Node – RequestedFulfillmentPeriodPeriodTerms

RequestedFulfilmentPeriod is the period in which the delivery of goods or the provision of services is requested.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
StartDateTime	To set the requested start date time.
EndDateTime (optional)	To set the requested end date time. If not provided, it is filled by the system based on the start date time.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <RequestedFulfillmentPeriodPeriodTerms>
   <StartDateTime>2016-05-30T08:28:40Z</StartDateTime>
  </RequestedFulfillmentPeriodPeriodTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
    <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <Quantity unitCode="HUR">5.0</Quantity>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – DeliveryTerms

DeliveryTerms are agreements that apply for the delivery of goods and provision of services in the Service Order.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
DeliveryPriorityCode	Coded representation of priority/urgency of delivery. Code Value Description: 1 Immediate; 2 Urgent; 3 Normal; 7 Low
Incoterms	Incoterms are typical contract formulations for delivery conditions that correspond to the rules defined by the International Chamber of Commerce (ICC).
PartialDeliveryControlCode	The partial delivery control specifies whether and in which form a customer allows partial deliveries. Code Value Description: 1 Multiple Deliveries; 2 Single on-time delivery; 3 Single delivery - full quantity; 4 Single delivery - full quantity of order; 5 Single on-time delivery of order; 6 Single on-time delivery of item; 7 Single delivery - full quantity of item; 8 Single on-time delivery - full quantity; 9 Single delivery
CompleteDeliveryRequestedIndicator	An indicator that signifies if the complete delivery of all the items in the order is requested or not.

Note: If PartialDeliveryControlCode is set to 1 then CompleteDeliveryRequestedIndicator cannot be set to true and vice versa.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <DeliveryTerms>
   <DeliveryPriorityCode>7</DeliveryPriorityCode>
   <Incoterms>
    <ClassificationCode>CIF</ClassificationCode>
    <TransferLocationName>NewYork</TransferLocationName>
   </Incoterms>
  </DeliveryTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
    <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
    <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – PricingTerms

PricingTerms are the characteristics used for pricing and valuation of goods and services in the Service Order.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
CurrencyCode	Currency for the valuation of the goods and services ordered (document currency).
PriceDateTime	Price date at which price specifications are determined using a rule for automatic scheduling.
GrossAmountIndicator	An indicator that specifies whether or not price and/or value is given as gross amount (including taxes).

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <PricingTerms>
   <CurrencyCode>USD</CurrencyCode>
   <GrossAmountIndicator>false</GrossAmountIndicator>
  </PricingTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
    <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – SalesTerms

SalesTerms are the agreements and conditions applicable for the sale of goods and services in the Service Order. Just can be used for modify a service order condition.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
CancellationReasonCode	CancellationReasonCode Reason for canceling a sales transaction. Can be set by both the buyer and seller. Code Value Description: 01 Delivery too late; 02 Quality issues; 03 Too expensive; 04 Competitor cheaper; 05 Competitor better quality; 06 Customer to receive replacement; 07 Warranty; 08 Other reason; 97 Cancellation from inbound delivery; 98 Customer cancellation by XI message; 99 Cancellation by system (obsolete)

Elements

Description

CancellationReasonCode

CancellationReasonCode Reason for canceling a sales transaction. Can be set by both the buyer and seller. Code Value Description: 01 Delivery too late; 02 Quality issues; 03 Too expensive; 04 Competitor cheaper; 05 Competitor better quality; 06 Customer to receive replacement; 07 Warranty; 08 Other reason; 97 Cancellation from inbound delivery; 98 Customer cancellation by XI message; 99 Cancellation by system (obsolete)

In this example, the request is to update an existing service order by cancelling it. The actionCode attribute on SalesTerms node and ChangeStateID element are optional.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader/> <ServiceOrder> <ID>3309</ID> <SalesTerms actionCode="04"> <CancellationReasonCode>01</CancellationReasonCode> </SalesTerms> <ChangeStateID>20111010113551.2609020</ChangeStateID> </ServiceOrder> </n0:ServiceOrderBundleMaintainRequest_sync>

Node – InvoiceTerms

InvoiceTerms are the agreements that apply for invoicing goods and services in the Service Order.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
ProposedInvoiceDate	Date on which the invoice is proposed to be created, with a rule for automatic scheduling.
InvoicingBlockingReasonCode	Specifies why processing of invoicing documents is blocked for the business transaction item. Code Value Description: 01 Calculation missing; 02 Confirmation still open; 03 Pricing incomplete; 90 Default invoice block reason for returns

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <InvoiceTerms actionCode="01">
   <ProposedInvoiceDate>2016-05-11</ProposedInvoiceDate>
  </InvoiceTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
    <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – PaymentControl

An agreement between a company and a business partner on processing payments for an individual business transaction. Credit card payment and external payment are the two types of payment processes supported for the sales scenario.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.
externalPaymentListCompleteTransmissionIndicator	ExternalPayment sub-node is of multiple cardinality.
creditCardPaymentListCompleteTransmissionIndicator	CreditCardPayment sub-node is of multiple cardinality.

Elements	Description
PaymentProcessingCompanyUUID	Company that is involved in the payment.
PaymentProcessingCompanyID	Internal identification of the Company that is involved in the payment.
PaymentProcessingBusinessPartnerUUID	Unique identifier of the Business Partner that is involved in the payment.
PaymentProcessingBusinessPartnerID	Unique identifier of the Business Partner that is involved in the payment.
ResponsibleEmployeeUUID	Contact person for questions about payment in the company that initiated the payment.
ResponsibleEmployeeID	Contact person for questions about payment in the company that initiated the payment.
PropertyMovementDirectionCode	Coded representation of the property change type from the view of the company (decrease or increase of means of payment). Code Value Description: 1 Decrease; 2 Increase
PaymentFormCode	Coded representation of the payment form. The payment form is the way a product or service is paid for. Code Value Description: 02Credit Card; 04 Direct Debit; 05 Bank Transfer; 06 Check; 07 Bill of change Payable Without Acceptance; 08 Bill of Exchange Payable with Acceptance; 09 Cash; 12 Wire Transfer; 13 Direct Debit (Authorization for Payer‟s Bank); 14 Bill of Exchange Payable Sole Bill; 15 Bill of Exchange Payable Commercial Transfer; 16 Bill of Exchange Receivable Without Acceptance; 17 Bill of Exchange Receivable with Acceptance; 18 Bill of Exchange Receivable Sole Bill; 19 Bill of Exchange Receivable Commercial Transfer; 20 External Payment; 21 Cash Outpayment
PaymentAmount	Payment amount in payment currency.
ExchangeRate	ExchangeRate is the representation of an exchange rate between two currencies, that is, the relationship in which one currency can be exchanged for another currency.
PaymentBlock	A PaymentBlock specifies the reason and time for a business document block in payment transactions. The PaymentBlock has the following sub-elements: PaymentBlockingReasonCode Code Value Description: 1 To be clarified with payer; 2 Complaint; 3 Payment method changed; 4 Other reason; ExpirationDateTime (mandatory element if PaymentBlock information is maintained) CreationIdentityUUID CreationDateTime
FirstPaymentInstructionTypeCode	First instruction key used for instructions for a payment.
SecondPaymentInstructionTypeCode	Second instruction key used for instructions for a payment.
ThirdPaymentInstructionTypeCode	Third instruction key used for instructions for a payment.
FourthPaymentInstructionTypeCode	Fourth instruction key used for instructions for a payment.
BankChargeBearerCode	The BankChargeBearerCode can be used to describe the distribution of costs between the initiator and the recipient of a payment transaction. Code Value Description: BEN Benificiary; OUR Initiator; SHA Sharing of costs
PaymentPriorityCode	Specifies that bank transactions of this business partner have priority. Code Value Description: 2 Urgent; 3 Normal
SinglePaymentIndicator	Indicator whether a payment request can be grouped together with another payment request.
DebitValueDate	Due date of the payment amount in the bank account of the party that initiated the payment.
CreditValueDate	Due date of the payment amount in the bank account of the party that received the payment.
PaymentReceivablesPayablesGroupID	Affiliation to a group of receivables or payables that are in relationship with each other for the purpose of common payment.
PaymentReferenceID	A PaymentReferenceID is assigned by a bank or a party to uniquely identify a transaction in the payment transaction. It is only unique in the context of the assigning bank or party and is only interpreted by them. Letters have to be in uppercase.
PaymentReferenceTypeCode	The PaymentReferenceTypeCode is used for specifying the type of a Payment Reference that is used for transferring a unique identification in payment processes. Code Value Description: 5 Transaction Reference Number of externally paid e- commerce order
Note	User-defined text that explains the payment.

Child Node – ExternalPayment (multiple cardinality)

The ExternalPayment node holds the details about processing a payment which has been executed externally.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
UUID	Universally unique identifier of the external payment node
HouseBankAccountUUID	A universally unique identifier of a house bank account that is involved in the payment on the company's side.
HouseBankAccountKeyInternalID	An internal identifier of a house bank account that is involved in a payment on the company's side.
PaymentTransactionReferenceID	A reference number for an external payment transaction.
DocumentDate	The document date of the external payment.
ValueDate	The value date of the external payment.
Amount	The amount paid in payment currency by the external payment.

The elements in the following sample xml are the minimal elements required while creating external payment information for a service order.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <PaymentControl actionCode="01" externalPaymentListCompleteTransmissionIndicator="true">
   <PaymentProcessingCompanyID>MC10000</PaymentProcessingCompanyID>
   <PaymentProcessingBusinessPartnerID>MC9785</PaymentProcessingBusinessPartnerID>
   <PaymentReferenceID>REF-12061</PaymentReferenceID>
   <PaymentReferenceTypeCode>5</PaymentReferenceTypeCode>
   <PropertyMovementDirectionCode>2</PropertyMovementDirectionCode>
   <PaymentFormCode>20</PaymentFormCode>
   <PaymentAmount currencyCode="USD">2000</PaymentAmount>
   <ExternalPayment actionCode="01">
    <HouseBankAccountKeyInternalID>BOA CONCENTRATION</HouseBankAccountKeyInternalID>
    <PaymentTransactionReferenceID>52786878234</PaymentTransactionReferenceID>
    <DocumentDate>2016-05-17</DocumentDate>
    <ValueDate>2016-05-31</ValueDate>
    <Amount currencyCode="USD">2000</Amount>
   </ExternalPayment>
  </PaymentControl>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
     <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Child Node – CreditCardPayment (multiple cardinality)

The CreditCardPayment node holds the Details about processing a payment with the payment procedure credit card.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.
creditCardPaymentAuthorisationListCompleteTransmissionIndicator	CreditCardPaymentAuthorisation sub-node is of multiple cardinality.

Elements	Description
UUID	Universally unique identifier of the credit card payment node
PaymentCardUUID	Universally unique identifier of a Payment Card.
PaymentCardKey	Key of a payment card and has the following sub-elements:ID - PaymentCardID is a unique identifier of a payment card that is assigned by the issuer of the payment card. TypeCode - A coded representation of the type of payment card. Code Value Description: 1 American Express; 2 VISA; 3 MasterCard; 4 Diners Club
BusinessPartnerPaymentCardDetailsKeyID	An identifier for the business partner payment card details.
PaymentCardDataOriginTypeCode	Information about the origin of the payment card data (manual entry, card reader).
PaymentCardAutomaticallyGeneratedIndicator	Indicates whether the payment card data was entered automatically or manually.
DeviceID	Identifier of the card reading device
LocationInternalID	Identifier of the location where the payment card was read
ClearingHouseAccountUUID	Universally unique identifier of the involved Clearing House Account
ClearingHouseAccountKeyID	Identifier of the involved Clearing House Account.
PaymentCardVerificationValueText	PaymentCardVerificationValueText is the verification code of payment cards. A verification code of a payment card is a security feature and is used for the authorization of payments with the payment card.
PaymentCardVerificationValueAvailabilityCode	A coded representation of the availability of a verification code on a payment card. Code Value Description: 0 Unknown; 1 Available; 2 Not readable; 9 Without
PaymentCardVerificationValueCheckRequiredIndicator
AuthorisationRequiredIndicator	Indicator whether or not an authorization should take place.
AuthorisationLimitAmount	Maximum amount that can be authorized for the card.
AuthorisationValueUnlimitedIndicator	Indicator whether the authorization amount is not fixed.
Amount	The amount paid in payment currency by payment card.
PaymentAuthorisedAmount
CompanyClearingHouseID	Identifier of the Company at the clearing house.

Child Node – CreditCardPaymentAuthorization (multiple cardinality)

A PaymentControlCreditCardPaymentAuthorisation are the authorization details of a Payment Control Credit Card Payment.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
UUID	Universally unique identifier of the credit card payment authorization node
ID	Identifier for an authorization of a card payment that is assigned by the payee.
ClearingHouseID	Identifier for an authorization of a card payment that is assigned by a clearing house for card payments.
ProviderID	Identifier for an authorization of a card payment that is assigned by a service provider for card payments. A service provider serves as a central entry point for credit card authorizations and settlements, possibly affecting multiple clearing houses or card issuers.
PaymentCardHolderAuthenticationID	Identifier set by the merchant during a payer authentication request. The number is used by issuers, acquirers and merchants in the resolution of disputes.
PaymentCardAutomaticallyGeneratedIndicator
PaymentCardHolderAuthenticationResultCode	Result of a card holder authentication.
PaymentCardHolderAuthenticationTokenText	Encrypted token concerning the PaymentCardHolder authentication check which is transferred from the Interoperability Domain to the clearing house or bank. This data must not be decrypted or changed in any way, as it is only transferred during the authorisation process.
DateTime	Date and time on which the authorization was carried out.
PaymentCardTransactionTypeCode	Type of a payment card transaction. Code Value Description: 1 Authorization; 2 Cancellation of Authorization; 3 Single Settlement; 4 Cancellation of Single Settlement; 5 Single Settlement of Payment Card Credit Memo; 6 Mass Settlement; 7 Mass Cancellation of Settlements; 8 Mass Settlement of Payment Card Credit Memos
PreAuthorisationIndicator	Specifies whether or not it is a preauthorization.
Amount	Amount that can be taken from the credit card in TransactionCurrency
ExpirationDateTime	Date and time until which the authorization is valid.
ActiveIndicator	Specifies whether or not the authorization can be used.
AppliedIndicator	Indicator whether or not this authorization was already used in the settlement.
ResultCode	Result of the authorization message to the clearing ouse. Code Value Description: 1 Successful; 2 Unsuccessful; 3 Not determined
PaymentCardAddressVerificationResultCode	Result of the address check during authorization (address result). Code Value Description: 1 Address and postal code check successful; 2 Address check successful, postal code check unsuccessful; 3 Address check unsuccessful, postal code check successful; 4 Address and postal code check unsuccessful; 5 Not determined
ProductRecipientPartyPaymentCardAddressVerificationResultCode	Result of the address check for the product recipient party
PaymentCardVerificationResultCode	Result of the card number check during authorization (response code). Code Value Description: 1 Card data check successful; 2 Card rejected, card data blocked; 3 Card rejected, call clearing house; 4 Card rejected, confiscate card; 5 Not determined
PaymentCardVerificationValueVerificationResultCode	Result of the card verification value check (CVV) during authorization. Code Value description: 1 Successful; 2 Unsuccessful; 3 Not determined
ResultDescription	Result text of the authorization.

Node – PriceAndTaxCalculation

A price and tax calculation is the summary of the determined price and tax components for a business case. A specification of the general procedure for price and tax determination and valuation using attributes those are characteristic or relevant for the whole object.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.
priceComponentListCompleteTransmissionIndicator	PriceComponent sub-node is of multiple cardinality.
productTaxDetailsListCompleteTransmissionIndicator	ProductTaxDetails sub-node is of multiple cardinality.
withholdingTaxDetailsListCompleteTransmissionIndicator	WithholdingTaxDetails sub-node is of multiple cardinality.

Child Node – PriceComponent (multiple cardinality)

Note: Price components under the PriceAndTaxCalculation can be created , modified and deleted. Details on how to create a sample update request is mentioned below.

Attributes	Description
actionCode	Refer to the General Rules section for more details.
priceComponentListCompleteTransmissionIndicator	Refer to the ListCompleteTransmissionIndicator section for more details
productTaxDetailsListCompleteTransmissionIndicator	Refer to the ListCompleteTransmissionIndicator section for more details
withholdingTaxDetailsListCompleteTransmissionIndicator	Refer to the ListCompleteTransmissionIndicator section for more details

<n0:ServiceOrderBundleMaintainRequest_sync
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader/>
<ServiceOrder>
<ObjectNodeSenderTechnicalID>72</ObjectNodeSenderTechnicalID>
<ChangeStateID>20111011112138.8012470</ChangeStateID>
<ID>3309</ID>
<PriceAndTaxCalculation>
<MainDiscount actionCode="04">
<Rate>
<DecimalValue>25</DecimalValue>
</Rate>
</MainDiscount>
<PriceComponent>
<UUID>00163e01-2e13-1ee0-bcff-65cddc6b117f</UUID>
<Rate>
<DecimalValue>70</DecimalValue>
</Rate>
</PriceComponent>

<PriceComponent>
<TypeCode>7PRB</TypeCode>
<Rate>
<DecimalValue>7</DecimalValue>
</Rate>
</PriceComponent>
</PriceAndTaxCalculation>
</ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Node – Item

Item of a customer-specific business transaction that focuses on delivering goods or providing a service, on the prices and on preparing the invoice. Item is the identifying and administrative item information in a Service Order which, in addition to the schedule lines, contains all the data that applies to the item, for example, the product information, the parties involved, the sales/delivery/Customer Invoicing-specific agreements, status and references, and so on.

Attributes	Description
itemScheduleLineListCompleteTransmissionIndicator	Sub-node ItemScheduleLine is of multiple cardinality.
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
ID	The identifier for a specific service order item (mandatory during modification of an existing item).
BuyerID	Unique identifier for a service order item assigned by the buyer.
ProcessingTypeCode	Coded representation of item processing of the Customer Transaction Document in the process component.
PostingDate	The creation time (posting time) of a Customer Transaction Document item from a business perspective.
Description	Short description of the item.
FulfilmentPartyCategoryCode	Party category of the fulfilment of a service order item. Code Value Description: 1 Internal; 2 External
ReleaseToExecute	An action call to release the items to execution. It will be invoked when the value is set to true.
FinishFulfilmentProcessing	An action call to fulfill the processing of the item. It will be invoked when the value is set to true.

Child Node – ItemProduct

ItemProduct is the identification, description and classification of the product (material or ServiceProduct) in the item.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
ProductID	An identifier for a product.
ProductInternalID	Internal identifier of the product
ProductStandardID	A standardized identifier for a product, and the identification scheme is managed by an agency from the code list DE 3055. "schemeAgencyID " identifies the agency that manages an identification scheme. The agencies from DE 3055 are used as the default, but the roles defined in DE 3055 cannot be used. The following codes are supported: 9 (EAN.UCC, International Numbering Association) for the GTIN (Global Trade Item Number), which can have up to 14 characters 5 (ISO, International Organization for Standardization) for the 13-character ISBN (International Standard Book Number).63 (NATO, North Atlantic Treaty Organization) for the NSN (NATO Stock Number) which has 13 characters (further information:http://www.nato.int/structur/AC/135/ncs_brochure/ncs_brochure_e/index.htm" Comment : For ISBN, the code "5" (ISO) is entered for schemeAgencyID along with the schemeID "ISO 2108: 1992", which indicates that it is an ISBN. The ISBN scheme is managed by http://isbn-international.org/ . Specifying a schemeID is not necessary if only one scheme exists for an agency. Another standardized identification scheme is the pharmaceutical central number. There is no SchemeAgencyID for this in the code list DE 3055. How this will be represented must still be clarified. Letters have to be in uppercase.
ProductBuyerID	Unique identifier for the product assigned by the buyer.
UnitOfMeasure	Unit of measure in which quantities are used for the product in the service order.
ProductRequirementSpecificationKey	To identify a product requirement specification.It describes the collection of requirements for a corresponding product used in the item. It also contains the corresponding specifications for fulfilling these requirements. The product requirement specification must belong to the corresponding product in the item.

In this sample xml, the request is to create a service order with one product.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
     <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Child Node – ItemScheduleLine (multiple cardinality)

An ItemScheduleLine is an agreement regarding when products of an item are requested or provided and in what amount.

Elements	Description
ID (mandatory during update if itemScheduleLineListCompleteTransmissionIndicator is false)	Unique identifier for an ItemScheduleLine assigned by the seller
TypeCode (mandatory during update if itemScheduleLineListCompleteTransmissionIndicator is false)	Coded representation of the type of an ItemScheduleLine such as RequestedScheduleLine. Code Value Description: 1 Requested; 2 Confirmed; 3 Promised; 4 Planned; 5 Fulfilled; 6 Released; 7 Not Confirmed; 8 Simulated
Quantity	Quantity with reference to TypeCode
DateTimePeriod	Time period with reference to TypeCode. This element can be used to provide a requested start and end date time for the item.

There are two ways to update an ItemScheduleLine. If the attribute itemScheduleLineListCompleteTransmissionIndicator is set as true at Item node, then the scheduleLine information can be very basic (that is, just the Quantity data). On setting this attribute, all existing ItemScheduleLine information are deleted and the ones passed in the requested are created. The quantity can be provided at two places in the payload, either under <Item> tag or under <ItemScheduleLine> tag. But providing both tags at the same time is not allowed. Always recommended to use <ItemScheduleLine> tag while creating or updating quantity of an item

Note: If the ItemScheduleLine information is passed for an item during the creation of the order, then the attribute itemScheduleLineListCompleteTransmissionIndicator of the parent node Item has to be set to true. This itemScheduleLine by default is created for TypeCode 1 (requested). The system always by default creates this node when the customer does not pass this information in the request. If this information is passed in the request, then by setting the said attribute to true, the when the order is created, the default node created by the system is deleted and replaced with the information passed in the request xml. <Item itemScheduleLineListCompleteTransmissionIndicator="true">

Child Node – ItemSalesTerms

ItemSalesTerms are item-specific agreements and conditions that apply for selling goods and services in the service order.

This node follows the same structure and consumption pattern as the sub-node SalesTerms of node SalesOrder. Please refer to Node – SalesTerms for more details.

Child Node – ShipFromItemLocation

Ship from item location represents the location from which goods are supplied or a service is provided.

Elements	Description
LocationID	Identifier of the Location.

Child Node – PriceAndTaxCalculationItem

PriceAndTaxCalculationItem is the specification for price and tax determination and valuation using attributes that are characteristic or relevant for the Service Order item.

This node follows the same structure and consumption pattern as the child-node PriceAndTaxCalculation of node SalesOrder. Please refer Node – PriceAndTaxCalculation for more details.

In addition to the structure of PriceAndTaxCalculation, PriceAndTaxCalculationItem has the following specialization

ItemMainDiscount (main discount value for the item)
ItemMainPrice (main price for the item)

Child Node – ItemTextCollection

A ItemTextCollection is a collection of all textual descriptions which are related to a Service Order item. Each text can include formatting information.

This node follows the same structure and consumption pattern as the child-node TextCollection of node SalesOrder. Please refer Node – TextCollection for more details.

Child Node – ItemAttachmentFolder

An ItemAttachmentFolder is the collection of all documents attached to a Service Order item.

This node follows the same structure and consumption pattern as the child-node AttachmentFolder of node SalesOrder. Please refer to Node – AttachmentFolder for more details.

Child Node – ItemInvoiceTerms

ItemInvoiceTerms is the agreement that apply for item invoicing goods and services in the Service Order.

Attributes	Description
actionCode	Refer to the General Rules for Using this Web Service section for more details.

Elements	Description
ProposedInvoiceDate	Date on which the invoice is proposed to be created, with a rule for automatic scheduling.
InvoicingIrrelevantIndicator	An indicator that indicates whether or not an item to be included in invoicing document. Possible Value: true ; false

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" >
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">Test HQ for Mig  Test Many Fields</Name>
  <BuyerID>HQ BUYER</BuyerID>
  <DateTime>2019-12-01T08:28:40Z</DateTime>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
   <ItemInvoiceTerms>
    <InvoicingIrrelevantIndicator>true</InvoicingIrrelevantIndicator>
    <ProposedInvoiceDate>2016-05-11</ProposedInvoiceDate>
   </ItemInvoiceTerms>
   <Quantity unitCode="HUR">5.0</Quantity>
  </Item>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Example

The following is a sample XML for creating a simple consistent Service Order with one Items, Account, BillTo and SalesUnit information.

<n0:ServiceOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS735F216FA2EBB96040B1:804">
 <BasicMessageHeader/>
 <ServiceOrder>
  <Name languageCode="EN">test_demo</Name>
  <BuyerID>DEMO BUYER</BuyerID>
  <DateTime>2016-05-26T08:28:40Z</DateTime>
  <SalesUnitParty>
   <PartyID>MC45000</PartyID>
  </SalesUnitParty>
  <BuyerParty>
   <PartyID>MC9785</PartyID>
  </BuyerParty>
  <PricingTerms>
   <CurrencyCode>USD</CurrencyCode>
   <GrossAmountIndicator>false</GrossAmountIndicator>
  </PricingTerms>
  <RequestInitialReceiptTimePoint>
   <DateTime>2016-05-23T08:28:40Z</DateTime>
  </RequestInitialReceiptTimePoint>
  <RequestedFulfillmentPeriodPeriodTerms>
   <StartDateTime>2016-05-30T08:28:40Z</StartDateTime>
  </RequestedFulfillmentPeriodPeriodTerms>
  <SalesAndServiceBusinessArea>
   <DistributionChannelCode>02</DistributionChannelCode>
  </SalesAndServiceBusinessArea>
  <ServiceReferenceObject>
   <MainIndicator>true</MainIndicator>
   <RegisteredProductKey>
    <ProductID>MCF-0040-01</ProductID>
   </RegisteredProductKey>
  </ServiceReferenceObject>
  <DeliveryTerms>
   <DeliveryPriorityCode>7</DeliveryPriorityCode>
   <Incoterms>
    <ClassificationCode>CIF</ClassificationCode>
    <TransferLocationName>NewYork</TransferLocationName>
   </Incoterms>
  </DeliveryTerms>
  <Item>
   <ProcessingTypeCode>SVP1</ProcessingTypeCode>
   <Description languageCode="EN">HQ test</Description>
   <MigrationListPrice currencyCode="   ">100.0</MigrationListPrice>
   <ItemProduct>
    <ProductInternalID>MCD-0471</ProductInternalID>
    <ProductTypeCode>2</ProductTypeCode>
    <UnitOfMeasure>HUR</UnitOfMeasure>
   </ItemProduct>
    <ItemScheduleLine>
    <ID>1</ID>
    <TypeCode>1</TypeCode>
     <Quantity unitCode="HUR">5.0</Quantity>
   </ItemScheduleLine>
   <ItemTextCollection>
    <Text>
     <TypeCode>10011</TypeCode>
     <ContentText>Internal </ContentText>
    </Text>
    <Text>
     <TypeCode>10024</TypeCode>
     <ContentText>Customer Info</ContentText>
    </Text>
   </ItemTextCollection>
   <RequestedFulfilmentItemPeriod>
    <StartDateTime timeZoneCode="GMTUK">2016-05-29T08:28:40Z</StartDateTime>
   </RequestedFulfilmentItemPeriod>
  </Item>
  <TextCollection>
   <Text>
    <TypeCode>10011</TypeCode>
    <ContentText>test for internal</ContentText>
   </Text>
   <Text>
    <TypeCode>10006</TypeCode>
    <ContentText>Test for incident</ContentText>
   </Text>
  </TextCollection>
  <CashDiscountTermsCode>1003</CashDiscountTermsCode>
 </ServiceOrder>
</n0:ServiceOrderBundleMaintainRequest_sync>

Change Log

Release	Change Description	Details
2002	Element InvoicingIrrelevantIndicator added	New element InvoicingIrrelevantIndicator added to request message type node ItemInvoiceTerms.

Description	Check service order
Name	CheckMaintainBundle
Synchronous	yes

Inbound Service ManageServiceOrderIn

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Prerequisites

Invoke Action

PricingTerms

CashDiscountTermsCode

PriceAndTaxCalculation

TextCollection

AttachmentFolder

Constraints and Integrity Conditions

General Rules for Using this Web Service

More Information

General Information

Scenarios

Operation Manage Service Order In Maintain as Bundle

Overview

Public Solution Model

Documentation

Definition

Business Context and Use

Structure

Root Node – Service Order

Node – SalesAndServiceBusinessArea

Node - Party

Child Node – Address

Child Node – ContactParty (multiple cardinality)

Node – RequestedFulfillmentPeriodPeriodTerms

Node – DeliveryTerms

Node – PricingTerms

Node – SalesTerms

Node – InvoiceTerms

Node – PaymentControl

Child Node – ExternalPayment (multiple cardinality)

Child Node – CreditCardPayment (multiple cardinality)

Child Node – CreditCardPaymentAuthorization (multiple cardinality)

Node – PriceAndTaxCalculation

Child Node – PriceComponent (multiple cardinality)

Node – Item

Child Node – ItemProduct

Child Node – ItemScheduleLine (multiple cardinality)

Child Node – ItemSalesTerms

Child Node – ShipFromItemLocation

Child Node – PriceAndTaxCalculationItem

Child Node – ItemTextCollection

Child Node – ItemAttachmentFolder

Child Node – ItemInvoiceTerms

Example

Change Log

Operation Manage Service Order In Check Maintain as Bundle

Overview

Public Solution Model

Documentation

Definition