getAllPartyPayrollDeductions
- Description
- This inquiry transaction returns all the recorded payroll deduction information for a given Party, based on a filter value.
- Web Services
- Operation name: getAllPartyPayrollDeductions
- Example
- Retrieve all the active Payroll Deduction records for Jane Clark.
- Usage information
- The input to this transaction is the PartyId for the Party whose
Payroll Deduction information is being queried, as well as a filter.
The filter can control the type of payroll deduction information that is returned: only active payroll deduction information, only inactive payroll deduction information, or all payroll deduction information.
This transaction supports the Pagination feature.
- Preconditions
- Not applicable
- Mandatory input
- PartyId
- Inquiry levels
- Not applicable
- Filter values
- A filter value may 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, all records matching the search criteria are returned.
Filter values are case-sensitive, and must be provided in upper case.
- Transaction behavior
- Payroll Deduction records with an end date less than or equal to the current system date are considered inactive.
- Request message
- <InquiryType> getAllPartyPayrollDeductions
<InquiryParam>
<tcrmParam name= "PartyID">
<tcrmParam name= "Filter">
- Response objects
- List of TCRMPartyPayrollDeductionBObj
- Special note
- Not applicable