Salary Pay Instruction



The salary pay instruction is used to configure an employee's annual salary. See Setting the Employee Salary for more information.

SalaryPayInstruction [Schema]

Name Type Required Description
AnnualSalary Money yes The employee's gross annual salary.
ProRataMethod ProRataMethod no The pro-rata method option to be used; the default is not set. See Pro-rata Calculation Methods for more information.
RoundingOption RoundingOption no The rounding option to use when calculating the salary period value; the default behaviour will be PennyUp.
Code SystemCode no [Optional] The payment code override. If omitted; the BASIC payment code is used.

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"?>
<SalaryPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2019-03-21</StartDate>
  <EndDate>2019-03-21</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AnnualSalary>123.99</AnnualSalary>
  <ProRataMethod>NotSet</ProRataMethod>
  <RoundingOption>NotSet</RoundingOption>
  <Code>string</Code>
</SalaryPayInstruction>
{
  "SalaryPayInstruction": {
    "StartDate": "2019-03-21",
    "EndDate": "2019-03-21",
    "Description": "string",
    "PayLineTag": "string",
    "AnnualSalary": "123.99",
    "ProRataMethod": "NotSet",
    "RoundingOption": "NotSet",
    "Code": "string"
  }
}