Skip to main content
GET
Download the payslip as a PDF

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Path Parameters

employeeId
string
required

ID of the employee

year
integer
required

Tax year of the payslip

period
integer
required

Pay period number within the year

Query Parameters

frequency
enum<string>

Optional payment frequency override. When provided, overrides the frequency from the employee's payroll config.

Available options:
Annual,
Monthly,
FourWeekly,
Fortnightly,
Weekly,
Daily,
Quarterly,
BiAnnually

Response

The payslip PDF

The response is of type file.