Description | Query Employee Bank Details |
Name | QueryEmployeeBankDetailsIn |
Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
Process Component Description | Business Partner Data Management |
Process Component Name | BusinessPartnerDataManagement |
Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
Deployment Unit Description | Foundation |
Endpoint Activation | By Scoping of Process Component | Operations |
Release Status | Released |
An interface to query the bank details of the employees.
The web service interface Query Employee Bank Details In enables you to connect external applications to your SAP Business ByDesign system and to query bank details of the employees in your system.
This web service interface is relevant if external parties or systems want to access bank data from external applications.
The web service interface Query Employee Bank Details In offers the operation Find By Elements.
The employee's bank details should be maintained in the system.
On querying with the employee who does not exist in the system, the service does not return anything.
On querying with the employee with no bank data, the service returns the employee ID without the bank data.
Existence of referenced business documents:
The following business documents are only queried and will not be created by the service operations:
Employee
They must already exist in the system when the web service is called.
Example
The following request would query for the bank details with the LowerBoundaryEmployeeID as 1001464.
Request
<n0:BankDetailsByEmployeeIdQuery_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankDetailsByEmployee> <SelectionByEmployeeId> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryEmployeeID>1001464</LowerBoundaryEmployeeID> <UpperBoundaryEmployeeID/> </SelectionByEmployeeId> </BankDetailsByEmployee> </n0:BankDetailsByEmployeeIdQuery_Sync>
The response would contain the result of the above operation.
In case of successful execution, the response would contain the Bank Details of the employee .
The following is the response for successful execution of the above request.
Response
<n0:BankDetailsByEmployeeIdResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS1BD41E20D177FA90F5E8:804"> <BankDetailsOfEmployee> <InternalID>8000003505</InternalID> <BankDetailsOfEmployee> <ID>0001</ID> <BankAccountID>101010101010</BankAccountID> <BankAccountTypeCode>03</BankAccountTypeCode> <BankAccountHolderName>ALICE SSTIME RECORDINGS</BankAccountHolderName> <KeyID>0001</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>CMCIFRPPXXX</BankStandardID> <CountryCode>FR</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:05:49.260836Z</CreationDateTime> <LastChangeDateTime>2009-03-19T11:05:49.260836Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>CIC</OrganisationFormattedName> <StreetName>Rue de la Boetie</StreetName> <CityName>Paris</CityName> <NationalBankIdentification> <NationalBankCodeID>1121017822</NationalBankCodeID> <BankRoutingIDTypeCode>FR</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0002</ID> <BankAccountID>1111111111111</BankAccountID> <BankAccountTypeCode>SG</BankAccountTypeCode> <BankAccountHolderName>ALICE SSTIME RECORDINGS</BankAccountHolderName> <KeyID>0002</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <CountryCode>FR</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:05:52.703179Z</CreationDateTime> <LastChangeDateTime>2009-03-19T11:05:52.703179Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>CA</OrganisationFormattedName> <RegionCode>75</RegionCode> <StreetName>Rue Voltaire</StreetName> <CityName>Paris</CityName> <NationalBankIdentification> <NationalBankCodeID>1234512345</NationalBankCodeID> <BankRoutingIDTypeCode>FR</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> </BankDetailsOfEmployee> <ProcessingConditions> <ReturnedQueryHitsNumberValue>1</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E04F8F71EE3939CE926DCCAD6EF00163E04F8F71EE3939CE972CBA356EF</LastReturnedObjectID> </ProcessingConditions> </n0:BankDetailsByEmployeeIdResponse_sync>
In case of failed execution, the response would contain error message(s).
You can find general information about Web services, their structure and consumption in the Web Services documentation.
The following example scenarios can be carried out using the Employee Bank Details query service.
The following example request returns results for a maximum of 4 employees with first names beginning with Alice.
<n0:BankDetailsByEmployeeIdQuery_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankDetailsByEmployee> <SelectionByEmployeeFirstName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryFirstName>Alice*</LowerBoundaryFirstName> <UpperBoundaryFirstName/> </SelectionByEmployeeFirstName> </BankDetailsByEmployee> <ProcessingConditions> <QueryHitsMaximumNumberValue>4</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:BankDetailsByEmployeeIdQuery_Sync>
The response would contain the result of the above operation.
The following is the response for successful execution of the above request.
Response
<n0:BankDetailsByEmployeeIdResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS1BD41E20D177FA90F5E8:804"> <BankDetailsOfEmployee> <EmployeeID>3571</EmployeeID> <InternalID>8000001305</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1001449</EmployeeID> <InternalID>8000003326</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1001490</EmployeeID> <InternalID>8000003585</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1001491</EmployeeID> <InternalID>8000003586</InternalID> </BankDetailsOfEmployee> <ProcessingConditions> <ReturnedQueryHitsNumberValue>4</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>true</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E04DC331ED395B2FA2A46AF8C9C00163E04DC331ED395B2FC89DBF00C9D</LastReturnedObjectID> </ProcessingConditions> </n0:BankDetailsByEmployeeIdResponse_sync>
The following example request returns a maximum of 10 employees with last names starting with Wonder and their bank details if they are maintained.
Request
<n0:BankDetailsByEmployeeIdQuery_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BankDetailsByEmployee> <SelectionByEmployeeLastName> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryLastName>Wonder*</LowerBoundaryLastName> <UpperBoundaryLastName/> </SelectionByEmployeeLastName> </BankDetailsByEmployee> <ProcessingConditions> <QueryHitsMaximumNumberValue>10</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>false</QueryHitsUnlimitedIndicator> <LastReturnedObjectID/> </ProcessingConditions> </n0:BankDetailsByEmployeeIdQuery_Sync>
The response would contain the result of the above operation.
The following is the response for successful execution of the above request.
Response
<n0:BankDetailsByEmployeeIdResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS1BD41E20D177FA90F5E8:804"> <BankDetailsOfEmployee> <EmployeeID>1001434</EmployeeID> <InternalID>8000003376</InternalID> <BankDetailsOfEmployee> <ID>0001</ID> <BankAccountID>1234567890</BankAccountID> <BankAccountTypeCode>SG</BankAccountTypeCode> <BankAccountHolderName>Alice Wonderland</BankAccountHolderName> <KeyID>0001</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>SBIINXXXXXX</BankStandardID> <CountryCode>IN</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:06:04.795538Z</CreationDateTime> <LastChangeDateTime>2009-03-19T11:06:04.795538Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>State Bank of India</OrganisationFormattedName> <RegionCode>30</RegionCode> <StreetName>Connaught Place</StreetName> <CityName>New Delhi</CityName> <NationalBankIdentification> <NationalBankCodeID>1100</NationalBankCodeID> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0002</ID> <BankAccountID>0987654321</BankAccountID> <BankAccountTypeCode>03</BankAccountTypeCode> <BankAccountHolderName>Alice Wonderland</BankAccountHolderName> <KeyID>0002</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>CTZIUS33XXX</BankStandardID> <CountryCode>US</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-06-19T13:29:21.587563Z</CreationDateTime> <LastChangeDateTime>2009-06-19T13:29:21.587563Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>Citizens Trust Company</OrganisationFormattedName> <RegionCode>RI</RegionCode> <StreetName>Citizens Plaza</StreetName> <CityName>Providence</CityName> <NationalBankIdentification> <NationalBankCodeID>011500120</NationalBankCodeID> <BankRoutingIDTypeCode>FW</BankRoutingIDTypeCode> <CommonBankRoutingIDMainIndicator>true</CommonBankRoutingIDMainIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0003</ID> <BankAccountID>12344321234</BankAccountID> <BankAccountTypeCode>SG</BankAccountTypeCode> <KeyID>0003</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>ICBKCNBJXXX</BankStandardID> <CountryCode>CN</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:06:11.783582Z</CreationDateTime> <LastChangeDateTime>2011-10-10T07:40:14.587064Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>Industrial and Commercial Bank of China</OrganisationFormattedName> <StreetName>1553 East Zhongshan Road</StreetName> <CityName>Shanghai</CityName> <NationalBankIdentification> <NationalBankCodeID>955990500013</NationalBankCodeID> <BankRoutingIDTypeCode>CN</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0004</ID> <BankAccountID>0987654321</BankAccountID> <BankAccountTypeCode>03</BankAccountTypeCode> <BankAccountHolderName>Alice Wonderland</BankAccountHolderName> <KeyID>0004</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>CIBKCNBJXXX</BankStandardID> <CountryCode>CN</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:06:17.984602Z</CreationDateTime> <LastChangeDateTime>2011-09-28T08:36:23.182985Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>CITIC Industrial Bank</OrganisationFormattedName> <StreetName>1500 North Sichuan Road</StreetName> <CityName>Shanghai</CityName> <NationalBankIdentification> <NationalBankCodeID>711031019230</NationalBankCodeID> <BankRoutingIDTypeCode>CN</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0005</ID> <BankAccountID>2222222222</BankAccountID> <KeyID>0005</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>HYVEDEMMXXX</BankStandardID> <CountryCode>DE</CountryCode> <BankGroupCode>02</BankGroupCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-06-19T13:19:43.408484Z</CreationDateTime> <LastChangeDateTime>2010-02-09T15:15:00.999695Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>Bayer. Hypo- und Vereinsbank AG</OrganisationFormattedName> <RegionCode>09</RegionCode> <StreetName>Am Tucherpark</StreetName> <CityName>Muenchen</CityName> <NationalBankIdentification> <NationalBankCodeID>70020270</NationalBankCodeID> <BankRoutingIDTypeCode>BL</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <ID>0006</ID> <BankAccountID>3333333333</BankAccountID> <KeyID>0006</KeyID> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <BankDirectoryEntry> <BankStandardID>BNPAFRPPPBQ</BankStandardID> <CountryCode>FR</CountryCode> <Status> <LifeCycleStatusCode>2</LifeCycleStatusCode> <ConsistencyStatusCode>3</ConsistencyStatusCode> </Status> <ValidityPeriod> <StartDate>0001-01-01</StartDate> <EndDate>9999-12-31</EndDate> </ValidityPeriod> <SystemAdministrativeData> <CreationDateTime>2009-03-19T11:05:58.495414Z</CreationDateTime> <LastChangeDateTime>2009-03-19T11:05:58.495414Z</LastChangeDateTime> </SystemAdministrativeData> <OrganisationFormattedName>BNP</OrganisationFormattedName> <StreetName>Avenue Victor Hugo</StreetName> <CityName>Paris</CityName> <NationalBankIdentification> <NationalBankCodeID>2912889929</NationalBankCodeID> <BankRoutingIDTypeCode>FR</BankRoutingIDTypeCode> <DefaultIndicator>true</DefaultIndicator> </NationalBankIdentification> </BankDirectoryEntry> </BankDetailsOfEmployee> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1001435</EmployeeID> <InternalID>8000003377</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1001545</EmployeeID> <InternalID>8000003637</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>2222</EmployeeID> <InternalID>8000004482</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>1111</EmployeeID> <InternalID>8000004492</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>7777</EmployeeID> <InternalID>8000004512</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>4444</EmployeeID> <InternalID>8000004526</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>5555</EmployeeID> <InternalID>8000004530</InternalID> </BankDetailsOfEmployee> <BankDetailsOfEmployee> <EmployeeID>6666</EmployeeID> <InternalID>8000004531</InternalID> </BankDetailsOfEmployee> <ProcessingConditions> <ReturnedQueryHitsNumberValue>9</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> <LastReturnedObjectID>00163E04F8FB1EE39694F998C345891E00163E04F8FB1EE39694FA3431C3C91E</LastReturnedObjectID> </ProcessingConditions> </n0:BankDetailsByEmployeeIdResponse_sync>
Note: The messages in the log vary from system to system based on the configuration.
Querying data based on extended fields is not possible. However, the extended fields (if any) will be queried and these fields can be found in the response.
Description | Find bank details of employees using employee data |
Name | FindByElements |
Synchronous | yes |
Release Status | Released |
To find the bank details of the employees based on various selection parameters.
The request message of the operation FindByElements contains the BankDetailsByEmployee node that groups all possible selection parameters. This node is described in the following sub-chapters.
This node groups all selection parameters. The selection parameters are:
Selection Parameter | Remark |
---|---|
SelectionByEmployeeId | Selection by a Employee Id |
SelectionByEmployeeFirstName | Selection by Employee First Name |
SelectionByEmployeeLastName | Selection by Employee Last Name |
The response contains the list of all the banks, their addresses, the IBAN, swift codes, processing conditions, and so on.
In this node, all found bank details are contained, including their data according to the requested elements provided in the query request.