Pay Codes

PayCode [Schema]

Name	Type	Required	Description
Code	SystemCode	yes	The pay code identifier referenced on calcualtion pay lines. See revisible objects for more information on revisions and how they work.
EffectiveDate	xsd:date	yes	The date when the pay code revision became effective.
Revision	Revision	no	The revision number of the pay code; this is a readonly system generated value
Description	xsd:string ( max: 200)	no	The description of the pay code. Example: Standard basic pay.
Niable	xsd:boolean	yes	Indicates if the value of the pay line should be applied before national insuration contribution calculation.
Taxable	xsd:boolean	yes	Indicates if the value of the pay line should be applied before PAYE tax calculation.
Benefit	xsd:boolean	no	Indicates if the value of the pay line is considerd a benefit in kind.
Notional	xsd:boolean	no	Indicates if the value of the pay line has a notional value for tax or national insurance.
NonArrestable	xsd:boolean	no	Indicates if the value of the pay line should not be considered for recovery of a debt via an AOE.
Readonly	xsd:boolean	no	Determines if the pay code can be edited. Readonly pay codes cannot be altered.
Territory	CalculatorTerritory	yes	Determines the calculator territory to be used when processing pay lines that reference this pay code.
Region	CalculatorRegion	yes	Determines the calculator region to be used when processing pay lines that reference this pay code.
Type	SystemCodeType	yes	The type of payment code; either Payment or Dedution.
NominalCode	Link	yes	A link to the associated nominal ledger code. Nominal codes are used to group pay codes into journal accounts. See Nominal Code for more details.

Example

<?xml version="1.0"?>
<PayCode xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EffectiveDate>2020-01-24</EffectiveDate>
  <Revision>123</Revision>
  <Code>string</Code>
  <Description>string</Description>
  <Niable>true</Niable>
  <Taxable>true</Taxable>
  <Territory>NotSet</Territory>
  <Region>NotSet</Region>
  <Type>NotSet</Type>
  <Benefit>true</Benefit>
  <Notional>true</Notional>
  <NonArrestable>true</NonArrestable>
  <Readonly>true</Readonly>
  <NominalCode title="string" href="string" rel="string" />
</PayCode>

{
  "PayCode": {
    "EffectiveDate": "2020-01-24",
    "Revision": "123",
    "Code": "string",
    "Description": "string",
    "Niable": "true",
    "Taxable": "true",
    "Territory": "NotSet",
    "Region": "NotSet",
    "Type": "NotSet",
    "Benefit": "true",
    "Notional": "true",
    "NonArrestable": "true",
    "Readonly": "true",
    "NominalCode": {
      "@title": "string",
      "@href": "string",
      "@rel": "string"
    }
  }
}