PayRun Payments

Get

/employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/payments/employee

Returns a list of all employee payments that need to be made as a result of a Payrun.
If you specifically want just bank payments (employees where PayMethod is Credit) then you
may find the Bank Payment Instructions API call more useful

Deprecation notice: Accept: application/pdf returns a PDF link and is deprecated. Use Accept: application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027. Legacy PDF-link responses include Deprecation (RFC 9745 date @<unix-seconds>), Sunset, Warning, and optional Link headers.

Store values

Parameters

employerId string

payPeriod string

periodNumber integer

taxYear string

bankHoliday string

Specifies the region whose bank holidays are to be considered in the operation. (optional)

ordinal integer

(optional)

includeNonEmployeePayments

boolean

If set to true then we'll also include payments that need to be made to HMRC and PensionProviders (optional)

version integer

Will indicate what version of the payrun will be shown. If left empty, will show full pay run. (optional)

Try it Accept:

Deprecated: application/pdf returns a PDF link. Use application/octet-stream to retrieve PDF bytes through the authenticated API. The end-of-life date for PDF-link responses is 1st February 2027.

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	`PayrunPaymentsReportReportResponse`	application/json