HomeAPI Reference
API Reference

Retrieves pay run headers with filtering, sorting, and pagination

get
https://api.recvue.com/api/v2.0/payrun

Fetches pay run header list with optional filters. Returns all matching records by default. Use 'page' and 'size' parameters for paginated results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
Defaults to 10

Number of records per page. Controls pagination size. Use with 'page' parameter.

int32
Defaults to 1

Page number to retrieve (starts from 1). Use with 'size' parameter for pagination.

string
Defaults to DESC

Sort order direction for results. Use ASC for ascending order or DESC for descending order.

sort
array of strings

Field name(s) to sort results by. Supports multiple fields for compound sorting. Use format: fieldName:ASC or fieldName:DESC. For multiple fields use comma-separated: sort=field1:ASC,field2:DESC

sort
fields
array of strings

Specific response fields to include. Reduces response size. Provide comma-separated field names from the response model.

fields
string

Search keyword to filter pay run records. Searches across: payRunNumber

string

Business unit name for filtering

string

Order number for filtering

string

Order type for filtering

string

Order category for filtering

string

Product name for filtering

string

Supplier name for filtering

date-time

Pay date from for date range filtering (format: dd-MMM-yyyy)

date-time

Pay date to for date range filtering (format: dd-MMM-yyyy)

string

Pay run number for filtering

string

Paying batch identifier for filtering

date-time

Creation date for filtering (format: dd-MMM-yyyy)

string

Status for filtering (comma-separated for multiple)

Headers
string
required
Responses

Updated 3 months ago

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

Updated 3 months ago