Net to Gross Pay Instruction
NetToGrossPayInstruction [Schema]
Name | Type | Required | Description |
---|---|---|---|
Code | SystemCode | yes | The code that represents the pay type and tax treatment. |
CalculationMode | xsd:string (enumeration)
|
yes | Determines which aspect of the payment is compared against the desired value. |
FindLowestGross | xsd:boolean | no | [Optional] Choose to find the lowest possible gross value that satisfies the desired net value. If omitted; defaults to false. |
DesiredValue | Money | yes | The desired value to be reached during the calculation. |
Units | xsd:decimal | no | [Optional] The number of units worked that can be used to populate the RatePayInstruction. |
RateUoM | UomBasicPay | no | [Optional] The unit of measure type that can be used to populate the RatePayInstruction. |
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"?>
<NetToGrossPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<StartDate>2021-01-14</StartDate>
<EndDate>2021-01-14</EndDate>
<Description>string</Description>
<PayLineTag>string</PayLineTag>
<Code>string</Code>
<CalculationMode>NetPay</CalculationMode>
<FindLowestGross>true</FindLowestGross>
<DesiredValue>123.99</DesiredValue>
<Units>123.99</Units>
<RateUoM>NotSet</RateUoM>
</NetToGrossPayInstruction>
{
"NetToGrossPayInstruction": {
"StartDate": "2021-01-14",
"EndDate": "2021-01-14",
"Description": "string",
"PayLineTag": "string",
"Code": "string",
"CalculationMode": "NetPay",
"FindLowestGross": "true",
"DesiredValue": "123.99",
"Units": "123.99",
"RateUoM": "NotSet"
}
}