| Description | Manage Payments |
| Name | ManagePaymentIn |
| Namespace | http://sap.com/xi/AP/CRM/Global |
| Process Component Description | Retail Execution Processing |
| Process Component Name | RetailExecutionProcessing |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
No documentation available.
| Description | Check Payment |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
Simulation of "MAINTAIN_BUNDLE"
Test check response of operaton "MAINTAIN_BUNDLE" of II_MANAGE_COD_REX_PYMNT_IN without commite the save.
| Description | Maintain Payment |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create or update (change, cancel or finish) a payment.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Payment node element that contains the Payment data to be created or updated. The Payment node can occur multiple times in the request message. This means that multiple payments can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information, and a payment -specific node with ChangeStateID as well as ID and UUID of the Payment.
There should be at least one open Invoice as a predecessor document to each Payment
The Payment node contains all relevant information which is required for creation or update of a payment, such as
general information like identifications, name, status, payment mode, payment date, paid amount and payer name
parties like employee responsible party and account party
cheque info
texts and attachments
invoice reference
The unique identifier of a payment. In creation case, it is automatically generated by the system. In update case, the ID must be provided.
The universally unique identifier of a payment. In creation case, it is automatically generated by the system. In update case, the UUID (or ID) must be provided.
The name of a Payment.
The BusinessTransactionDocumentTypeCode is required only if a customer special processing type code is used (instead of the standard processing type code).
The special processing type code which is provided must be available in the system (configuration).
The PaymentStatus which specifies the status of the Payment can be provided with the following values:
| PaymentStatus | Description |
|---|---|
| 0 | Open |
| 1 | Finished |
| 2 | Cancelled |
If it is not provided in payment creation case, the default value 0 will be set by the system.
Payment mode is to set to track the mode of the payment. The following values can be provided:
| PaymentMode | Description |
|---|---|
| 0 | Cash |
| 1 | Cheque |
PaymentDate is set to store the date of the payment made
PaymentAmount is used to store the amount and currency of the amount paid.
PayerName is used to store the name of the payer.
The AccountParty is mandatory data of a payment and shall be provided in payment creation case.
In standard case, only the ID (BusinessPartnerInternalID) of the account party needs to be provided.
The AddressUUID is required if multiple addresses exist in the master data for the account party and if the default address is not used.
The Address data is required only if a document address has to be provided.
Remark:
In order update case, the AccountParty shall not be provided once the order has been submitted because change of the AccountParty is then not allowed.
The EmployeeResponsibleParty can be specified either with the BusinessPartnerInternalID or the EmployeeID.
If the EmployeeResponsibleParty is not provided, it will be determined automatically by the system.
The BusinessTransactionDocumentReference is specified by ID, UUID, TypeCode and RoleCode of the referenced business document.
The ID and UUID do not need to be provided both. However one of them must be given.
Allowed values for the RoleCode are 1 (Predecessor) and 2 (Successor).
More than one BusinessTransactionDocumentReference can be provided. If the businessTransactionDocumentReferenceListCompleteTransmissionIndicator is set to true in order update case, the existing business transaction document references in the order will be replaced by the given business transaction document references.
For external references which are linked to an external business transaction documents, the schemeID of the ID/UUID for the referenced business document shall be filled with the name of the logical system where the external document is located. Currently only references to external sales orders as follow-up document of the customer order are supported. For internal references, the schemeID shall not be filled.
With Text, texts can be provided for specified TextTypeCode.
Allowed TextTypeCode value is '10011'
If the textListCompleteTransmissionIndicator is set to true in payment update case, the existing texts in the payment will be replaced by the given texts.
Additionally the text creation date time can be given. The TextID can also be provided in payment update case, but is optional.
Example:
Show full documentation
Show full documentation
<Text actionCode="01">
<TextTypeCode>10011</TextTypeCode>
<ContentText>header payment information</ContentText>
<CreationDateTime>2015-09-01T12:00:00.1234567Z</CreationDateTime>
</Text>
With AttachmentFolder, attachments can be provided.
The allowed attachment TypeCode for payment are 10001,10092 and 10093
The allowed CategoryCode values are '2' (Document attachment) and '3' (Link attachment).
Multiple attachments can be provided within the AttachmentFolder. If the DocumentListCompleteTransmissionIndicator is set to true in payment update case, the existing attachments in the payment will be replaced by the given attachments.
The Document UUID can be provided in payment update case, but is optional.
The ChequeInfo is an optional node for Payment creation. It contains cheque number, cheque date and bank name as details
The following xml message requests creation of a Payment with one Invoice as reference
<n0:PaymentBundleMaintainRequest_V1
xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<CreationDateTime>2006-03-28T12:00:00.1234567Z</CreationDateTime>
</BasicMessageHeader>
<Payment actionCode="01">
<Name languageCode="EN">Test BOUM2 Payment</Name>
<PaymentStatus>
<PaymentStatus>00</PaymentStatus>
</PaymentStatus>
<PaymentMode>0</PaymentMode>
<CreationDate>2015-01-24</CreationDate>
<PaymentAmount currencyCode="EUR">24</PaymentAmount>
<AccountParty>
<BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
<RoleCode>1001</RoleCode>
</AccountParty>
<BusinessTransactionDocumentReference actionCode="01">
<ObjectNodeSenderTechnicalID></ObjectNodeSenderTechnicalID>
<ID>67</ID>
<TypeCode>2208</TypeCode>
<RoleCode>1</RoleCode>
</BusinessTransactionDocumentReference>
<EmployeeResponsibleParty>
<BusinessPartnerInternalID>8000000505</BusinessPartnerInternalID>
<EmployeeID></EmployeeID>
</EmployeeResponsibleParty>
<PayerParty>
<BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
</PayerParty>
<ChangeStateID>Token 354</ChangeStateID>
</Payment>
</n0:PaymentBundleMaintainRequest_V1>
This xml message requests update of the Payment 386 with the following changes:
Change the status to 02
Change the Payment name to Test Payment update
Change the Payer name to Updated
<n0:PaymentBundleMaintainRequest_V1 xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<Payment actionCode="02">
<ID>386</ID>
<UUID>00163E07-C021-1ED5-A799-CA98C29C60FF</UUID>
<Name>Test Payment update</Name>
<PaymentStatus>
<PaymentStatus>02</PaymentStatus>
</PaymentStatus>
<PaymentMode>0</PaymentMode>
<PaymentAmount currencyCode="EUR">24</PaymentAmount>
<PaymentDate>1999-01-24</PaymentDate>
<PayerName>Updated</PayerName>
<ChangeStateID></ChangeStateID>
</Payment>
</n0:PaymentBundleMaintainRequest_V1>