| Description | Manage Remittance Advices |
| Name | ManageRemittanceAdviceIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Product | SAP Business ByDesign |
| Process component | Payment Processing |
| Process component namespace | http://sap.com/xi/AP/Payment/Global |
| Deployment unit | Financials |
| Endpoint Activation | By Scoping of Process Component | Operations |
|
| Release Status | Released |
| Technical documentation on the SAP API Business Hub | Manage Remittance Advices |
| General web service documentation | A2X Web Services (SOAP) |
An interface to manage notifications of payment transactions by business partners.
The web service interface Manage Remittance Advice In enables you to connect external applications to SAP Business ByDesign to create payment notifications. The notified payment can be of type outgoing direct debits or incoming payments like incoming check, bank transfer.
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 Remittance Advice In offers the operations MaintainBundle and CheckMaintainBundle.
Here is a very simple example:
Show full documentation
Show full documentation
<n0:RemittanceAdviceBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
</BasicMessageHeader>
<RemittanceAdvice>
<CompanyID>MC10000</CompanyID>
<ExternalAdviceID>ADVFORNEFT12</ExternalAdviceID>
<AccountDebitIndicator>false</AccountDebitIndicator>
<AdviceDate>2013-01-24</AdviceDate>
<PaymentFormCode>05</PaymentFormCode>
<PaymentReference>
<ID>NEFT12</ID>
</PaymentReference>
<EffectivePaymentAmount currencyCode="USD">169</EffectivePaymentAmount>
<BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
<RemittanceAdvicePaymentExplanationItem>
<ID>1</ID>
<BusinessTransactionDocumentDate>2013-01-04</BusinessTransactionDocumentDate>
<NetAmount currencyCode="USD">169</NetAmount>
<GrossAmount currencyCode="USD">177</GrossAmount>
<CashDiscountAmount currencyCode="USD">8</CashDiscountAmount>
<TotalDeductionAmount currencyCode="USD">2.41</TotalDeductionAmount>
<PaymentTransactionDestinatedInvoiceReference> <!-- Document ID of the Invoice -->
<ID>MCCI-206</ID>
</PaymentTransactionDestinatedInvoiceReference>
<!-- <PaymentTransactionInitiatorInvoiceReference> //External Reference of the Invoice
<ID>MCCI-214</ID>
</PaymentTransactionInitiatorInvoiceReference> -->
<ItemPaymentDifferenceExplanation>
<ReasonCode>1</ReasonCode>
<Amount currencyCode="USD">2.41</Amount>
</ItemPaymentDifferenceExplanation>
<ItemPaymentDifferenceExplanationListCompleteTransmissionIndicator>true</ItemPaymentDifferenceExplanationListCompleteTransmissionIndicator>
</RemittanceAdvicePaymentExplanationItem>
<PaymentExplanationItemListCompleteTransmissionIndicator>true</PaymentExplanationItemListCompleteTransmissionIndicator>
</RemittanceAdvice>
</n0:RemittanceAdviceBundleMaintainRequest_sync>
Existence of referenced business objects:
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
Business Partner
For this Web service, the change state ID does not apply to the ContactPerson, Relationship, CommunicationArrangement, DirectResponsibility, SalesArrangement, or PaymentData node elements.
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.
One of the example web service request to create a partner credit advice with invoice reference.
<n0:RemittanceAdviceBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>12345678-90AB-CDEF-0123-456789ABCDEF</UUID>
</BasicMessageHeader>
<RemittanceAdvice>
<CompanyID>MC10000</CompanyID>
<ExternalAdviceID>ADV_CHQ_1234</ExternalAdviceID>
<AccountDebitIndicator>false</AccountDebitIndicator>
<AdviceDate>2013-01-24</AdviceDate>
<PaymentFormCode>06</PaymentFormCode>
<PaymentReference>
<ID>CHQ-1234</ID>
</PaymentReference>
<EffectivePaymentAmount currencyCode="USD">155</EffectivePaymentAmount>
<BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
<PaymentExplanationItem>
<ID>1</ID>
<BusinessTransactionDocumentDate>2013-01-04</BusinessTransactionDocumentDate>
<NetAmount currencyCode="USD">155</NetAmount>
<PaymentTransactionDestinatedInvoiceReference>
<ID>MCCI-1234</ID>
</PaymentExplanationItem>
<PaymentExplanationItemListCompleteTransmissionIndicator>true</PaymentExplanationItemListCompleteTransmissionIndicator>
</RemittanceAdvice>
</n0:RemittanceAdviceBundleMaintainRequest_sync>
| Description | Check remittance advices |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check if remittance advice 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 remittance advices |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
Bundle operation to create remittance advices.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Remittance Advice node element that contains the payment notification (remittance) data to be created. The detailed structure of the remittance advice node will be explained in the following sub-chapters. The remittance advice node can occur multiple times in the request message – this means that multiple remittance advices can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a remittance advice specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as remittance advice internal ID and remittance advice UUID.
Existence of referenced business objects:
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
Business Partner
Remittance Advice
Remittance advice is an announcement of a payment transaction by a business partner to the company, specifying payment reasons.
The remittance advice node element contains specific information about the payment transaction.
The General Data section of the Remittance Advice UI contains the element CompanyID as Company (mandatory).
Following data is related to Payment Advice Data section on the UI:
ExternalAdviceID is displayed as Advice ID (optional)
AccountDebitIndicator is displayed as DebitAdvice indicator (mandatory; blank is considered as false, so it is considered as a credit advice)
AdviceDate is displayed as Advice Date (optional; defaulted by system to current date if not provided)
PaymentDate is displayed as Payment Date (optional; defaulted by system to current date if not provided)
PaymentFormCode is displayed as Payment Method (optional)
PaymentReference is displayed as Payment Reference
EffectivePaymentAmount is displayed as Payment Amount (mandatory)
Following data is related to Payer/Payee Data section on the UI:
BusinessPartnerInternalID is displayed as Payer/Payee ID (mandatory)
Following data is related to Bank Data section on the UI:
HouseBankAccountInternalID is displayed as Bank Account ID (optional)
Following data is related to Memo Line section on the UI:
PaymentExplanationNote is displayed as Memo Line (optional)
Following data is related to the References section on the UI:
BusinessTransactionDocumentDate is displayed as Document Date (optional)
Net Amount is displayed as Payment Amount (optional)
GrossAmount is displayed as Gross Amount (optional)
TransactionCurrencyGrossAmount is displayed as Gross Amount in Original Document Currency (optional)
CashDiscountAmount is displayed as Taken Cash Discount (optional)
TransactionCurrencyCashDiscountAmount is displayed as Cash Discount in Original Document Currency (optional)
TotalDeductionAmount is displayed as Total Deduction Amount. This should be the sum of all the discounts with a Payment Difference Reason (optional)
Note is displayed as Memo Line (optional)
PaymentTransactionInitiatorInvoiceReference is displayed as Invoice ID (optional)
PostOnBusinessPartnerAccountIndicator (optional). This check box when set indicates that the amount should be posted on the business partner that is mentioned on the explanation items
Following data is displayed on the Manual Payment Clearing screen
ReasonCode is displayed on Additional Discounts and Credits link (optional)
Amount is displayed on Additional Discounts and Credits link (optional)