Description | Manage Bank Statements |
Name | ManageBankStatementIn |
Namespace | http://sap.com/xi/AP/Payment/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 manage banking transactions by customers through Bank Statements.
The web service interface Manage Bank Statements enables you to connect external applications to SAP Business ByDesign to create and edit Bank Statements in your system.
This web service offers the operations MaintainBundle and CheckMaintainBundle.
MaintainBundle will save the changes at the end of its process if no error occurs, while CheckMaintainBundle will not save the changes.
Here is an example of a simple web service request which uses the MaintainBundle operation to create a new Bank Statement with the following information:
Action code as "01" for the Bank Statement node element,
Statement ID as 1,
Company as MC10000,
House bank account as 110000062588,
Credit amount as 1 USD,
Item amount as 1,
Item ID as 1,
Business partner as MC2000,
Payment transaction category as incoming bank transfer,
Payment amount as 1 USD.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="01"> <BankStatementExternalProviderID>1</BankStatementExternalProviderID> <CompanyID>MC10000</CompanyID> <HouseBankAccount> <ID>110000062588</ID> </HouseBankAccount> <DocumentDescription>TEST</DocumentDescription> <StatementDate>2020-09-17</StatementDate> <ValidityYear>2020</ValidityYear> <PostingDate>2020-09-17</PostingDate> <OpeningBalanceAmount currencyCode="USD">1289630.38</OpeningBalanceAmount> <ClosingBalanceAmount currencyCode="USD">1289631.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">1</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">0</DebitTotalAmount> <ItemsTotalNumberValue>1</ItemsTotalNumberValue> <Item ActionCode="01"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>48</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
You must have access to the Bank Statements work center view under Liquidity Management to access and view the Bank Statements created through this web service.
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
House Bank Account
Business Partner
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.
Description | Check bank statements |
Name | CheckMaintainBundle |
Synchronous | yes |
Release Status | Released |
To check if Bank Statements 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 except for the saving action at the end of the process. The explanations given for MaintainBundle can therefore also be applied to the CheckMaintainBundle operation.
Description | Maintain bank statements |
Name | MaintainBundle |
Synchronous | yes |
Release Status | Released |
Bundle operation to create Bank Statements.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a Bank Statement node element that contains the Bank Statement data to be created. The detailed structure of the Bank Statement node will be explained in the following sub-chapters. The Bank Statement node can occur multiple times in the request message – this means that multiple Bank Statements can be created through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information and a Bank Statement specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as Bank Statement internal ID and Bank Statement 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
House Bank Account
Business Partner
The Bank Statement structure contains all general Bank Statement information.
Bank Statement ID
Company ID
House Bank Account
Document Description
Statement Date
Validity Year
Posting Date
Opening Balance
Closing Balance
Debit Total Amount
Credit Total Amount
Release Bank Statement
Action to post a Bank Statement. It will be invoked when the value is set to true.
Items Total Number Value
Item List Complete Transmission Indicator
Approval Status Code is deprecated and is no longer supported. Instead, use ReleaseBankStatement to post a Bank Statement. |
The Bank Statement Item node has the following information :
Item ID
Bank Item ID
Business Partner Internal ID
Business Partner Party Role Category Code
Item Document Description
Business Partner Bank Account
Business Process Variant Type Code
Payment Reference
Payment Transaction Type Code
Payment Transaction Type Description
Payment Transaction Supplement Type Code
Payment Transaction Supplement Category Code
Bank Charge Bearer Code
This can be used to describe the distribution of costs between the initiator and the recipient of a payment transaction.
Possible values are : BEN - Benificiary; OUR - Initiator; SHA - Sharing of costs.
Payment Transaction Category Code
Posted Amount
Bank Value Date
Bank Posting Date
Bank Exchange Rate
Original Currency Amount
House Bank Fee Amount
Partner Bank Fee Amount
Payment Explanation Item
Payment Explanation Note
Payment Explanation Item List Complete Transmission Indicator
Payment Explanation Note List Complete Transmission Indicator
The Payment Explanation Item node is related to the References section on the UI and has the following information:
ID
Business Transaction Document Date
Company ID
Business Partner Internal ID
Net Amount
Gross Amount
Transaction Currency Gross Amount
Cash Discount Amount
Transaction Currency Cash Discount
Withholding Tax Amount
Bank Fee Amount
Note
Payment Transaction Initiator Invoice Reference
Payment Transaction Destinated Invoice Reference
The Payment Explanation Note node is related to the Memo Line section on the UI and has the following information:
Ordinal Number Value
Note: Language-independent description that corresponds to the memo line.
The Attachment Folder node is the collection of all documents attached to a Bank Statement.
Attributes | Description |
---|---|
actionCode | Refer to the General Rules for Using this Web Service section for more details. |
Elements | Description |
---|---|
UUID | Universally unique identifier of the attachment folder node |
A document is an attachment that was assigned to the Attachment Folder and contains unstructured information and additional control and monitoring information.
Attributes | Description |
---|---|
actionCode | Refer to the General Rules for Using this Web Service section for more details. |
Elements | Description |
---|---|
VisibleIndicator | Specifies whether a document is visible or not. |
CategoryCode | Coded representation of the document category, such as Folder, File or Link. Possible values are : 1 - Folder; 2 - Document; 3 - Link. |
TypeCode | Coded representation of the document type. Most general attachments are of type '10001'. |
MIMECode | Coded representation of the MIMECode of a document. |
Name | Name of a document that identifies the document within its parent folder. |
AlternativeName | Language-independent name of a document. |
Description | Language-independent description of a document. |
ExternalLinkWebURI | Destination URI (if the link is external) |
Sub-Node: (only relevant when the document is a file) FileContent-BinaryContent | Describes the unstructured data in binary form. |
|
The following will create a Bank Statement of ID 2 and with no items and with status In Preparation.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="01"> <BankStatementExternalProviderID>2</BankStatementExternalProviderID> <CompanyID>MC10000</CompanyID> <HouseBankAccount> <ID>110000062588</ID> </HouseBankAccount> <DocumentDescription>TEST</DocumentDescription> <StatementDate>2020-09-17</StatementDate> <ValidityYear>2020</ValidityYear> <PostingDate>2020-09-17</PostingDate> <OpeningBalanceAmount currencyCode="USD">1289630.38</OpeningBalanceAmount> <ClosingBalanceAmount currencyCode="USD">1289630.38</ClosingBalanceAmount> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will create a Bank Statement of ID 3 and with an item and with status In Preparation. This Bank Statement has a total credit amount of 1 USD and a total debit amount of 0 USD. As the net change of these amounts is 1 USD, the closing balance is incremented by 1 USD compared to the opening balance.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="01"> <BankStatementExternalProviderID>3</BankStatementExternalProviderID> <CompanyID>MC10000</CompanyID> <HouseBankAccount> <ID>110000062588</ID> </HouseBankAccount> <DocumentDescription>TEST</DocumentDescription> <StatementDate>2020-09-17</StatementDate> <ValidityYear>2020</ValidityYear> <PostingDate>2020-09-17</PostingDate> <OpeningBalanceAmount currencyCode="USD">1289630.38</OpeningBalanceAmount> <ClosingBalanceAmount currencyCode="USD">1289631.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">1</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">0</DebitTotalAmount> <ItemsTotalNumberValue>1</ItemsTotalNumberValue> <Item ActionCode="01"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>48</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will create and post a Bank Statement of ID 4 and with an item and payment explanation item.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="01"> <BankStatementExternalProviderID>4</BankStatementExternalProviderID> <CompanyID>MC10000</CompanyID> <HouseBankAccount> <ID>110000062588</ID> </HouseBankAccount> <DocumentDescription>TEST</DocumentDescription> <StatementDate>2020-09-17</StatementDate> <ValidityYear>2020</ValidityYear> <PostingDate>2020-09-17</PostingDate> <OpeningBalanceAmount currencyCode="USD">1289630.38</OpeningBalanceAmount> <ClosingBalanceAmount currencyCode="USD">1289631.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">1</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">0</DebitTotalAmount> <ReleaseBankStatement>true</ReleaseBankStatement> <ItemsTotalNumberValue>1</ItemsTotalNumberValue> <Item ActionCode="01"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>48</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> <PaymentExplanationItem ActionCode="01"> <ID>1</ID> <BusinessTransactionDocumentDate>2020-09-01</BusinessTransactionDocumentDate> <CompanyID>MC10000</CompanyID> <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID> <NetAmount currencyCode="USD">3</NetAmount> <CashDiscountAmount currencyCode="USD">2</CashDiscountAmount> <PaymentTransactionDestinatedInvoiceReference> <!--Document ID--> <ID>MCCI-214</ID> </PaymentTransactionDestinatedInvoiceReference> <!--<PaymentTransactionInitiatorInvoiceReference>//External Reference <ID>MCCI-214</ID> </PaymentTransactionInitiatorInvoiceReference>--> </PaymentExplanationItem> <PaymentExplanationItemListCompleteTransmissionIndicator>true</PaymentExplanationItemListCompleteTransmissionIndicator> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
|
|
The following will update a Bank Statement and with different actions on item. This request updates the existing Bank Statement item with Item ID as 1 and creates a new Bank Statement item with an amount of 3 USD.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> <DocumentDescription>TEST-UPDATE</DocumentDescription> <ClosingBalanceAmount currencyCode="USD">1289632.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">3</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">1</DebitTotalAmount> <Item ActionCode="02"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>42</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>1</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">1</PostedAmount> </Item> <Item ActionCode="01"> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>48</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">3</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will update a Bank Statement by deleting an item. This request deletes the Bank Statement item with Item ID as 1.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> <DocumentDescription>TEST-DELETE_ITEM</DocumentDescription> <ClosingBalanceAmount currencyCode="USD">1289633.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">3</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">0</DebitTotalAmount> <Item ActionCode="03"> <ItemID>1</ItemID> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will update a Bank Statement by adding a new payment explanation item.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163eac-af2d-1eda-bfe6-b6a61ddef92d</UUID> <Item ActionCode="02"> <ItemID>1</ItemID> <PaymentExplanationItem ActionCode="01"> <BusinessTransactionDocumentDate>2020-09-01</BusinessTransactionDocumentDate> <CompanyID>MC10000</CompanyID> <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID> <NetAmount currencyCode="USD">3</NetAmount> <CashDiscountAmount currencyCode="USD">2</CashDiscountAmount> <PaymentTransactionDestinatedInvoiceReference> <!--Document ID--> <ID>MCCI-214</ID> </PaymentTransactionDestinatedInvoiceReference> <!--<PaymentTransactionInitiatorInvoiceReference>//External Reference <ID>MCCI-214</ID> </PaymentTransactionInitiatorInvoiceReference>--> </PaymentExplanationItem> <PaymentExplanationItemListCompleteTransmissionIndicator>false</PaymentExplanationItemListCompleteTransmissionIndicator> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will update a Bank Statement by updating the payment explanation item.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163eac-af2d-1eda-bfe6-b6a61ddef92d</UUID> <Item ActionCode="02"> <ItemID>1</ItemID> <PaymentExplanationItem ActionCode="02"> <ID>1</ID> <Note LanguageCode="EN">test-update</Note> </PaymentExplanationItem> <PaymentExplanationItemListCompleteTransmissionIndicator>false</PaymentExplanationItemListCompleteTransmissionIndicator> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will update a Bank Statement by deleting the payment explanation item.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163eac-af2d-1eda-bfe6-b6a61ddef92d</UUID> <Item ActionCode="02"> <ItemID>1</ItemID> <PaymentExplanationItem ActionCode="03"> <ID>1</ID> </PaymentExplanationItem> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
The following will delete a Bank Statement.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="03"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
If the list completion indicator is set to true for a node, the existing instances of the node will be replaced by the specified new instances.
The following will replace the existing items of a Bank Statement with two new items.
<n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatement ActionCode="02"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> <DocumentDescription>TEST-UPDATE</DocumentDescription> <ClosingBalanceAmount currencyCode="USD">1289632.38</ClosingBalanceAmount> <CreditTotalAmount currencyCode="USD">3</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">1</DebitTotalAmount> <Item ActionCode="01"> <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>42</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>1</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <Item ActionCode="01"> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessProcessVariantTypeCode>48</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <ItemDocumentDescription>TEST_ITEM</ItemDocumentDescription> <PostedAmount currencyCode="USD">3</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync>
Release | Change Description | Details |
2102 | Documentation change | Approval Status Code is now deprecated and use ReleaseBankStatement instead to post a Bank Statement. |
2102 | Documentation change | Added more information about mandatory elements like Bank Account, Currency, and BankStatementExternalProviderID. |
2102 | Documentation change | Posting of Bank Statements created through web service is now independent of the business configuration settings maintained for posting automatically generated Bank Statements. Also, posting more than one Bank Statement for one bank account is not supported. If such Bank Statements are found in a request, the system will create the Bank Statements with "In Preparation" status |