getFinancialProfile
- Description
- This inquiry transaction returns all the recorded income sources, bank accounts, charge or credit cards and payroll deduction information for a given party based on a filter value.
- Web Services
- Operation name: getFinancialProfile
- Example
- Retrieve all financial information for John Smithers, including savings account details, Visa credit card information, payroll deduction information, and income source details.
- Usage information
- The filter controls the type of financial information that is returned in the response: active information only, inactive information only, or all information, both active and inactive.
- Preconditions
- Financial information such as bank account, credit/charge card, payroll deduction, and income source must exist for a Party.
- Mandatory input
- PartyId
- Filter
- Inquiry levels
- Not applicable
- Filter values
- A filter value must be supplied. Valid values are:
- ACTIVE - returns only active records.
- INACTIVE - returns only inactive records.
- ALL - returns all records matching the search criteria, both active and inactive.
If an invalid filter value, or no filter value, is supplied, then all records matching the search criteria are returned.
Filter values are case-sensitive, and must be provided in upper case.
- Transaction behavior
- Bank accounts, credit/charge cards or payroll deduction record with an end date less than or equal to the system date are considered to be Inactive.
- Request message
- <InquiryType> getFinancialProfile
<InquiryParam>
<tcrmParam name= "PartyID">
<tcrmParam name= "Filter">
- Response objects
- TCRMFinancialProfileBObj containing one or more of the following:
- Special note
- Not applicable