Payslip

Get

/employers/{employerId}/reports/{taxYear}/{payPeriod}/{periodNumber}/{id}/payslip

Returns a single Payslip for the given PayRunEntry of a PayRun. The type of response depends on the accept header.

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.

See the guides related to this operation

Store values

Parameters

employerId string

payPeriod string

periodNumber integer

taxYear string

id string

The Id of the PayRunEntry.

ordinal integer

(optional)

differenceOnly

boolean

If the PayRunEntry is part of a supplementary PayRun and this is set to true, the PayRunEntry will contain the differences between the current pay run version of the PayRunEntry and its previous version (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	`PayslipReportResponse`	application/pdf

Payslips	Get Payslips

Payslip

Parameters

Possible Responses

Related Guides