Rate Pay Instruction

The Rate Pay Instruction can be used to calculate gross pay based on a monetary rate and and a number of units. This information can then be displayed on the payslip along with an optional unit of measure (e.g. hours). Optionally, you can specify the payment code to be used. If Omitted; BASIC is used.

RatePayInstruction [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.
RoundingOption RoundingOption no The rounding option to use when calculating the salary period value; the default behaviour will be PennyUp.

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 description 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.


<?xml version="1.0"?>
<RatePayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  "RatePayInstruction": {
    "StartDate": "2022-05-25",
    "EndDate": "2022-05-25",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "Rate": "123.99",
    "RateUoM": "NotSet",
    "Units": "123.99",
    "RoundingOption": "NotSet"