Pro-Rata Pay Instruction



The Pro-Rata pay instruction provides access to the pro-rata calculation process on an ad-hoc basis.

ProRataPayInstruction [Schema]

Name Type Required Description
AnnualisedAmount Money yes The annual value to consider when calculating the pro-rata result.
ProRataMethod ProRataMethod yes The pro-rata method option to be used See Pro-rata Calculation Methods for more information.
RoundingOption RoundingOption yes The rounding option to use when calculating the Pro-Rata value.
Code SystemCode no [Optional] The payment code override. If omitted; the BASIC payment code is used.
ProRataStart xsd:date yes The date of the pro-rata period starts.
ProRataEnd xsd:date yes The date of the pro-rata period ends.
PayAsLumpSum xsd:boolean no Determines if the period of pro-rata should be constrained to the pay period or paid in a single installment. Used to control payments when the pro-rata period crosses pay period boundaries.

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"?>
<ProRataPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2021-09-24</StartDate>
  <EndDate>2021-09-24</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <AnnualisedAmount>123.99</AnnualisedAmount>
  <ProRataMethod>NotSet</ProRataMethod>
  <RoundingOption>NotSet</RoundingOption>
  <Code>string</Code>
  <ProRataStart>2021-09-24</ProRataStart>
  <ProRataEnd>2021-09-24</ProRataEnd>
  <PayAsLumpSum>true</PayAsLumpSum>
</ProRataPayInstruction>
{
  "ProRataPayInstruction": {
    "StartDate": "2021-09-24",
    "EndDate": "2021-09-24",
    "Description": "string",
    "PayLineTag": "string",
    "AnnualisedAmount": "123.99",
    "ProRataMethod": "NotSet",
    "RoundingOption": "NotSet",
    "Code": "string",
    "ProRataStart": "2021-09-24",
    "ProRataEnd": "2021-09-24",
    "PayAsLumpSum": "true"
  }
}