Purpose
The purpose of this quick reference guide is to step through the process of creating a PAYG Payee Deduction record. The intended audience for this document are system administrators / standard users.Steps
Create a new PAYG Payee Deduction record
The PAYG Payee Deduction record holds general information, Pay Code and Rates, Quantity Worked variations, Deduction Limits, recipient details and Deduction Statistics for a Payee Deduction Record. Create a PAYG Payee Deduction by following the below steps:- Navigate to the Payee record.
- To identify a Payee record from an Employee record, enter the Employee name into the Global Search (see Figure 1).
- Select the Employee record from the suggestions provided.
- Open the Related tab (see Figure 2).
- Identify the Payee related list.
- Select the Payee record.
- Click Deductions from the tab options (see Figure 3).


- Click the New button.

- Select PAYG Deductions from the available record types (see Figure 4).
- Click the Next button.

- If you are using Payee Deduction Templates, please proceed to step 7, otherwise you can skip to step 8.
- Populate the following required fields ONLY if you are using the Payee Deduction Templates (see Figures 5 - 6):
- Payee Deduction Record
- Payee Deduction Template
- Employee
- Payee
- Payment Entity
- Effective Date
- Pay Code - only if not populated on the Payee Deduction Template
- Deduction Rate Type
- Deduction Rate
- Pay To Withholding Record - (picklist values will appear after the Payee field has been populated)
- Based on Quantity Worked
- Status
- Populate the following required fields to provide the base details of the record. This step is applicable when you are NOT using the Payee Deduction Templates (see Figures 5 - 6):
- Payee Deduction Record
- Payee
- Employee
- Payment Entity
- Effective Date
- Pay Code
- Deduction Rate Type
- Deduction Rate
- Deduction Order
- Based on Quantity Worked
- Pay To Type (Payee Withholding)
- Pay To Withholding Record - (picklist values will not appear until the Payee field has been populated)
- Populate the following optional fields as needed:
- If the Payee Deduction is specific only to one Assignment, populate the Assignment checkbox. If blank, this Payee Deduction will apply to all Assignments for this Payee.
- If the field Based on Quantity Worked is set to Yes, populate the optional fields Quantity Worked Minimum and Quantity Worked Maximum.
- To prevent the Status of the Payee Deduction from being updated by the automatic status update scheduled job, populate the Exclude From Auto Update checkbox.
- To define any required rules and limits that will be used in assessing and determining the Payee Deduction record, populate the following optional fields as needed. If left blank, the rule / limit will not apply.
- Expiry Date
- Deduction Units
- Total Deduction Limit
- Quantity
- Pay Calendar Period Deduction Limit
- Protected Amount Applied
- Is Rollover Underpaid Deductions?
- Click the Save button.

The Pay Batch Event field will be automatically populated upon saving the record, and should not be manually entered.

The Deduction Payrun Statistics will update automatically with historical statistics of the Deduction record, and should never be manually populated.

Payee Deduction records CANNOT be deleted if they have related records or are used in other records. Deleting records is not recommended unless absolutely essential.
- To modify an existing Payee Deduction record, 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.
- When complete, click on the Save button.
Field Descriptions
Assignment details if this Payee Deduction Record is specific to an Assignment. If no Assignment is entered, the Deduction will apply to Pay Transactions for all Assignments related to the Payee. 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 Transactions. Deduction Order determines, after the application of being a pre-tax or post-tax deduction (as per the Associated Pay Code), the ascending order in which Payee Deduction records will be assessed during the creation 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 Payee’s earnings for the pay period.
- Percentage of Gross is the amount to be deducted as a percentage of the Payee’s Gross earnings for the pay period.
- Percentage of OTE is the amount to be deducted as a percentage of the Payee’s Ordinary Time Earnings (OTE) 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.