Pay Run Inclusions Report

Generates a pay run inclusions report.

Request

GET https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/payruninclusions

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
request.employeeId int32
request.status string

Possible values are:

  • All
  • Active
  • Expired
request.fromDate date-time
request.toDate date-time
request.locationId int32
request.employingEntityId int32

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 UkPayRunInclusionExportModel