Show full documentation

 Show full documentation

Definition

An interface to replicate DownPayment invoice request from a source system or file.

Business Context and Use

The web service interface DownPayment Request Invoicing In enables you to connect external applications to your Financials on Demand system and to create and edit DownPayment invoice requests in your system. The web service interface DownPayment Request Invoicing In is relevant if your company wants to manage DownPayment invoice requests from external applications.

The web service interface DownPayment Request Invoicing In offers the operation Maintain Bundle.

Here is an example of a simple web service request with minimal input data to create DownPayment invoice request:

<n0:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">

<BusinessDocumentBasicMessageHeader/>

<DownPaymentInvoiceRequest actionCode="01">

<BaseBusinessTransactionDocumentID>202107081205</BaseBusinessTransactionDocumentID>

<Name>MC9785</Name>

<ProposedInvoiceDate>2021-05-08</ProposedInvoiceDate>

<ProposedDeviatingPostingDate>2021-05-08</ProposedDeviatingPostingDate>

<BuyerParty>MC9785</BuyerParty>

<SalesUnitParty>MC43200</SalesUnitParty>

<EmployeeResponsibleParty>MC2471</EmployeeResponsibleParty>

<Amount currencyCode="USD">132</Amount>

<PricingTerms>

<PricingProcedureCode>PPNDP1</PricingProcedureCode>

<CurrencyCode>USD</CurrencyCode>

</PricingTerms>

<ExternalReferenceID>DPInvoiceRequest</ExternalReferenceID>

<SalesOrderReference>121651</SalesOrderReference>

</DownPaymentInvoiceRequest>

</n0:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync>

Here is an example of a simple web service request with minimal input data to Release DownPayment invoice requests:

<n0:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">

<BusinessDocumentBasicMessageHeader/>

<DownPaymentInvoiceRequest actionCode="02">

<BaseBusinessTransactionDocumentID>1310</BaseBusinessTransactionDocumentID>

<ReleaseDownPaymentIndicator>true</ReleaseDownPaymentIndicator>

</DownPaymentInvoiceRequest>

<DownPaymentInvoiceRequest actionCode="02">

<BaseBusinessTransactionDocumentID>1321</BaseBusinessTransactionDocumentID>

<ReleaseDownPaymentIndicator>true</ReleaseDownPaymentIndicator>

</DownPaymentInvoiceRequest>

</n0:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync>

Prerequisites

The following business entitis are only referenced and will not be created by the service operations. They must already exist in the system when the web service is called up. If not, the created customer invoice request will show inconsistencies:

• Organisational Data (Parties, SalesUnit)

Constraints and Integrity Conditions

Message Header

The operation Maintain External Customer Invoice Request supports exactly one execution (idem potency). To ensure exactly one execution of web service requests, the web service consumer has to provide unique values for the elements ID or UUID of the MessageHeader and BasicMessageHeader node element.

More Information

Scenarios

Possible scenarios include the following:

• create or update customer invoice requests

The operation Maintain Bundle is used to create or update DownPayment invoice requests.

The key is the BaseBusinessTransactionDocumentID and the system reads the existing data. If a DownPayment invoice request for this ID exits, the entry will be updated, otherwise the system creates a new DownPayment invoice request for this BaseBusinessTransactionDocumentID.

 Show full documentation

 Show full documentation

Definition

To check whether one or more DownPayment invoice requests can be maintained using imported structured data.

Business Context and Use

The Manage Downpayment Invoice Request In Check Maintain Bundle inbound operation checks whether one or more DownPayment invoice requests can be maintained in the target system.

 Show full documentation

 Show full documentation

Definition

To create, update, or cancel DownPayment invoice requests.

Business Context and Use

The request message of the operation Maintain DownPayment Invoice Request contains a MessageHeader node element as well as a DownPayment InvoiceRequest node element that can occur multiple times – this means that multiple DownPayment invoice requests can be created and updated with a single web service request. The DownpaymentInvoiceRequest node element contains the BasicMessageHeader and the DownPayment invoice request data to be created or updated. The detailed structure of the DownPaymentInvoiceRequest node will be explained in the following sub-chapters.

Structure

DownPayment InvoiceRequest

The DownPaymentInvoiceRequest node element contains all general information, such as BaseBusinessTransactionDocumentID which is the keyfield.

General Data

• Name

  The attribute Name corresponds to the UI Field Account Description.

• BaseBusinessTransactionDocumentID

  The attribute BaseBusinessTransactionDocumentID corresponds to the UI field DownPaymentInvoiceRequestID.

• ProposedInvoiceDate

  The attribute ProposedInvoiceDate will defines the InvoiceDate and is set to current date if no value is passed. During the creation of the DownPayment invoice request the invoice date can be overwritten.

• ProposedDeviatingPostingDate

  This date is used for a deviating posting date in financials. The default posting date is the ProposedInvoiceDate

• ReleaseDownPaymentIndicator

  The ReleaseDownPaymentIndicator indicates whether the DownPayment Invoice request must be released. if it is set to true, DownPayment Invoice reuqest will be released.

• CancelDownPaymentIndicator

  The CancelDownPaymentIndicator indicates whether the DownPayment invoice request must be cancelled. If it is set to true, DownPayment Invoice request will be cancelled.

Organisational Data

• BuyerParty (mandatory)

  A party (Customer) that purchases a good or a service.

• ProductRecipientParty (optional)

  A party (Customer) that receives a good or a service.

• BillToParty (optional)

  A party (Customer) that receives the invoice for goods or services.

• BillFromParty (optional)

  A party (Company) that carries out the billing process.

• SalesUnitParty (mandatory)

  A party (Functional Unit) that is responsible for the customer invoice request.

• PayerParty (optional)

  A party (Customer) that is requested to pay the payables from the delivery of goods or the provision of services or that is the recipient of a credit memo.

• EmployeeResponsibleParty (optional)

  A party (Employee) that is responsible for the customer invoice request.

• DocumentItemsGrossAmountIndicator

  The DocumentItemsGrossAmountIndicator if it set to true then it corresponds to the Gross Amount. If it set to false or no value passed in request, then it's considered as Net Amount (Net Pricing Procedure)

• Amount

  The Amount corresponds to the DownPayment Invoice Amount.

• CurrencyCode

  A coded representation of the currency in which the invoice is issued (invoice currency).

• SalesOrderReference (as of ByDesign 1808 Release)

  The Sales Order to which the Down Payment is assigned

• CustomerContractReference (as of ByDesign 1811 Release)

  The Customer Contract to which the Down Payment is assigned

• SalesAndServiceBusinessArea

  • DistributionChannelCode

    A distribution channel is a channel via which goods or services reach the customer.

Code Value	Description
01	Direct sales
02	Indirect sales

• ReceivablesPropertyMovementDirectionCode

  A coded representation of whether a customer invoice based on this item would increase or decrease receivables.

  Note: it's an optional request parameter and if not passed it's defaulted to value 2

Code Value	Description
2	Increase - Invoice Item

• ProcessingTypeCode

  A coded representation of a customer invoice item processing type.

  Note: it's an optional request parameter and if not passed its defaulted to value CII

Code Value	Description
CII	Invoice Item

Node ProductTaxDetails

The node ProductTaxDetails contain the TaxationCharacteristicsCode that is determined internally but can be changed externally (Note: If wrong tax code is sent then warning message is returned in response and internally determined taxcode is used).

The tax code depends on the country and represents the tax event, tax type and tax rate type. The tax event controls how taxes are posted in the tax return.

ListID / Country	Code Value	Description
US	521	Outgoing Down Payment Invoice
NL	501	Domestic Sale of Goods, StndRate
CN	511	Exempted domestic sale of products, down payment
MX	501	Domestic Sale - Goods
BA	313	Domestic Supply, Down payments - Tax Payers
ES	310	Export of Service, Reverse Charge
JP	310	Export of Service, Reverse Charge
KZ	310	Export of Service, Reverse Charge
AE	300	Non-Taxable Sale
BR	300	Non-Taxable Sale
HK	300	Non-Taxable Sale

DownPaymentInvoiceRequestResponse

DownPayment Invoice Request ID and UUID

Change State ID and Sender Techinical ID

Log: Containing the error messages from the processing of the request.

More Information

Sample XML

Down Payment with Sales Order reference

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:glob="http://sap.com/xi/SAPGlobal20/Global">
    <soapenv:Header />
    <soapenv:Body>
        <glob:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync>
                <BusinessDocumentBasicMessageHeader>
                </BusinessDocumentBasicMessageHeader>
                <DownPaymentInvoiceRequest actionCode="04">
                <BaseBusinessTransactionDocumentID>6011</BaseBusinessTransactionDocumentID>
                <ProposedInvoiceDate>2018-11-26</ProposedInvoiceDate>
                <ProposedDeviatingPostingDate>2018-11-26</ProposedDeviatingPostingDate>
                <BuyerParty>MC6049</BuyerParty>
                <BillToParty>MC6049</BillToParty>
                <BillFromParty>MC10000</BillFromParty>
                <SalesUnitParty>MC42162</SalesUnitParty>
                <PayerParty>MC6049</PayerParty>
                <PricingTerms>
                    <PricingProcedureCode>PPNDP1</PricingProcedureCode>
                    <CurrencyCode>USD</CurrencyCode>
                </PricingTerms>
                <ExternalReferenceID>Demo_test10</ExternalReferenceID>
                <Amount currencyCode="USD">100</Amount>
                <SalesOrderReference>740</SalesOrderReference>
            </DownPaymentInvoiceRequest>
        </glob:DownPaymentCustomerInvoiceRequestBundleMaintainReqiest_sync>
    </soapenv:Body>
</soapenv:Envelope>