PayslipCustomisation

Used to represent any customisations you make to the look of Payslip PDFs.
This is covered in detail in the Guides section.

Schema

Name / Description Type / Format Example
custom
Whether or not you are customising the Payslip.
This should always be true if you are providing any other values.
 boolean true
includeLogo
Whether or not to include the employer logo on the payslip.
 boolean true
customCssOption string "UseDefault" "AppendToDefault" "ReplaceDefault"
customCss string "string"
removeYtd
Whether or not to remove the YTD column
 boolean true
includeEmployerAddress
Whether or not to include the employer address
 boolean true
useUmbrellaFormat
If true then the format the payslip will include details of the Umbrella Payment as well as employer costs
 boolean true
filename string "string"
includeDepartment
Whether or not to include the primary department of the employee on the payslip
 boolean true
includeHealthAndSocialCareMessage
Whether or not to include health and social car message
 boolean true
includeBenefits
Whether or not to include any payrolled benefits
 boolean true
paperSize string "Letter" "LetterSmall" "A4" "A4Small" "A5"
orientation string "Landscape" "Portrait"
margins PdfPaperMargins {PdfPaperMargins}
id
The unique id of the object
 string uuid "string"

JSON Example 

{
  "custom": true,
  "includeLogo": true,
  "customCssOption": "UseDefault",
  "customCss": "string",
  "removeYtd": true,
  "includeEmployerAddress": true,
  "useUmbrellaFormat": true,
  "filename": "string",
  "includeDepartment": true,
  "includeHealthAndSocialCareMessage": true,
  "includeBenefits": true,
  "paperSize": "Letter",
  "orientation": "Landscape",
  "margins": {
    "top": 0.0,
    "right": 0.0,
    "bottom": 0.0,
    "left": 0.0
  },
  "id": "string"
}

References

Contained in Models

- none -

Consumed by Operations
Update Payslip Customisations
Example Payslip
Returned by Operations
Get Payslip Customisations
Update Payslip Customisations
Payslips Customise Payslips