SAP Business ByDesign - OData API Examples

• Sample OData service tmserviceorder.xml enhanced by service order lifecycle status
• Scenario "Drop Shipment": SOAP request to create third-party delivery notification replaced by corresponding OData request.
• Scenario "Procure to Stock": Request "Accept supplier invoice exception" removed (not needed after ByD update to SP02)

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global" xmlns:glob1="http://sap.com/xi/AP/Globalization">
    <soapenv:Header/>
    <soapenv:Body>
        <glob:CustomerInvoiceRequestBundleMaintainRequest_sync>
            <BusinessDocumentBasicMessageHeader>
                <!-- Enter message header UUID for idem potency! -->
                <!-- <UUID>?</UUID> -->
            </BusinessDocumentBasicMessageHeader>
            <CustomerInvoiceRequest actionCode="01" itemListCompleteTransmissionIndicator="false">
                <ObjectNodeSenderTechnicalID>HDR_1</ObjectNodeSenderTechnicalID>
                <BaseBusinessTransactionDocumentID>{{CustomerInvoiceRequestID}}</BaseBusinessTransactionDocumentID>
                <Name>My customer invoice with external payment</Name>
                <!-- SettlementPriorityCode: 
                 1 = Immediate - create custom invoice, 
                 2 = Urgent - stop if a down payment exists
                 3 = Normal - save invoice request with status "to be invoiced" -->
                <SettlementPriorityCode>1</SettlementPriorityCode>
                <ReferenceBusinessTransactionDocumentID>{{InvoiceRequestExternalReference}}</ReferenceBusinessTransactionDocumentID> <!-- External Reference -->
                <BuyerParty>
                    <InternalID>{{CustomerID}}</InternalID>
                </BuyerParty>
                <SalesUnitParty>
                    <InternalID>{{SalesUnitID}}</InternalID>
                </SalesUnitParty>
                <CashDiscountTerms>
                    <!-- 1001 = immediately net; 1006 = 10 days 5% -->
                    <Code>1001</Code>
                    <!-- <FullPaymentEndDate>2019-05-30</FullPaymentEndDate> -->
                </CashDiscountTerms>
                <PaymentControl>
                    <!-- PaymentFormCode: 04 = Direct Debit, 20 = External Payment -->
                    <PaymentFormCode>20</PaymentFormCode>
                    <PaymentReferenceID>{{PaymentReferenceID}}</PaymentReferenceID>
                    <!-- used to clear the payment -->
                    <PaymentReferenceTypeCode>5</PaymentReferenceTypeCode>
                    <PaymentServiceSubscriberID>{{CompanyID}}</PaymentServiceSubscriberID>
                    <PaymentServiceCustomerID>{{CustomerID}}</PaymentServiceCustomerID>
                    <ExternalPayment actionCode="01">
                        <!-- <UUID>?</UUID> -->
                        <!-- Bank Account ID from UI screen My Bank >> View All >> Bank Accounts -->
                        <HouseBankAccountKeyInternalID>{{HouseBankAccountID}}</HouseBankAccountKeyInternalID>
                        <!-- House bank: 1000644 - ABN AMRO Bank -->
                        <PaymentTransactionReferenceID>{{PaymentTransactionReferenceID}}</PaymentTransactionReferenceID>
                        <DocumentDate>{{DocumentDate}}</DocumentDate>
                        <ValueDate>{{ValueDate}}</ValueDate>
                        <Amount currencyCode="USD">220</Amount>
                    </ExternalPayment>
                </PaymentControl>
                <PricingTerms>
                    <!-- PricingProcedureCode: PPGP02 = Standard Gross Procedure, PPSTD1 = Standard Procedure -->
                    <PricingProcedureCode>PPGP02</PricingProcedureCode>
                    <CurrencyCode>USD</CurrencyCode>
                </PricingTerms>
<!-- Invoice item | service product | tax code derived by system -->
                <Item>
                    <BaseBusinessTransactionDocumentItemID>10</BaseBusinessTransactionDocumentItemID>
                    <!-- ReceivablesPropertyMovementDirectionCode: 1 = Invoice item, 2 = Credit memo item -->
                 <ReceivablesPropertyMovementDirectionCode>2</ReceivablesPropertyMovementDirectionCode>
                    <!-- <Description languageCode="EN">My invoice item</Description> -->
                    <CashDiscountDeductibleIndicator>false</CashDiscountDeductibleIndicator>
                    <Product>
                        <InternalID>{{ServiceProductID2}}</InternalID>
                        <TypeCode>2</TypeCode>
                    </Product>
                    <Quantity unitCode="HUR">10</Quantity>
                    <QuantityTypeCode>TIME</QuantityTypeCode>
                    <PriceAndTax>
                        <!-- List Price -->
                        <PriceComponent>
                            <!-- TypeCode: 8PR1 = Gross list price, 7PR1 = Net list price -->
                            <TypeCode>8PR1</TypeCode>
                            <Rate>
                                <DecimalValue>120</DecimalValue>
                                <CurrencyCode>USD</CurrencyCode>
                                <BaseDecimalValue>10</BaseDecimalValue>
                                <BaseMeasureUnitCode>HUR</BaseMeasureUnitCode>
                            </Rate>
                        </PriceComponent>
                    </PriceAndTax>
                    <ObjectNodeSenderTechnicalID>ITM_1</ObjectNodeSenderTechnicalID>
                </Item>
<!-- Invoice item | free text -->
                <Item>
                    <BaseBusinessTransactionDocumentItemID>20</BaseBusinessTransactionDocumentItemID>
                    <ReceivablesPropertyMovementDirectionCode>2</ReceivablesPropertyMovementDirectionCode>
                    <Description languageCode="EN">My free text invoice item</Description>
                    <CashDiscountDeductibleIndicator>false</CashDiscountDeductibleIndicator>
                    <Quantity unitCode="EA">1</Quantity>
                    <QuantityTypeCode>EA</QuantityTypeCode>
                    <PriceAndTax>
                        <!-- List Price -->
                        <PriceComponent>
                            <TypeCode>8PR1</TypeCode>
                            <Rate>
                                <DecimalValue>100.00</DecimalValue>
                                <CurrencyCode>USD</CurrencyCode>
                            </Rate>
                        </PriceComponent>
                    </PriceAndTax>
                    <ProductTaxDetails>
                        <ProductTaxationCharacteristicsCode listID="US">500</ProductTaxationCharacteristicsCode>
                    </ProductTaxDetails>
                    <AccountingCodingBlockAssignment>
                        <AccountingCodingBlock>
                            <AccountingCodingBlockTypeCode>ACC</AccountingCodingBlockTypeCode>
                            <GeneralLedgerAccountAliasCode>A-1700</GeneralLedgerAccountAliasCode>
                        </AccountingCodingBlock>
                    </AccountingCodingBlockAssignment>
                    <ObjectNodeSenderTechnicalID>ITM_2</ObjectNodeSenderTechnicalID>
                </Item>
            </CustomerInvoiceRequest>
        </glob:CustomerInvoiceRequestBundleMaintainRequest_sync>
    </soapenv:Body>
</soapenv:Envelope>

Hi Jasmin,

please do the following:

1. Add the node Root/TextCollection/Text to the service order OData service. As result you get a collection “ServiceOrderText” (I renamed it to “Text”) in the OData service.
2. Now you can create, update and read the incident description using this collection. The text referring to the incident description has TypeCode “10006”.

Text TypeCodes:

• Incident description: 10006
• Customer Information: 10024
• Internal Comment: 10011

Best regards,
Knut

Update: Today I uploaded a new version of API sample packages to the GitHub repository:

• I restructured the repository to simplify installation and configuration.
• Refactored and new sample OData services for master data incl. organisational structures, employees, business partners, customer, suppliers, employees, positions, materials and service products
• Enhanced sample OData services for sales order, customer invoice request, customer invoices, …
• New examples to order services and procure services
• New examples to sell products from stock with external payment
• New examples to process customer returns
• New examples to pre-confirm payments using clearing house statements
• New examples to confirm payments and clear open items using bank statements
• New examples to create and process invoices with external payment
• New examples to create sales orders with external prices, discounts and surcharges
• New examples to access the payment monitor
• Correction of supplier invoice examples to post invoices

CustomerInvoiceRequestBundleMaintainRequest_sync

• Mandatory elements are PlannedCostAmount and PlannedPeriod.
• Make sure you added task plan data (e.g. planned expenses) before adding period plans because otherwise the period plans cannot be propagated and aggregated to upper levels correctly.
  Take into account that you have to schedule the task as well.
• The sum (total amount) of all task expense period plan items needs to match the task expense amount. If this is not the case, then the system creates an additional period plan item with the remaining amount (this item is marked by the element Indicator - so I would suggest to add this element to the OData service as well).
• The Description of period plans is not mandatory, but might be important from a business semantics point of view.

Hi.
Im using the SOAP API for Suppliers to create new Suppliers.
I am able to successfully create suppliers with addresses , contacts, sales and payment data etc...
My only issue is that I cant seem to cretae the business communication E-MAil in the contacts tab for the contacts I create.
The phone data is created, the fax data is created but not the email...
This is how the contacts section of my template looks:

<ContactPerson actionCode="01" workplaceTelephoneListCompleteTransmissionIndicator="true">
                <DefaultContactPersonIndicator>true</DefaultContactPersonIndicator>
                <FamilyName>name</FamilyName>
                <GivenName>lastname</GivenName>
                <WorkplaceEmailURI>[email protected]</WorkplaceEmailURI>
                <WorkplaceFacsimileFormattedNumberDescription>fax number</WorkplaceFacsimileFormattedNumberDescription>
                <WorkplaceTelephone>
                    <FormattedNumberDescription>phonenumber</FormattedNumberDescription>
                </WorkplaceTelephone>
            </ContactPerson>

Like i wrote above, this all works except the email.
thank you.

Hi Knut,

Thank you so much for your reply.
I took the element name directly from the WSDL and/or the examples in the API guides.
When it did not work i did raise an incident, was more than a week ago and i did not hear anything since.

Best regards,
Yan

Update: Examples for SAP Business ByDesign KPIs.

I added a new Postman collection "Analytics - KPIs" with examples to access ByD KPIs using the OData API for KPIs.
The Postman collection works with the previously published Postman environment "Analytics".

Hi Knut, thank you very much the Postman works great (tested GET only).
Bute there is still one question. How can I add PriceComponent and ItemPriceComponent to my OData service? The matter is I don't have this nodes within the object ItemPriceAndTaxCalculation, only four other nodes.

Thank you, best regards,
Markus