| Description | Manage Cash Payments |
| Name | ManagePaymentOrderIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Payment Processing |
| Process Component Name | PaymentProcessing |
| Process Component Namespace | http://sap.com/xi/AP/Payment/Global |
| Deployment Unit Description | Financials |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Released |
An interface to replicate payments from a source system or file to a target system.
The web service interface Manage Payment Order Entry In enables you to connect external applications to SAP Business ByDesign to create cash payment.
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 Payment Order Entry In offers the operations MaintainBundle and CheckMaintainBundle.
Here is a very simple example:
<n0:PaymentOrderBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID >1</ID> <UUID>12345678-90AB-CDEF-0123-456789ABCDFF</UUID> <ReferenceID></ReferenceID> <ReferenceUUID>12345678-90AB-CDEF-0123-456789ABCDFF</ReferenceUUID> </BasicMessageHeader> <PaymentOrder ActionCode="" ObjectNodeSenderTechnicalID="1"> <CompanyID>MC10000</CompanyID> <CashLocationID>100001 MAIN USD</CashLocationID> <ReceiptDate>2013-03-08</ReceiptDate> <ReceiptID>1</ReceiptID> <AccountingTransactionDate>2013-03-08</AccountingTransactionDate> <DocumentDescription>Test</DocumentDescription> <BusinessPartnerID></BusinessPartnerID> <GeneralLedgerAccountAliasCode>A-1500</GeneralLedgerAccountAliasCode> <GrossAmount currencyCode="USD">99</GrossAmount> </PaymentOrder> </n0:PaymentOrderBundleMaintainRequest_sync>
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
Petty Cash ID
G/L Account
For this Web service, the change state ID does not apply to the ContactPerson, Relationship, CommunicationArrangement, DirectResponsibility, SalesArrangement, and PaymentData node elements.
Many external applications consuming web services have special requirements and restrictions regarding the format of WSDLs. Some external applications require service definition WSDLs describing the web service signature. This is normally sufficient for the creation of static client-side proxies. Other external applications, normally those that do not create static client-side proxies, require binding WSDLs including the endpoint definition and authentication policy information.
In both cases, it may be the case that the external application imposes special restrictions on the structure or the size of WSDLs.
Microsoft InfoPath requires binding WSDLs and considers elements with the attribute "minOccurs=0" as "mandatory". However "minOccurs=0" means "optional" in SAP web services. In order to circumvent this problem, the WSDL must be saved locally and an additional attribute "nillable=true" must be added to make a query parameter optional for Microsoft InfoPath.
For very small clients such as mobile devices, the size of the WSDL itself may become a problem. In most cases the client only requires a very small part of the signature, but due to the complexity of the WSDL they may end up with long runtimes during serialization of the request or deserialization of the response. In order to circumvent this problem, the WSDL must be saved locally and the optional parts of the signature have to be removed before the WSDL is imported or static client-side proxies are generated.
External applications have to take into account that web service request and response message types can be enhanced with additional elements and attributes. Enhancements can be created by SAP, SAP partners, and administrators. Enhancements of request message types are always optional elements or attributes. The SAP system does not require the external application to provide values in the request. Enhancements of response message types can contain mandatory elements or attributes. The external application must be able to process the extended response successfully.
XML element and attribute names are always stable. Technical definitions of data types can be enhanced in a compatible way. This may result in changed data type names. External applications can rely on XML element names and attribute names, but should not rely on data type names.
Currently only cash payments are supported.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Check cash payments |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check if cash payment data can be created without errors.
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.
| Description | Maintain cash payments |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
Bundle operation to create cash payments
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Payment Order node element that contains the cash payment data to be created. The detailed structure of the payment order node will be explained in the following sub-chapters. The payment order node can occur multiple times in the request message – this means that multiple cash payments can be created through a single web service request.
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.
The Payment Order node element contains specific information about the cash payment.
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)
Either GrossAmount or NetAmount is equal to Payment Amount on the UI
ReceiptDate is the date on which the receipt is issued (mandatory)
ReceiptID corresponds to Receipt Number on the UI (mandatory)
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.
Account Assignment
The element TaxCountryCode corresponds to the Tax Country on the UI.
Table Account Assignment contains the following data:
GeneralLedgerAccountAliasCode - the available values are dependent on used Chart of Accounts of company and corresponds to G/L Account on UI
NetAmount - a positive net amount is displayed as Credit Net Amount while a negative net amount is displayed as Debit Net Amount on the UI
ProductTaxationCharacteristicsCode represents a tax use case from which the tax rate and tax event are derived automatically. The tax event determines in which field in the tax form the tax item is displayed. The available values are country-specific and on the UI the element is displayed as Tax Code
GrossAmount - a positive gross amount is displayed as Credit Gross Amount while a negative gross amount is displayed as Debit Gross Amount on the UI
CostCentreID - Cost Center
ProfitCentreID - Profit Center
ProjectTaskID - it depends on the project type if costs or revenues will be posted to the project. The element is displayed as Project Task on the UI
SalesOrderID - Sales Order
SalesOrderItemID - Sales Order Item
PermanentEstablishmentID defines a business residence that represents the company's geographical location, based on which, the company registers its tax reporting. This element is only relevant for India (IN) and corresponds to Tax Reporting Unit on the UI
TaxationRegionCode displays the State in the United States (US) and is taken into account for tax calulation (for US only)
TaxJurisdictionCode contains the tax determination rules specific to a tax area, and used to automatically derive the tax event and correct field in the tax form. This element is only relevant for the United States (US) and is displayed as Jurisdiction Code on the UI
| Either element NetAmount or GrossAmount (not both!) must be filled. |
| If no Account Assignment data is supplied, an on account payment will be assigned to the account of the entered BusinessPartnerID. |
| BusinessPartnerID must be supplied if creation of an on account payment is done. |
Show full documentation
Show full documentation
