getAllPartyBankAccounts
- Description
- This inquiry transaction returns all the recorded bank account information for a given party based on a filter value.
- Web Services
- Operation name: getAllPartyBankAccounts
- Example
- Retrieve all active and inactive account information for Jane Clark.
- Usage information
- The input to this transaction is the PartyId for the party whose
bank account information is being queried, as well as a filter.
The filter controls the amount of information that is returned: inactive bank account information only, active bank account information only, or all bank account information (active and inactive).
Bank account types are user-definable through a code table.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- Inquiry levels
- Not applicable
- Filter values
- A filter value can be supplied. Valid values are:
- ACTIVE - returns only active records.
- INACTIVE - returns only inactive records.
- ALL - returns all records matching the search criteria.
If an invalid filter value or no filter value is supplied, all records matching the search criteria are returned.
Filter values are case-sensitive and must be provided in upper case.
- Transaction behavior
- Bank account information with an end date less than or equal to the current system date is considered to be inactive.
- Request message
- <InquiryType> getAllPartyBankAccounts
<InquiryParam>
<tcrmParam name= "PartyId">
<tcrmParam name= "Filter">
- Response objects
- List of TCRMPartyBankAccountBObj
- Special note
- Not applicable