PayCode

Each PayLine has a Code. The Code will match the Code property of a PayCode.
The PayCode that is used determines how the amount is treated with regards to tax, NI and pensions

Name / Description Type / Format Example
title string "string"
code string "string"
defaultValue
If a non-zero value is provided then when this code is selected in our UI the value will be automatically filled.
number double 0.0
isDeduction
If set to true then a PayLine using this code will be treated as a deduction as opposed to an addition.
boolean true
isNiable
Determines whether or not the value of PayLines using this code should be taken into consideration when calculating National Insurance Contributions.
boolean true
isTaxable
Determines whether or not the value of PayLines using this code should be taken into consideration when calculating the PAYE liability.
boolean true
isPensionable
Determines whether or not the value of PayLines using this code should be taken into consideration when calculating the total pensionable pay.
boolean true
isAttachable
Determines whether or not the value of PayLines using this code should be taken into consideration when calculating the attachable pay for AttachmentOrders.
boolean true
calculationType
Determines whether the Value of the PayLine is a fixed amount or a percentage,
string "FixedAmount" "PercentageOfGross" "PercentageOfNet"
multiplierType
Determines whether the Value of the PayLine comes from it's Value field (when this is set to None) or is from Rate multiplied by Multiplier.
The only difference between Days and Hours is the resulting description on the payslip.
Only applicable if CalculationType is FixedAmount.
string "None" "Hours" "Days"
isSystemCode
System Codes cannot be deleted or edited
boolean true
isControlCode
Control Codes cannot be deleted or edited nor can PayLines be assigned to them.
boolean true
{
  "title": "string",
  "code": "string",
  "defaultValue": 0.0,
  "isDeduction": true,
  "isNiable": true,
  "isTaxable": true,
  "isPensionable": true,
  "isAttachable": true,
  "calculationType": "FixedAmount",
  "multiplierType": "None",
  "isSystemCode": true,
  "isControlCode": true
}
Completing a Payrun Review the PayRun