Rate YTD Pay Instruction



RateYtdPayInstruction [Schema]

Name Type Required Description
Code SystemCode no [Optional] The payment code override. If omitted; the BASIC payment code is used.
Rate xsd:decimal yes The monetary rate to be used.
RateUoM UomBasicPay no The unit of measure for the payment.
Units xsd:decimal yes The number of units to be used.
Value Money yes The monetary value of the payment.
IsAdjustment xsd:boolean yes Indicates if the instruction is an adjustment. Pay lines generated from adjustment YTD instructions appear on the employee pay slip.

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"?>
<RateYtdPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2021-04-15</StartDate>
  <EndDate>2021-04-15</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Code>string</Code>
  <Rate>123.99</Rate>
  <RateUoM>NotSet</RateUoM>
  <Units>123.99</Units>
  <Value>123.99</Value>
  <IsAdjustment>true</IsAdjustment>
</RateYtdPayInstruction>

{
  "RateYtdPayInstruction": {
    "StartDate": "2021-04-15",
    "EndDate": "2021-04-15",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "Rate": "123.99",
    "RateUoM": "NotSet",
    "Units": "123.99",
    "Value": "123.99",
    "IsAdjustment": "true"
  }
}