Definition
An interface to create multiple incoming cheques from a source system or file to a target system.
Business Context and Use
The web service Manage Incoming Cheque In enables you to connect external applications to your solution and to incoming cheques in your system.
The notification usually contains cheque-specific information, such as the amount and the cheque-id, and the parties involved in the payment. It can also contain the reasons for the cheque payment, typically reference to invoices. These can be put as a note.
The web service interface Manage Incoming Cheque In offers the operations MaintainBundle and CheckMaintainBundle.
Here is a very simple example:
<n0:IncomingChequeBundleMaintain xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
</BasicMessageHeader>
<IncomingCheque ActionCode="01">
<PayerChequeID>Test</PayerChequeID>
<PayeeCompanyID>MC10000</PayeeCompanyID>
<PaymentAmount currencyCode="EUR">100</PaymentAmount>
<Note languageCode="EN">This is an exemplary test cheque.</Note>
</IncomingCheque>
</n0:IncomingChequeBundleMaintain>
Prerequisites
Existence of referenced business objects:
The following business object is only referenced and will not be created by the service operation. It must exist in the system already at the time the web service is called:
Constraints and Integrity Conditions
More Information
General Information
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Scenarios
Possible scenarios include the following:
Here is an example web service request that creates two incoming cheques:
<n0:IncomingChequeBundleMaintain xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>11345678-90AB-CDEF-0123-456789ABCDEF</UUID>
</BasicMessageHeader>
<IncomingCheque ActionCode="01">
<PayerChequeID>Test1</PayerChequeID>
<PayerBusinessPartnerInternalID>MC6049</PayerBusinessPartnerInternalID>
<PayeeCompanyID>MC10000</PayeeCompanyID>
<PaymentAmount currencyCode="EUR">100</PaymentAmount>
</IncomingCheque>
<IncomingCheque ActionCode="01">
<PayerChequeID>Test2</PayerChequeID>
<PayerBusinessPartnerInternalID>MC9785</PayerBusinessPartnerInternalID>
<PayeeCompanyID>MC10000</PayeeCompanyID>
<PayerIncomingChequeBankAccount>
<ID>4567890</ID>
<Bank>
<RoutingID>56766755</RoutingID>
</Bank>
</PayerIncomingChequeBankAccount>
<IssueDate>2013-06-10</IssueDate>
<PaymentAmount currencyCode="USD">200.00</PaymentAmount>
<Note>This is the memo line of check</Note>
</IncomingCheque>
</n0:IncomingChequeBundleMaintain>
Definition
Bundle operation to create incoming cheques.
Business Context and Use
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as an Incoming Cheque node element that contains the Cheque data to be created. The detailed structure of the Incoming Cheque node will be explained in the following sub-chapters. The Incoming Cheque node can occur multiple times in the request message – this means that multiple Cheques can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a cheque-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Cheque ID.
Structure
The Incoming Cheque node element contains specific information about the incoming cheque that will be created.
The following data is related to the General Data section found in the Incoming Cheque Overview:
PayeeCompanyID is displayed on the UI as Company (mandatory)
PayeePartyName is the name of the company that is chosen in the company field
AccountingTransactionDate is the date on which the business document is posted in financial accounting and is displayed as Posting Date on the UI
The Check Data consists of:
PayerChequeID corresponds to Check Number on the UI (mandatory)
PaymentAmount consists of the positive amount and currency of the checksum and is displayed in the Payment Amount field (mandatory)
IssueDate is the date on which the check is issued and is displayed as Date of Issue on the UI
ExpectedValueDate is the date on which the incoming check becomes effective into the Payee account
EarliestCheuqeCashingDate is the earliest date on which the amount gets cashed into the Payee account for an postdated incoming check
The Payer Data contains the following data:
PayerBusinessPartnerInternalID is displayed on the UI as Payer
PayerPartyName is the name of the business partner that is chosen as Payer
IssuerName corresponding to field issuer
PayerIncomingChequeBankAccount contains the bank data of the Payer:
ID corresponding to the Bank Accound Number
StandardID corresponding to the field IBAN
Bank with BankStandardID corresponding SWIFT/BIC and BankRoutingID corresponding National Bank Code
The element Note corresponds to the Memo Line section.
Definition
To check if cheque 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