Get PayRunEntryNavigation for a specific PayRunEntry

Get

/employers/{employerId}/payrun/navigation/{payRunEntryId}

Gets PayRunEntryNavigation details for a specific payrunentry within a pay run context,
providing previous/next payrunentry navigation based on the pay run's employee list filtered by the specified criteria.

Store values

Parameters

employerId string

The ID of the employer.

payRunEntryId string

The unique identifier of the payrunentry for which to build navigation context.

searchTerm string

An optional search term to filter employees. (optional)

zeroPaid string

The option to filter pay run entries by negative paid, zero paid, and non-zero paid. (optional)

departmentCode string

The option to filter on department code. (optional)

startersLeavers string

The option to filter on whether the employee is a starter or leaver. (optional)

sortBy string

The option to sort by a certain field. Default is Payroll Code. (optional)

sortDescending

boolean

Whether to sort in ascending or descending order. (optional)

rolledBackOnly

boolean

If set to true, returns rolled back pay run entries. If false, returns all entries. (optional)

Try it

OAuth Token

Api Key

Response Code

Response Body

Response Headers

The API Key you provided may not be valid.
Please check it or use the OAuth Token.

Possible Responses

200	Success	`PayRunEntryNavigation`	application/json