go back to DeductionService

GET /deductions/search

Searches the database for pending deductions matching the given request parameters.

Roles that can access this endpoint are Users.

Parameters

name description type default type
request read for query parameters to be used as search criteria; use any combination of fields from tables:
  • drs_pending_deduct - use drs_pending_deduct or no prefix
  • movement - use movement prefix
  • payee - use payee prefix
For example, /deductions?drs_pending_deduct.ready_to_pay_flag=Y&movement.loaded=L would return pending deduction records from loaded movements that are marked ready to pay.

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of drs_pending_deduct.transaction_date+DESC will be applied.

For example, /deductions/search?drs_pending_deduct.payee_id=*&orderBy=drs_pending_deduct.transaction_date+DESC would return pending deduction records for all payees sorted descending by transaction date. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /deductions/search?drs_pending_deduct.payee_id=*&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

context HttpServletRequest

Result

List < RowDrsPendingDeduct > of type: application/xml application/json

a list of pending deduction objects

Try It Out

Request

- Authentication Help