Show full documentation

 Show full documentation

Definition

An interface to manage payment transactions by business partners sent from our house bank.

Business Context and Use

The web service interface Manage Bank Advice In enables you to connect external applications to SAP Business ByDesign to create payment confirmation notifications. The notified payment can be of type outgoing direct debits or incoming payments like 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.This webservice also supports direct posting to general ledger accounts for bank payment advices.

The web service interface Manage Bank Advice In offers the operations MaintainBundle and CheckMaintainBundle.

Here is an example for bank payment advice referring to an invoice:

<n0:BankAdviceBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
 <BasicMessageHeader>
  <ID schemeID="Token 1" schemeAgencyID="Token 2" schemeAgencySchemeAgencyID="Tok">Token 4</ID>
  <UUID schemeID="Token 5" schemeAgencyID="Token 6">12345678-90AB-CDEF-0123-456789ABCD1F</UUID>
  <ReferenceID schemeID="Token 7" schemeAgencyID="Token 8" schemeAgencySchemeAgencyID="Tok">Token 10</ReferenceID>
  <ReferenceUUID schemeID="Token 11" schemeAgencyID="Token 12">12345678-90AB-CDEF-0123-456789ABCDEF</ReferenceUUID>
 </BasicMessageHeader>
 <BankAdvice>
  <CompanyID>MC10000</CompanyID>
  <ExternalAdviceID>Disc1</ExternalAdviceID>
  <AccountDebitIndicator>false</AccountDebitIndicator>
  <AdviceDate>2015-06-03</AdviceDate>
  <PostingDate>2015-06-03</PostingDate>
  <PaymentFormCode>05</PaymentFormCode>
  <EffectivePaymentAmount currencyCode="USD">60</EffectivePaymentAmount>
  <HouseBankAccountInternalID>BOA SWEEP</HouseBankAccountInternalID>
  <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
  <PaymentExplanationItem>
   <ID>1</ID>
   <BusinessTransactionDocumentDate>2015-06-03</BusinessTransactionDocumentDate>
   <CompanyID>MC10000</CompanyID>
   <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID>
   <NetAmount currencyCode="USD">60</NetAmount>
   <CashDiscountAmount currencyCode="USD">3</CashDiscountAmount>


<PaymentTransactionDestinatedInvoiceReference>  <!--Document ID of the Invoice -->
    <ID>MCCI-214</ID>
   </PaymentTransactionDestinatedInvoiceReference>

<!--<PaymentTransactionInitiatorInvoiceReference>  //External Reference of the Invoice 
    <ID>MCCI-214</ID>
   </PaymentTransactionInitiatorInvoiceReference> -->


   <TotalDeductionAmount currencyCode="USD">2.25</TotalDeductionAmount>
   <ItemPaymentDifferenceExplanation>
    <ReasonCode>1</ReasonCode>
    <Amount currencyCode="USD">2</Amount>
   </ItemPaymentDifferenceExplanation>
   <ItemPaymentDifferenceExplanation>
    <ReasonCode>2</ReasonCode>
    <Amount currencyCode="USD">0.25</Amount>
   </ItemPaymentDifferenceExplanation>
   <ItemPaymentDifferenceExplanationListCompleteTransmissionIndicator>true</ItemPaymentDifferenceExplanationListCompleteTransmissionIndicator>
  </PaymentExplanationItem>
  <PaymentExplanationItemListCompleteTransmissionIndicator>true</PaymentExplanationItemListCompleteTransmissionIndicator>
 </BankAdvice>
</n0:BankAdviceBundleMaintainRequest_sync>

Here is an example for bank payment advice with posting to a G/L account:

<n0:BankAdviceBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">

<BasicMessageHeader>

<ID> </ID>

</BasicMessageHeader>

<BankAdvice>

<CompanyID>GCIT-1000</CompanyID>

<ExternalAdviceID>checkGL</ExternalAdviceID>

<AccountDebitIndicator>false</AccountDebitIndicator>

<AdviceDate>2021-06-08</AdviceDate>

<PostingDate>2021-06-08</PostingDate>

<PaymentFormCode>05</PaymentFormCode>

<EffectivePaymentAmount currencyCode="EUR">50</EffectivePaymentAmount>

<HouseBankAccountInternalID>1234512345678</HouseBankAccountInternalID>

<BusinessPartnerInternalID>GCITC20123</BusinessPartnerInternalID>

<DirectPostingtoGLAccountCountryCode>

<TaxCountryCode>IT</TaxCountryCode>

</DirectPostingtoGLAccountCountryCode>

<DirectPostingtoGLAccountItemDetailsBundle>

<GeneralLedgerAccountAliasCode>A-1500</GeneralLedgerAccountAliasCode>

<AccountingCodingBlockTypeCode>ACC</AccountingCodingBlockTypeCode>

<NetAmount currencyCode="EUR">50</NetAmount>

<ItemNote languageCode="EN">String</ItemNote>

</DirectPostingtoGLAccountItemDetailsBundle>

</BankAdvice>

</n0:BankAdviceBundleMaintainRequest_sync>

Prerequisites

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

• House Bank 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. Please open the Web Services document in a new window.

 Show full documentation

 Show full documentation

Definition

To check if bank advice 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

Definition

Bundle operation to create bank advices.

Business Context and Use

The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Bank Advice node element that contains the payment notification (bank) data to be created. The detailed structure of the bank advice node will be explained in the following sub-chapters. The bank advice node can occur multiple times in the request message – this means that multiple bank advices can be created through a single web service request referring to items & posting to G/L accounts.But a single advice can either have reference to items or posting to G/L.

.

The response message type of the operation MaintainBundle contains log items, processing information and a bank advice specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as bank advice internal ID and bank advice UUID.

Prerequisites

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

• House Bank Account

Structure

Bank Advice

Bank advice is an announcement of a payment transaction by a business partner to the company, specifying payment reasons.

The bank advice node element contains specific information about the payment transaction.

The General Data section of the Bank 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 if provided as true then the Advice Type is a Bank Debit Advice and if AccountDebitIndicator is false then the Advice Type is Bank Credit Advice (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)

• PostingDate is displayed as Posting Date (optional; defaulted by system to current date if not provided)

• AccountingDocumentNote is displayed as Document Description (optional)

• PaymentFormCode is displayed as Payment Method (mandatory)

• 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 (mandatory)

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)

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)

Following data is related to direct posting to G/L Account section on the UI:

I) Account Assignment Section

• TaxCountryCode is displayed as Tax Country/Region on th UI (mandatory)

• Entry Type on UI with Net/Gross value gets auto populated based on Net and Gross amount fields in below table section

II) G/L posting details table

• AccountingCodingBlockTypeCode is displayed as Account Assignemnt Type in UI table column possible values ACC(General Ledger Account only), CC(Cost Center), PRFT (Profit Center), PRO(Project task), SLS(sales Order) - ( Mandatory )

• GeneralLedgerAccountAliasCode is displayed as G/L Account in UI table column ( Mandatory )

• NetAmount is displayed for Debit Net Amount / Credit Net Amount in UItable column (optional if Gross amount is provided)

• GrossAmount is displayed for Debit Gross Amount / Credit Gross Amount in UI (optional if Net amount is provided)

• ProductTaxationCharacteristicsCode is displayed as Tax Code in UI tabe column( optional)

• TaxationRegionCode is provided as State in UI table column ( optional )

• TaxJurisdictionCode is provided as Jurisdiction Code in UI table column ( optional )

• CostCentreID is provided as Cost Center in UI table column ( optional )

• ProjectTaskID is provided as Project task in UI table column ( optional )

• ProfitCentreID is provided as Profit Center in UI table column ( optional )

• SalesOrderID is provided as Sales ORder in UI table column ( optional )

• SalesOrderItemID is provided as Sales Order Item in UI table column ( optional )

• ItemNote is provided as Description in UI table column ( optional )

• Fund ID & Function ID is provided as Fund and Function in UI table column ( Mandatory in Public Sector System )

Fund ID & Function ID are not supported in non-public sector system