Customise Payslips

Our PDF payslips are produced by a converting a HTML document to a PDF file.

The PayslipCustomisation model give you the ability to customise the payslips.
As well as changing paper size, margins and orientation you can also add your own CSS to change the appearance of the PDF.

Customise from within the application

The customisation is best done via the web application:

  • Log in to your account or click the 'Dashboard' link
  • Click the employer name at the top-right of the page
  • Choose Edit Details from the drop-down menu
  • From the 'more' menu choose 'Payslip Customisation'

Customise via the API

If you want to use the API for your customisation then there are a few API operations that will help.

As you'd expect, there are the GET and POST actions to retrieve and save your PayslipCustomisation

To test your settings without saving them you can post the PayslipCustomisation to the Example Payslip endpoint and retrieve either PDF bytes using the recommended application/octet-stream accept header or an HTML document. The PDF-link application/pdf option is deprecated; its end-of-life date is 1st February 2027. See the accept header guide.
The documents are populated with dummy data but use whatever settings you submit to determine the design.