Search for actual payments

This endpoint allows you to search for actual payments based on various filters.

Pagination
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API

Required permissions
For all the actual payments table entries: People's Data > Payroll > View selected employees' Payroll section histories.
For the employees: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under errors in the response.

Testing notes:
1. Use the testing widget's Try It! option to test this endpoint.
2. Request Example: Use the Examples > Request example option to see how to initiate body parameters.
3. To test more than a single filter, copy the example to an external API testing app like Postman for better filtering options.
4. Response Example: View the response payload using the Response > Response example option in the response on the right.

Body Params

The request body must include a filter by employee ID.

filters
array
required

An array of filter criteria, each containing a field ID, operator, and values. Supported fields for filtering are:

  • `employeeId` (required): Filter by the the employee ID. All queries must specify the employee Ids to fetch. Each call can retrieve up to 200 employees.
  • `payDate` (optional): Filter by the date of the pay period.

Important: The array must include a filter for employeeId, as it is required for all requests.
The structure of the filters may vary slightly depending on the field being used.

filters*
pagination
object

Optional pagination parameters.

boolean
Defaults to false

By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Responses

400

Bad request.

401

Missing authentication credentials.

403

Forbidden. The service user does not have the required permissions.

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json