Guides

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

Schema

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`
`isRealTimeClass1aNiable` Determines whether or not the value of PayLines using this code are subject to real time Class 1A NIC.	`boolean`	`true`
`isNotContributingToHolidayPay` If true then any payments made using this code will not contribute towards holiday pay calculations.	`boolean`	`true`
`isQualifyingEarningsForAe` If true then any payments made using this code will be used as the basis for calculating QualifyingEarnings for AutoEnrolment assessments. If it is set to null then when it's next retrieved it'll have the same value as PensionablePay	`boolean`	`true`
`isNotTierable` If true then any payments made using this code will not be included when calculating the tier an employee should be on for a Tiered Pension.	`boolean`	`true`
`isTcp_Tcls` If true then any payments made using this code will be reported as a Trivial Commutation Payment (A - TCLS)	`boolean`	`true`
`isTcp_Pp` If true then any payments made using this code will be reported as a Trivial Commutation Payment (B - Personal Pension)	`boolean`	`true`
`isTcp_Op` If true then any payments made using this code will be reported as a Trivial Commutation Payment (C - Occupational Pension)	`boolean`	`true`
`flexibleDrawdown`	`string`	`"None"` `"DeathBenefit"` `"Pension"` `"SeriousIllHealth"`
`isAutoAdjust` Can be used to inform a User to what default value to set for PayLine.autoAdjustForLeave for new lines created.	`boolean`	`true`
`calculationType`	`string`	`"FixedAmount"` `"PercentageOfGross"` `"PercentageOfNet"` `"MultipleOfHourlyRate"` `"MultipleOfDailyRate"` `"FixedAnnualAmount"`
`multiplierType`	`string`	`"None"` `"Hours"` `"Days"`
`dailyRateMultiplier` If the MultiplierType is MultipleOfDailyRate then this sets the multiple to be used, ie 1.5	`number` double	`0.0`
`hourlyRateMultiplier` If the MultiplierType is MultipleOfHourlyRate then this sets the multiple to be used, ie 1.5	`number` double	`0.0`
`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`
`isNotional` Determines whether the transaction involves non-monetary benefits for payroll processing, potentially subject to tax and National Insurance.	`boolean`	`true`
`payee` The Id of the Payee, if any, that deductions are to be paid to.	`string` uuid	`"string"`

JSON Example

{
  "title": "string",
  "code": "string",
  "defaultValue": 0.0,
  "isDeduction": true,
  "isNiable": true,
  "isTaxable": true,
  "isPensionable": true,
  "isAttachable": true,
  "isRealTimeClass1aNiable": true,
  "isNotContributingToHolidayPay": true,
  "isQualifyingEarningsForAe": true,
  "isNotTierable": true,
  "isTcp_Tcls": true,
  "isTcp_Pp": true,
  "isTcp_Op": true,
  "flexibleDrawdown": "None",
  "isAutoAdjust": true,
  "calculationType": "FixedAmount",
  "multiplierType": "None",
  "dailyRateMultiplier": 0.0,
  "hourlyRateMultiplier": 0.0,
  "isSystemCode": true,
  "isControlCode": true,
  "isNotional": true,
  "payee": "string"
}

References

Contained in Models
AdvancedVarianceReport
AnalysisReport
FullSummaryOfPayReportLine
PayRunSummaryLine
PayrollAnalysisCostBreakdownReport
PayrollAnalysisEmployeeRoleBreakdownReport

Consumed by Operations
Create PayCode
Update PayCode (deprecated)
Update PayCode

Returned by Operations
Create PayCode
Get PayCode (deprecated)
Update PayCode (deprecated)
Get PayCode
Update PayCode

Completing a Pay Run	Review the PayRun

PayCode

Related Guides