Definition
An interface to replicate payments from a source system or file to a target system.
Business Context and Use
The web service interface Manage Cash Payment Order Entry In enables you to connect external applications to SAP Business ByDesign to create cash payment. The notified payment can be of type Incoming or Outgoing Cash Payments with Reference to Items.
The notification usually contains payment-specific information, such as the amount and date, and the parties involved in the payment. It also contains the reasons for the payment, typically reference to invoices. The payment amounts could be specified per invoice level and even explain differences between the expected and actual payment amounts.
The web service interface Manage Cash Payments In offers the operations MaintainBundle and CheckMaintainBundle.
Here is a very simple example:
<n0:PaymentOrderReferenceToItemsBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>1</ID>
<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
<ReferenceID>1</ReferenceID>
<ReferenceUUID >12345678-90AB-CDEF-0123-456789ABCDEF</ReferenceUUID>
</BasicMessageHeader>
<PaymentOrder>
<ActionCode>01</ActionCode>
<CompanyID>MDEC10000</CompanyID>
<CashLocationID>100006 EMPFANG</CashLocationID>
<ReceiptDate>1999-03-01</ReceiptDate>
<PaymentAmount currencyCode="EUR">643.81</PaymentAmount>
<PaymentDirectionCode>1</PaymentDirectionCode>
<ReceiptID>MDEC payment 1</ReceiptID>
<AccountingTransactionDate>1999-03-01</AccountingTransactionDate>
<DocumentDescription>Payment</DocumentDescription>
<BusinessPartnerID>MDEC9785</BusinessPartnerID>
<CashPaymentPartyName>Reitter</CashPaymentPartyName>
<PaymentExplanationItem>
<BusinessTransactionDocumentDate>1999-03-04</BusinessTransactionDocumentDate>
<CompanyID>MDEC10000</CompanyID>
<BusinessPartnerInternalID>MDEC9785</BusinessPartnerInternalID>
<NetAmount currencyCode="EUR">643.81</NetAmount>
<GrossAmount currencyCode="EUR">643.81</GrossAmount>
<Note languageCode="EN">Memo</Note>
<PaymentTransactionInitiatorInvoiceReference>
<ID>DECI-70</ID>
</PaymentTransactionInitiatorInvoiceReference>
<PaymentTransactionDestinatedInvoiceReference>
<ID>DECI-70</ID>
<TypeCode>127</TypeCode>
</PaymentTransactionDestinatedInvoiceReference>
</PaymentExplanationItem>
<PaymentExplanationNote>
<OrdinalNumberValue>119</OrdinalNumberValue>
<Note languageCode="EN">Note 1</Note>
</PaymentExplanationNote>
<PaymentExplanationNote>
<OrdinalNumberValue>121</OrdinalNumberValue>
<Note languageCode="DE">Kasse 2</Note>
</PaymentExplanationNote>
</PaymentOrder>
</n0:PaymentOrderReferenceToItemsBundleMaintainRequest_sync>
Prerequisites
The following business objects are only referenced and will not be created by the service operation. They must exist in the system already at the time the web service is called:
Company
Customer/Supplier
Petty Cash
Customer Invoice/Supplier Invoice
G/L Account
Constraints and Integrity Conditions
Change State ID
For this Web service, the change state ID does not apply to the ContactPerson, Relationship, CommunicationArrangement, DirectResponsibility, SalesArrangement, and PaymentData node elements.
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Definition
Bundle operation to create Cash Payments
Business Context and Use
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a PaymentOrder node element that contains the cash payment data to be created.
The response message type of the operation MaintainBundle contains log items, processing information and a payment order specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as payment order ID and payment order UUID.
Structure
The Identification Region of the Cash Payment UI contains the elements CashLocationID as Petty Cash (mandatory), and CompanyID as Company (mandatory).
Following data is related to Entry Details on the UI:
BusinessPartnerID is displayed on the UI either as Payee or Payer dependent on direction of cash payment (incoming or outgoing)
ReceiptDate is the date on which the receipt is issued (mandatory)
ReceiptID corresponds to Receipt Number on the UI
PaymentAmount is the sum of all the invoice references posted with this cash payment (mandatory)
PaymentDirectionCode is the direction of the cash payment (incoming or outgoing) (mandatory)
CashPaymentPartyName is the Name of the person who posted this cash payment and in the UI this is shown as Cash payer/Cash recipient
The Accounting Data section consists of:
AccountingTransactionDate is the date on which the business document is posted in financial accounting and is displayed as Posting Date on the UI (mandatory)
DocumentDescription is used for the header text in the journal entry (optional)
The Memo Line section consists of:
The References section consists of:
BusinessTransactionDocumentDate is displayed as Document Date
Net Amount is displayed as Net Amount
GrossAmount is displayed as Gross Amount
TransactionCurrencyGrossAmount is displayed as Gross Amount in Original Document Currency
CashDiscountAmount is displayed as Taken Cash Discount
TransactionCurrencyCashDiscountAmount is displayed as Cash Discount in Original Document Currency
Note is displayed as Memo Line (optional)
PaymentTransactionInitiatorInvoiceReference is displayed as External Reference
PaymentTransactionDestinatedInvoiceReference is displayed as Document ID
| If invoice references are already cleared, an on account payment will be created to the account of the entered BusinessPartnerID.
|
Definition
To check if cash payment data can be created without errors.
Business Context and Use
The web service request and response message types for the CheckMaintainBundle operation are the same as those of the MaintainBundle operation. The explanations given for MaintainBundle can therefore also be applied to the CheckMaintainBundle operation.
Show full documentation
Show full documentation