Primitive Pay Instruction



PrimitivePayInstruction [Schema]

Name Type Required Description
Code SystemCode yes The code that represents the pay type and tax treatment.
Value Money yes The monetary value of the payment or deduction.

Interits from: PayInstruction[Schema]

See Understanding Pay Instructions for more information on how pay instructions can be used.

Name Type Required Description
StartDate xsd:date yes The date the instruction will come into effect.
EndDate xsd:date no The date the instruction will end, open ended instructions will run forever.
Description xsd:string ( max: 200) no The pay line descripton override; this description will override the default description from the pay code. See Customising the Payslip for more information on customising the payslip output and using runtime variables.
PayLineTag xsd:string ( max: 100) no If specified, the PayLineTag value is used to decorate all child pay lines generated by the instruction.

Example

<?xml version="1.0"?>
<PrimitivePayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-09-16</StartDate>
  <EndDate>2019-09-16</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Code>string</Code>
  <Value>123.99</Value>
</PrimitivePayInstruction>
{
  "PrimitivePayInstruction": {
    "StartDate": "2019-09-16",
    "EndDate": "2019-09-16",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "Value": "123.99"
  }
}