> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.2cloudnine.com/llms.txt
> Use this file to discover all available pages before exploring further.
# QRG Create a Payee Deduction Template
export const InlineImage = ({src, alt = "", height = "1.6em"}) => {
return 
;
};
## Purpose
The purpose of this quick reference guide is to step through the process of creating a Payee Deduction
Template. The intended audience for this document are system administrators / standard users.
## Steps
### Create a new Payee Deduction Template
The Payee Deduction Template holds General Information, Pay Code and Rates, Quantity Worked
Variations, Deduction Limits, Recipient Details and Deduction Statistics for a Payee Deduction Record.
Create a Purchased Leave Payee Deduction by following the below steps:
1. Click on the **App Launcher** icon (see Figure 1).
2. Go to the **Payee Deduction Templates** object by using the Search function (see Figure 2).
3. Click the **New** button (see Figure 3).
4. Populate the following required fields to provide the base details of the record (see Figure 4):
1. **Payee Deduction Template**
2. **Pay Code**
3. **Deduction Rate**
4. **Deduction Rate Type**
5. **Based on Quantity Worked**
5. Populate the following optional field as required:
1. To define a description for the Payee Deduction Template, populate the **Deduction**
**Description** field.
6. To define any required rules and limits that will be used in assessing and determining the Payee
Deduction Template, populate the following optional fields as required. If left blank the rule / limit
will not apply:
1. **Protected Amount Applied**
2. **Quantity**
3. **Total Deduction Limit**
4. **Pay Calendar Period Deduction Limit**
5. **Is CP Deduction Limit Adjustable**
6. **Is Rollover Underpaid Deductions**
7. **Quantity Worked Minimum**
8. **Quantity Worked Maximum**
9. **Is Quantity Worked Min Adjustable?**
10. **Is Quantity Worked Max Adjustable?**
7. Click on the **Save** button.
The Based on Quantity Worked field is critical for Payees with Assignments that have
Deductions which are reliant on scalable rates against actual hours processed within a
Pay Batch for a particular Pay Calendar Period.
A new **Payee Deduction Template** is now created (see Figure 5).
Payee Deduction Templates CAN NOT be deleted if they have related records or are
used in other records. Deleting records is not recommended unless absolutely essential.
8. To modify an existing **Payee Deduction Template**, open the required record and select the **Edit**
button available on the top right side of the page. You can also double click within fields that need
editing or just click on the pencil icon that appears within fields when hovering with your
cursor.
9. When complete, click on the **Save** button.
Any changes made to the Payee Deduction Templates will not update Deduction
records already referencing the Deduction Template.
## Field Descriptions
**Based on Quantity Worked** indicates whether the Deduction considers the quantity of units worked per
Payee Pay Batch in the calculation of the Deduction Pay Transaction.
**Deduction Rate** defines the rate that will be used when calculating the Deduction Amount during the
creation of the Deduction Pay Transactions.
**Deduction Rate Type** defines if the value outlined in the Deduction Rate field should be treated as a fixed
amount or as a percentage of the Payee's earnings:
* **Amount** is the fixed amount to be deducted from the Payees earnings for the pay period.
* **Deductions Units x Deduction Rate** enables Units x Rate deductions applied if required.
* **Percentage of Gross** is the amount to be deducted as a percentage of the Payees Gross earnings
for the pay period.
* **Percentage of OTE** is the amount to be deducted as a percentage of the Payees Ordinary Time
Earnings (OTE) for the pay period.
* **Percentage of SGC Refund** is the amount to be deducted as a percentage of the Payees
Superannuation Guarantee Contributions (SGC) refund for the pay period.
* **Rate per Quantity Worked** details a flat rate per Quantity Worked to be deducted for the pay
period.
* **Percentage of Taxable Gross** is the amount to be deducted as a percentage of the Payee’s
Taxable Gross Earnings for the pay period.
**Pay Calendar Period Deduction Limit** defines an upper limit to the Deduction amount that can be
withheld on a per Pay Calendar Period basis. When Deductions are calculated, the Deduction amount
withheld will be adjusted to ensure this amount is not exceeded. If blank, no limit applies.
**Pay Code** defines the Pay Code that will be used on the related Deduction Pay Transactions.
**Payee Deduction Template** is required to create a unique identifier for the record.
**Protected Amount Applied** defines the protected amount that will be used when calculating the
deduction amount during the Deduction Transaction creation.
**Is CP Deduction Limit Adjustable** defines if the Calendar Period Deduction Limit can be modified at a
Payee Deduction Record level when related to the Deduction Template. If True, the Deduction Limit can
be changed on a Payee Deduction
**Is Quantity Worked Min Adjustable** defines if the Quantity Worked Minimum can be modified at a Payee
Deduction Record level when related to the Deduction Template. If True, the rate value can be changed.
**Is Quantity Worked Max Adjustable** defines if the Quantity Worked Maximum can be modified at a Payee
Deduction Record level when related to the Deduction Template. If True, the rate value can be changed.
**Is Rollover Underpaid Deductions** defines if deduction amounts that can not be withheld should be
rolled over to be withheld in future payruns.
**Quantity** defines the number of times the Deduction will be taken. If blank, no limit applies.
**Quantity Worked Maximum** is the maximum number of hours that may be applied to the Deduction, if
the actual hours worked for the period are less than or equal to this value.
**Quantity Worked Minimum** is the minimum number of hours that may be applied to the Deduction, if
the actual hours worked for the period are greater than or equal to this value.
**Total Deduction Limit** defines an upper limit to the Deduction amount that can be withheld for the
Deduction. When Deductions are calculated, the Deduction amount withheld will be adjusted to ensure
this amount is not exceeded. If blank, no limit applies.
## Further Information
| Document | Document Type | Description |
| --------------------------------------------- | ----------------- | ---------------------------------------------- |
| QRG Create a Payee record | Task Instructions | How to create a Payee Record |
| QRG Create a Payee Deduction - PAYG | Task Instructions | How to create a PAYG Payee Deduction |
| QRG Create a Payee Deduction - Superannuation | Task Instructions | How to create a Superannuation Payee Deduction |
| QRG Create a Payee Deduction - General | Task Instructions | How to create a General Payee Deduction |
| QRG Create a Payee Deduction - Purchase Leave | Task Instructions | How to create a Purchase Leave Payee Deduction |