| 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 customer through bank statements.
The web service interface Manage Bank Statement offers the operations MaintainBundle and CheckMaintainBundle.
MaintainBundle will execute a save at the end of its process if no errors occur, where as CheckMaintainBundle will not persist the changes made.
The operation MaintainBundle allows you to adjust the following:
Document description
Statement date
validity year
opening balance
closing balance
Debit total amount
Credit total amount
count of payment items and it's details
It also allows to add attachments.
The user should have access to the Workcenter view under Liquidity Management -> Bank Statements to access/view the created bank statement 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
You can find general information about Web services, their structure and consumption in the Web Services documentation.
| Description | Check bank statements |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check if bank statement can be created without errors.
This operation is the same as MaintainBundle without the save at the end of the process. Please refer to this documentation for a thorough explaination.
| 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 element that contains the bank statement data to be created. The detailed structure of the bank statement 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 informtion.
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
Life cycle status code
Approval status code.
Items total number value
Item list complete transmission indicator
Bank statement item node has the following information :
Item ID
Bank Item ID
Business Partner InternalID
Business Partner Party Role Category Code
Business Partner Name
Business Partner Bank Account
Business Process Variant Type Code
Payment Transaction Type Code
Payment Transaction Type Description
Payment Transaction Supplement TypeCode
Payment Transaction Supplement Category Code
Bank Charge Bearer Code
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 ItemList Complete Transmission Indicator
Payment Explanation NoteList Complete Transmission Indicator
Payment explanation item node 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
Payment explanation note node has the following information :
Ordinal number value
Note
The AttachmentFolder node element can be used to add and remove DDM attachments.
Data for this node can be found on the DDM UI as attachments. On the user interface, files and links can be created. In the web service request, links and files are differentiated through the CategoryCode:
| Category code | Description |
|---|---|
| 2 | Document |
| 3 | Link |
The different types of attachments are differentiated by the TypeCode:
| Type code | Description |
|---|---|
| 10001 | Standard attachment |
| 10016 | Business partner image |
| 10017 | Business card |
To create link attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 3 |
| TypeCode | <none> |
| AlternativeName | <Document Title> |
| ExternalLinkWebURI | <link URI> |
| Description | <Comment> |
To create file attachments, document elements must be as follows:
| Element | Value |
|---|---|
| VisibleIndicator | true |
| CategoryCode | 2 |
| TypeCode | <none> |
| Name | <Document Title> |
| AlternativeName | <Document Title> |
| Description | <Comment> |
This will create a bank statement with no items and with status set to in preparation
| <n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="01"> <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> |
This will create a bank statement with an item and with status set to in preparation
| <n0:BankStatementBundleMaintenanceCheckRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="01"> <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> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintenanceCheckRequest_sync> |
This will create and post a bank statement with an item.
| <n0:BankStatementBundleMaintenanceCheckRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="01"> <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> <ApprovalStatusCode>3</ApprovalStatusCode> <ItemsTotalNumberValue>1</ItemsTotalNumberValue> <Item ActionCode="01"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <PostedAmount currencyCode="USD">1</PostedAmount> <BankValueDate>2020-09-17</BankValueDate> <BankPostingDate>2020-09-17</BankPostingDate> </Item> <ItemListCompleteTransmissionIndicator>true</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintenanceCheckRequest_sync> |
Update is possible only for a bank statement which is in status "In preparation"
The following example is to update a bank statement and with different actions on item.
| <n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="02"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> <DocumentDescription>TEST-UPDATE</DocumentDescription> <ClosingBalanceAmount currencyCode="USD">1289632.38</ClosingBalanceAmount> <!-- Mention the updated closing balance if any action on item impacts this--> <CreditTotalAmount currencyCode="USD">3</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">1</DebitTotalAmount> <Item ActionCode="02"> <ItemID>1</ItemID> <BusinessPartnerInternalID>MC9785</BusinessPartnerInternalID> <PaymentTransactionCategoryCode>1</PaymentTransactionCategoryCode> <PostedAmount currencyCode="USD">-1</PostedAmount> </Item> <Item ActionCode="01"> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <PaymentTransactionCategoryCode>15</PaymentTransactionCategoryCode> <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 example is to update a bank statement by deleting an item.
| <n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="02"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> <DocumentDescription>TEST-DELETE_ITEM</DocumentDescription> <ClosingBalanceAmount currencyCode="USD">1289633.38</ClosingBalanceAmount> <!-- Mention the updated closing balance if any change is made with respect to items--> <CreditTotalAmount currencyCode="USD">3</CreditTotalAmount> <DebitTotalAmount currencyCode="USD">0</DebitTotalAmount> <Item ActionCode="03"> <ItemID>1</ItemID> </Item> <ItemListCompleteTransmissionIndicator>false</ItemListCompleteTransmissionIndicator> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync> |
Note :
Specify the UUID of the bank statement for updating it
Credit and debit total amounts need to be specified whenever the closing balance is updated.
The following example is to delete a bank statement.
| <n0:BankStatementBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <BankStatement ActionCode="03"> <UUID>00163EAC-AEF4-1EDA-BE9A-BE9246A6097B</UUID> </BankStatement> </n0:BankStatementBundleMaintainRequest_sync> |
Show full documentation
Show full documentation