Skip to main content

​
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:
  1. Navigate to the Payee record.
    1. To identify a Payee record from an Employee record, enter the Employee name into the Global Search (see Figure 1).
    2. Select the Employee record from the suggestions provided.
    3. Open the Related tab (see Figure 2).
    4. Identify the Payee related list.
    5. Select the Payee record.
Figure 1
Screenshot from QRG Create a Payee Deduction - PAYG
Figure 2
Screenshot from QRG Create a Payee Deduction - PAYG
  1. Click Deductions from the tab options (see Figure 3).
  2. Click the New button.
Figure 3
Screenshot from QRG Create a Payee Deduction - PAYG
  1. Select PAYG Deductions from the available record types (see Figure 4).
  2. Click the Next button.
Figure 4
Screenshot from QRG Create a Payee Deduction - PAYG
  1. Populate the following required fields, regardless of whether you are using Payee Deduction Templates or not (see Figure 5):
    1. Payee Deduction Record
    2. Payee
    3. Employee
    4. Payment Entity
  2. Populate the following optional fields as needed:
    1. If the Payee Deduction is specific only to one Assignment, populate the Assignment field. If blank, this Payee Deduction will apply to all Assignments for this Payee.
    2. 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.
Figure 5
Screenshot from QRG Create a Payee Deduction - PAYG
  1. Populate the following required fields (see Figure 6):
    1. Effective Date
    2. Status
  2. If using the Payee Deduction Template, the Payee Deduction Template field becomes a required field (see Figure 6).
  3. If the Payee Deduction Template is NOT being used, the following additional fields become required (see Figure 6):
    1. Pay Code
    2. Deduction Rate Type
    3. Deduction Rate
    4. Deduction Order
  4. To define any rules and limits that apply to the Payee Deduction record, populate the following optional fields as needed:
    1. Expiry Date
    2. Deduction Units
Figure 6
Screenshot from QRG Create a Payee Deduction - PAYG
  1. Populate the required fields of Pay To Withholding Record and Pay To Type (must be Payee Withholding) to relate the specific PAYG Withholding Record this deduction is related to (see Figure 7).
  2. To define any rules and limits that apply to the Payee Deduction record, populate the following optional fields as needed (see Figure 7):
    1. Based on Quantity Worked
    2. Quantity Worked Minimum
    3. Quantity Worked Maximum
    4. Total Deduction Limit
    5. Quantity
    6. Pay Calendar Period Deduction Limit
    7. Protected Amount Applied
    8. Is Rollover Underpaid Deductions?
  3. Click the Save button.
Figure 7
Screenshot from QRG Create a Payee Deduction - PAYG
An Assignment should only be entered if the Deduction is directly related to a specific role. If an Assignment is not entered, the Deduction will apply to all Pay Transactions processed to the Payee.
The Pay Batch Event field will be automatically populated upon saving the record, and should not be manually entered.
When Pay Transactions are created within a Pay Batch for PAYG Deductions, the Total Amount will be rounded to the nearest whole dollar.
The Status field will be automatically updated upon saving the record, based on the Start Date and End Date.
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. This is not normally applicable for PAYG Payee Deductions.
The PAYG Payee Deduction Record must have a related record in the Pay to Withholding Record field, to ensure it’s linked to the existing PAYG Withholding record associated with the Payee and will report as required for Single Touch Payroll Lodgements.
The Deduction Payrun Statistics will update automatically with historical statistics of the Deduction record, and should never be manually populated.
The Super Contribution Type field is not required for Payee Deduction - PAYG Record Type and can be ignored.
A new PAYG Payee Deduction Record is now created (see Figure 8).
Figure 8
Screenshot from QRG Create a Payee Deduction - PAYG
The payment for this deduction can be included in the PAYG payment within a Payment File created with a Pay Batch, if this has been configured on the Payment Entity.
  1. 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.
  2. When complete, click on the Save button.

​
Field Descriptions

​
Further Information

Last modified on August 11, 2026