Description | Query Bank Statement |
Name | QueryBankStatementIn |
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 query Bank Statements
The webservice interface Query Bank Statement In enables you to query and read Bank Statements in your system.
The web service interface Query Bank Statement In offers the operation Find By Elements.
Here is an example of a simple web service request, which seeks for a Bank Statement with ID 1 and Company ID GCIT-1000
<n0:BankStatementQueryByElementsQuery_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankStatementSelectionByElements> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>1</LowerBoundaryIdentifier> </SelectionByID> <SelectionByCompanyID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>GCIT-1000</LowerBoundaryIdentifier> </SelectionByCompanyID> </BankStatementSelectionByElements> <ProcessingConditions> <QueryHitsMaximumNumberValue>50</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> <RequestedElements BankStatementTransmissionRequestCode="1"/> </n0:BankStatementQueryByElementsQuery_Sync>
Here is an excerpt of the response of the request:
<n0:BankStatementQueryByElementsResponse_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:QCL:/1SAI/TASB3DEA76D0C276B9CFFF7:804"> <BankStatementResponseElements> <UUID>00163ead-42f7-1eeb-82c3-b955fbb9ba26</UUID> <ID>1</ID> <BankID>1</BankID> <CompanyUUID>00145ef5-88e6-02db-b8b3-ac44715e0cc1</CompanyUUID> <CompanyID>MC10000</CompanyID> <HouseBankUUID>00300571-c7cc-02db-bb91-7b5aed0fc44e</HouseBankUUID> <HouseBankInternalID>HBTEST1</HouseBankInternalID> <HouseBankAccountUUID>00300571-ce9b-1ded-8cc2-a9457b31581b</HouseBankAccountUUID> <HouseBankAccount> <ID>56222105381</ID> <IDCheckDigitValue></IDCheckDigitValue> <StandardID></StandardID> <TypeCode></TypeCode> <CurrencyCode>USD</CurrencyCode> <HolderName></HolderName> <Bank> <Name>National City Bank</Name> <StandardID></StandardID> <RoutingID>120900</RoutingID> <RoutingIDTypeCode>FW</RoutingIDTypeCode> <CountryCode>US</CountryCode> </Bank> </HouseBankAccount> <ValidityYear>2020</ValidityYear> <BankStatementDate>2020-10-08</BankStatementDate> <PostingDate>2020-10-08</PostingDate> <CurrencyCode>USD</CurrencyCode> <BankStatOriginCode>01</BankStatOriginCode> <OpeningBalanceAmount currencyCode="USD">0.0</OpeningBalanceAmount> <ClosingBalanceAmount currencyCode="USD">0.0</ClosingBalanceAmount> <DebitTotalAmount currencyCode="USD">10.0</DebitTotalAmount> <CreditTotalAmount currencyCode="USD">0.0</CreditTotalAmount> <ItemTotalNumberValue>1</ItemTotalNumberValue> <SystemAdministrativeData> <CreationDateTime>2020-10-09T11:19:03.702667Z</CreationDateTime> <CreationIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</CreationIdentityUUID> <LastChangeDateTime>2020-10-09T11:50:10.858166Z</LastChangeDateTime> <LastChangeIdentityUUID>00300571-ce9b-1ded-93d0-b805e068c466</LastChangeIdentityUUID> </SystemAdministrativeData> <Status> <LifeCycleStatusCode>1</LifeCycleStatusCode> <ConsistencyStatusCode>2</ConsistencyStatusCode> <ApprovalStatusCode>1</ApprovalStatusCode> </Status> <BankStatementItem> <UUID>00163ead-42f7-1eeb-82c4-248ee7c91bc8</UUID> <ID>1</ID> <BankItemID>1</BankItemID> <BusinessPartnerInternalID>MC2000</BusinessPartnerInternalID> <BusinessPartnerUUID>00300571-c924-02db-b8e1-37ea328e0e0a</BusinessPartnerUUID> <BusinessPartnerPartyRoleCategoryCode>9</BusinessPartnerPartyRoleCategoryCode> <BusinessProcessVariantTypeCode>42</BusinessProcessVariantTypeCode> <PaymentTransactionCategoryCode>1</PaymentTransactionCategoryCode> <PostedAmount currencyCode="USD">-10.0</PostedAmount> <BankValueDate>2020-10-08</BankValueDate> <BankExchangeRate> <UnitCurrency>USD</UnitCurrency> <QuotedCurrency></QuotedCurrency> <Rate>0.0</Rate> </BankExchangeRate> <HouseBankFeeAmount currencyCode="USD">0.0</HouseBankFeeAmount> <BusinessPartnerBankDetailsKey> <BusinessPartnerUUID>00300571-c924-02db-b8e1-37ea328e0e0a</BusinessPartnerUUID> </BusinessPartnerBankDetailsKey> <PaymentExplanationUUID>00163ead-42f7-1eeb-82c4-248ee7c99bc8</PaymentExplanationUUID> <BankStatementPaymentExplanationHeader> <UUID>00163ead-42f7-1eeb-82c4-248ee7c99bc8</UUID> <PaymentAmount currencyCode="USD">100.0</PaymentAmount> <TotalGrossAmount currencyCode="USD">0.0</TotalGrossAmount> <TotalCashDiscountAmount currencyCode="USD">0.0</TotalCashDiscountAmount> <BankStatementPaymentExplanationItem> <ID> 1</ID> <UUID>00163ead-42f7-1eeb-82c4-afcd0a807d53</UUID> <OriginalDocumentDate>2020-10-09</OriginalDocumentDate> <DocumentCurrencyCode>USD</DocumentCurrencyCode> <NetAmount currencyCode="USD">100.0</NetAmount> <GrossAmount currencyCode="USD">0.0</GrossAmount> <CashDiscountAmount currencyCode="USD">0.0</CashDiscountAmount> <WithholdingTaxAmount currencyCode="USD">0.0</WithholdingTaxAmount> <BankFeeAmount currencyCode="USD">0.0</BankFeeAmount> <TotalDeductionAmount currencyCode="USD">0.0</TotalDeductionAmount> <ExternalInvoiceReference> <ID>ABCD1234</ID> </ExternalInvoiceReference> </BankStatementPaymentExplanationItem> <BankStatementPaymentExplanationNote> <OrdinalNumberValue>1</OrdinalNumberValue> <Note>asfasfasd</Note> </BankStatementPaymentExplanationNote> <BankStatementPaymentExplanationNote> <OrdinalNumberValue>2</OrdinalNumberValue> <Note>sfdadfadfadsfadsfasdf</Note> </BankStatementPaymentExplanationNote> </BankStatementPaymentExplanationHeader> </BankStatementItem> </BankStatementResponseElements> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163EAD42F71EEB82C3B955FBB9BA26</LastReturnedObjectID> </ProcessingConditions> </n0:BankStatementQueryByElementsResponse_Sync>
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Description | Find bank statements |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To find customer Bank Statements by elements.
The request message of the operation Find By Elements contains the BankStatementSelectionByElements node that groups all possible selection parameters.
This node groups all selection parameters. The selection parameters are as follows:
Selection Parameter | Remark |
---|---|
SEL_BY_UUID | Selection By Bank Statement UUID |
SEL_BY_ID | Selection By Bank Statement ID |
SEL_BY_BANK_ID | Selection By Bank ID |
SEL_BY_COMPANY_UUID | Selection By Company UUID |
SEL_BY_COMPANY_ID | Selection By Company ID |
SEL_BY_HB_UUID | Selection By House Bank UUID |
SEL_BY_HB_INT_ID | Selection By House Bank Internal ID |
SEL_BY_HBA_UUID | Selection By House Bank Account UUID |
SEL_BY_HOUSE_BANK_ACCOUNT_KEY | Selection By House Bank Account Key |
SEL_BY_HBA_Details | Selection By House Bank Accoount Details |
SEL_BY_FORMAT_CODE | Selection By Format Code |
SEL_BY_SAD_CREATION_DATE_TIME | Selection By System Administrative Data Creation Date Time |
SEL_BY_SAD_LC_DATE_TIME | Selection By System Administrative Data Last Change Date Time |
SEL_BY_AUTO_GEN_IND | Selection By Automatically Generated Indicator |
SEL_BY_VALIDITY_YEAR | Selection By Validity Year |
SEL_BY_DATE | Selection By Date |
SEL_BY_POSTING_DATE | Selection By Posting Date |
SEL_BY_ITEM_TOTAL_NUM_VALUE | Selection By Item Total Number Value |
SEL_BY_LIFECYCLE_STATUS_CODE | Selection By Life Cycle Status Code |
SEL_BY_SEARCH_TEXT | Selection By SearchText |
The response contains the list of found Bank Statements, log items, and processing conditions.
In this node, all found Bank Statements are contained, including their details according to the RequestedElements provided in the query request. This includes the BankStatementTransmissionRequestCode, AttachmentFolderTransmissionRequestCode ,Bank StatementItemTransmission RequestCode