Payroll Earning Codes (Asia Pacific)
Important: This wizard is for use only by customers with Pay Groups in Australia, New Zealand, or Asia. See the Prerequisites section (below).
Customers with Pay Groups in c can use the Payroll Earning Codes (Asia Pacific) wizard to create and install new payroll earning codes.
This wizard uses a template that includes the most common configuration options for earning codes. The template also includes the settings required for single-touch payroll reporting in Australia and IR8A reporting in Singapore. You can also use this wizard to add one or more Pay Groups to some of the new earning codes. Because employee payroll election and year-to-date information aren’t required, this wizard reduces the time and effort needed to gather the data and work through the wizard. This wizard significantly reduces the need to update settings on earning codes after the data load. The Payroll Earning Codes (Asia Pacific) wizard simplifies implementations, reduces manual interventions by human resources and payroll teams, and improves data integrity.
Important notes
- Customers with pay groups in Australia, New Zealand, or Asia can use this wizard to install earning code information in Dayforce. The other option is to use the standard Payroll Earning Codes wizard, which requires employee payroll elections and year-to-date data.
- Pay Groups, Custom Earning Groupings, and Payout Balances aren’t created as part of this wizard.
Prerequisites
To use this wizard, you must have Pay Groups in at least one of the following countries:
- Australia
- New Zealand
-
Asia (Afghanistan, Bahrain, Bangladesh, Bhutan, The British Indian Ocean Territory, Brunei Darussalam, Cambodia, China, Christmas Island, The Cocos (Keeling) Islands, Hong Kong, India, Indonesia, Iran, Iraq, Israel, Japan, Jordan, Korea, The Democratic People's Republic of Korea, Kuwait, Kyrgyzstan, Laos, Lebanon, Macao, Malaysia, Maldives, Mongolia, Myanmar, Nepal, Oman, Pakistan, State of Palestine, Philippines, Qatar, Saudi Arabia, Singapore, Sri Lanka, The Syrian Arab Republic, Taiwan, Tajikistan, Thailand, Timor-Leste, Turkmenistan, United Arab Emirates, Uzbekistan, Vietnam, and Yemen)
The pay groups, custom earning groups, and payout balances must already be set up and installed in Dayforce. See Pay Group Editor.
Errors, warnings, and messages
The rules set up in Dayforce generate any Error or Warning indicators shown above the grid's column headings.
- Errors prevent you from continuing with the Wizard.
- Warnings are informational and indicate potential problems that you need to be aware of.
- Messages are informational and identify a deviation from the rules.
To refer to the errors, warnings, and messages while you correct the data, click Download Errors File.
To correct the errors, messages, or warnings, do one of the following:
- Update the information directly in the grid.
- Click Download Errors File to download the list and then upload an Excel file containing the corresponding corrections.
Whether you edit the data directly in the grid or upload the file, Activate shows validation warnings or errors to indicate problems with the data. To review and correct any warnings or errors that display, either edit the records in the grid or upload the corrected information in a template again.
Tasks
To confirm the prerequisites:
- In Activate Central, click Build Dayforce. The Build Dayforce wizards show.
- Click Payroll Earning Codes (Asian Pacific).
- On the Intro page, review the information.
- Select the checkbox to confirm that the following are configured in Dayforce:
- Pay groups
- Custom earning groups
- Payout balances
- Click Next.
To complete and upload the Payroll Earning Data template:
- On the Payroll Earnings Data) page, click Download.
- Select the location where you want to save the template document.
- Open the
PayrollEarningDataTemplate.xlsx
template on your hard drive.Note: You can also download an empty Payroll Earning Data template from the Download Template Files page.
Note: The Activate release version shows in cell B3 on the Instructions tab of the template. This information helps you later determine the version of Activate you were using when you downloaded the template.
- On the Payroll Earning Data tab, complete all columns with the data for all required new earning codes.
Important: Make sure that you include all earnings that are used currently and earnings used during the elected parallel periods.
Note: Instructions for populating the fields are in the Payroll Earning Data Template Fields section (below) and on the Instructions tab of the template.
- Click Save and close the template.
You can use any file name for the template you upload. The only requirement is that it's an Excel or CSV (Comma-Separated Value) document and contains the data in the required format.
Important: Don’t change the name of the tab. Activate uses it to validate that the correct template is being uploaded.
- On the Payroll Earnings Data page, click Upload.
- Go to your completed Payroll Earning Data template in the location where you saved it.
- Click Open. The Preceda Payroll Earning Codes wizard validates the uploaded file.
Note: If the file you uploaded has any errors, a Validation Failed message shows in red at the bottom of the page. You must correct the errors in the file on your computer and upload the file again.
Note: When you upload an Excel file, Activate includes the name of the uploaded file in the name of the XML file it generates and loads to the Dayforce File Server. The format of the generated XML file name is <NamespaceName>_<Import Type>_<file name provided>_YYY-MM-DD_HHMM. This naming convention makes it easier to audit files later.
- Click Next.
- Click Done and the Payroll Earnings Review page opens.
To review and confirm the data:
- Review the information shown in the grid.
You can use the pick list to display valid options on many fields. For some fields, the pick list includes any custom options configured in the customer’s Dayforce instance.
- To make updates to data on the page:
- To correct errors in the grid, click in the field containing the error. Click Tab to move to the right and Shift+Tab to move to the left in the row. Use the scrollbars on the right side and bottom of the grid to go to other areas of the grid.
To save information in the grid to your computer, click Download File and save it to the location you want. The download file includes only the following information: Employee Number, First Name, Last Name, Effective Start Date, and the respective global properties and values selected.
- To download a complete list of all errors from the data load process so you can review and correct them, click Download Errors File. The document lists the Severity, Employee Identifier, Column Name, Message, and Value for each item.
- When the data is complete, click Done & Install. The selected values remain in the grid after you leave the page.
Install the earnings information
When the deduction information is complete in Activate, you must install the data in Dayforce.
- After making any necessary corrections, on the Payroll Earnings Review page, click Load.
The Load page opens with a list of the steps to complete and an estimate of how long the installation usually takes. During the installation, the current step in the process is bolded so you can monitor the progress.
- Click one of the following:
- Add Email and enter your email address to receive an email when the installation process ends, instead of waiting for it to finish.
- Next w hen the installation is complete.
Activate Central opens with the name of the Wizard now shown in green text and a green checkmark to the left of the wizard’s name. The current day, date, and time of completion are included, along with your name as the user who completed the Wizard. The environment in which the installation was applied (Stage, Config, or Train) is also shown.
Note: If you want to add more information, click I want to add more. See Executing a Rollback When Using the “Add More“ Feature in the Payroll Wizards.
To correct errors in the grid:
-
Click in the field containing the error.
-
Enter or select the correct information.
If you make a change by mistake and haven't saved the change, click Refresh to undo the change.
To navigate in the grid, click Tab to move to the right and Shift+Tab to move to the left on a row. Use the scrollbars on the right side and bottom of the grid to go to other areas of the grid.
- Repeat this process for every error.
- Click Save. Activate verifies the information again.
- ClickNext.
To correct errors in the template:
- Click Download File to save the information in the grid to your computer.
- ClickSave and close the document.
- Click Upload File. A message states that importing a file will override all data in the grid.
- Click OK. The grid refreshes with the corrections included.
- ClickNext.
To refresh the data in the grid:
If you make a change on the page that you don't want to save, click Refresh. The page refreshes and any unsaved changes are removed.
To save errors, warnings, and messages:
- Click Download Errors File.
- Save the document to the appropriate place on your computer.
- Review the document.
The document lists the Severity, Employee Identifier, Column Name, Message, and Value for each item.
- Click Next.
Results
The deduction data is installed in Dayforce on the Payroll Setup > Earnings and Deductions > Earnings page.
Fields populated in Dayforce
The data uploaded from the Payroll Earnings Data template populates the fields on the following pages in Dayforce.
Dayforce fields populated by the Payroll Earnings Data template
Name |
Name |
Payroll Setup > Earnings and Deductions > Earnings, General tab |
Description |
Description |
Display Name |
Display Name |
Reference Code |
Reference Code |
Tax Compliance Rule |
Name & Referenece Code |
Payroll Setup > Earnings and Deductions > Earnings, Tax and Compliance tab |
Entry Type |
Entry Type |
Payroll Setup > Earnings and Deductions > Earnings, General tab |
Pay Entry Rate Type |
Rate Type |
Payroll Setup > Earnings and Deductions > Earnings, Pay Entry Rates tab |
Pay Entry Rate Amount |
Amount |
Pay Groups |
Pay Group |
Payroll Setup > Earnings and Deductions > Earnings, Pay Groups tab |
Allow Payee |
Allow Payee |
Payroll Setup > Earnings and Deductions > Earnings, General tab |
Payee Category |
Payee Category |
Payroll Setup > Earnings and Deductions > Earnings, Payees tab |
Is Hours Worked |
Hours Worked |
Payroll Setup > Earnings and Deductions > Earnings, General tab |
Is Overtime Hours |
Overtime Hours |
Is Overtime Earnings |
Overtime Earnings |
Custom Earning Groupings |
Custom Earning Groupings |
Display Hourly Rates |
Display Hourly Employee Rates |
Display Hourly Hours/Units |
Display Hourly Employee Hours/Units |
Display Salary Rates |
Display Salary Employee Rates |
Display Salary Hours/Units |
Display Salary Employee Hours/Units |
Display Earnings |
Display Earnings on Compensation Statement |
Premium |
Premium |
Payroll Setup > Earnings and Deductions > Earnings, Options tab |
Allow Hours without Amount |
Allow hours without amount |
Unpaid Time Reduces Autopay |
Allow Unpaid Time to Reduce Auto Pay Amount |
PAYEVNT Category |
PAYEVNT category |
PAYEVNT Code |
PAYEVNT code |
Other Allowance Type |
Other Allowance Type |
OTE Earning |
OTE Earning |
IR8A Reporting Section |
IR8A Reporting Section |
Payroll Setup > Earnings and Deductions > Earnings, Balances tab |
Payout Balance |
Payout Balance |
Pay on Termination |
Automatically Pay Out Balance On Termination |
Pay Based on Grant |
Payout Based on Balance Grant Amount |
Payout conversion from balance to currency |
Payout Conversion from Balance to Currency |
Payroll Earning Data template fields
All templates have the same basic structure:
- Instructions tab: Helps you understand the purpose of the data and complete the fields in the template.
- Data tab: Contains headers for the data to be included in the template. The headers remain the same, but you can change the column order. If you add more columns, Activate ignores them.
All number ranges in the templates include the numbers at both ends of the range.
To see a list of the fields in the template, click here.
Name (Required)
1 |
String1
between 1-64 characters. |
Name to identify the earning.
|
AUS Salary
NZL Salary
SGP Basic Salary
|
Used to identify the earning.
|
Description
2 |
String1
between 1-256 characters. |
A brief description of the earning.
|
AUS Salary
NZL Salary
SGP Basic Salary |
Used to identify the earning in reports.
|
Display Name
3
|
String1
between 1-15 characters. |
Shown on Earning Statements. Some special characters are acceptable, like dollar signs ($) and single quotation marks (').
|
Salary
Basic Salary |
Used to identify the earning in employee earning statements.
|
Reference Code (Required)
4
|
String1
between 1-128 characters. |
Cross-reference codes are used to export data from Dayforce to other applications.
|
AUS_SALARY
NZL_SALARY
SGP_BASIC_SALARY |
Used for imports and exports.
|
Tax Compliance Rule (Required)
5 |
String1
between 1-128 characters. |
Cross-reference code of the Tax and Compliance Rule associated with the Earning.
|
AUS Salary
NZL Salary
SGP Gross Salary
|
This information is used to identify the Tax and Compliance Rule associated with the earning.
For nonnative payroll countries, a custom Tax and Compliance Rule must be created for the required country before you use this template. |
Entry Type (Required)
6
|
Accepted Values:
- Pay Entry Amount Only
- Pay Entry Rates
- Generated
|
Select one of the following options:
Pay Entry Amount Only: Select this option to enter only a currency amount (for example, dollars) for payroll entries, such as quick entries.
Pay Entry Rates: Select this option so that you can enter hours or amounts for this earning on payroll entries and enable pay entry rates to load on the setup screen. If you don’t select this option, you can only enter a currency amount (for example, dollars).
Generated: Select this option for generated earnings only. When you select this option, the Allow Payee checkbox is available and the Parameters, Limits, and Pay Groups sub-tabs become available. Selecting this option also clears any Separate Check option you previously selected.
|
Pay Entry Rates
Pay Entry Amount Only
Generated
|
Used to identify if the earning allows for the entry of pay rates or amount, or if the earning is automatically generated based on configuration.
|
Pay Entry Rate Type (Conditional)
7
|
Accepted Values:
|
Select one of the following options:
Note: This option is required when the Entry Type is set to “Pay Entry Rates.”
|
Multiplier
Amount |
This field defines whether quick entry payments are calculated with a multiplier rate, or by a defined amount.
|
Pay Entry Rate Amount
8
|
Decimal. Digits: 15
Fraction: 5 |
Enter a default rate or a rate multiplier amount.
Note: This value can be provided only when the Entry Type is set to “Pay Entry Rates.“
|
1
|
The multiplier or defined amount used by the above option.
|
Pay Groups
9
|
Semicolon separated list.
String1
between 1–256 characters. |
When you enter a value for this option, Pay Groups are added to the Earning with default options
(every regular run, effective 1/1/1975).
Note: This value can be provided only when Entry Type is set to “Generated.“
|
WKLY;FTNT;MNTH |
Defined the eligible pay groups for generated earnings.
|
Allow Payee
10
|
Boolean.
|
Available for generated earnings. When you select this option, the Payees subtab is available and you can configure a third-party payee. For the default for each effective date range, only select one payee.
|
YES
NO
|
Enables generated earnings to be paid to a third-party payee.
When you select this option, the Payees subtab is made available, so you can configure a third-party payee after data load. |
Payee Category (Conditional)
11
|
String1 between 1-256 characters. |
Cross-reference code of the payee category.
Note: This option is required when Allow Payee is set to “YES.”
|
Custom Earning Payee Category
|
Defines the payee category for filtering the list of payees available on the Payees subtab. |
Is Hours Worked
12
|
Boolean.
|
This field indicates that the earning contributes to the total hours worked.
|
YES
NO
|
Used for reporting purposes. The default value is “No.”
|
Is Overtime
Hours
13
|
Boolean.
|
This field indicates that the earning contributes to overtime hours.
|
YES
NO
|
Used for reporting purposes. The default value is “No.”
|
Is Overtime Earnings
14
|
Boolean.
|
This field indicates if the earning should be accumulated as part of overtime earnings, which can be used for reporting or other payroll calculations.
|
YES
NO |
Used for reporting purposes. The default value is “No.”
|
Custom Earning Groupings
15
|
Semicolon separated list.
String1
between 1-–256 characters |
This field identifies the cross-reference code of the custom earning groupings that this earning belongs to.
|
AU_ORD; AU_OT;NZ_OWP
|
Used for reporting purposes.
|
Display Hourly Rates
16
|
Accepted Values:
-
Display
- Do Not Display
- Apply Report Output Setting
|
This field include or exclude hourly employees' rates from employee earning statements. The default setting makes sure that the earning respects the report output default setting.
|
Display
Do Not Display
Apply Report Output Setting
|
Shows the hourly employee rates in the earning statements. The default value is “Apply Report Output Setting.”
|
Display Hourly Hours/Units
17
|
Accepted Values:
-
Display
- Do Not Display
- Apply Report Output Setting
|
Include or exclude hourly employees' hours or units from employee earning statements. The default setting makes sure that the earning respects the report output default setting.
|
Display
Do Not Display
Apply Report Output Setting
|
Shows the hourly employee hours/units in the earning statement. The default value is “Apply Report Output Setting.”
|
Display Salary Rates
18
|
Accepted Values:
- Display
- Do Not Display
- Apply Report Output Setting
|
Include or exclude salaried employees' rates from employee earning statements. The default setting makes sure that the earning respects the report output default setting.
|
Display
Do Not Display
Apply Report Output Setting
|
Shows the salaried employee rates in the earning statement. The default value is “Apply Report Output Setting.”
|
Display Salary Hours/Units
19
|
Accepted Values:
-
Display
- Do Not Display
-
Apply Report Output Setting
|
Include or exclude salaried employees' hours or units from employee earning statements. The default setting ensures that the earning respects the report output default setting.
|
Display
Do Not Display
Apply Report Output Setting
|
Shows the salaried employee hours or units in the earning statement. The default value is “Apply Report Output Setting.”
|
Display Earnings
20
|
Boolean
|
Display the earning in the Compensation tab when an employee opens the Earnings feature.
|
YES
NO
|
Shows the earning in the Compensation tab of the employee Earnings feature. The default value is “Yes.”
|
Premium
21
|
Boolean.
|
Show all or part of the earning as a separate premium line item in the general ledger. If you select the Premium checkbox, any hours or units entered for this earning definition aren’t included in the total Hours or Units in the Earnings section of online or printed earning statements. However, they’re itemized if so configured. If this checkbox is cleared, the hours are included in the Hours or Units total in the earning statements.
|
YES
NO
|
Shows all or part of the earning as a separate premium line item in the general ledger. The default value is “No.”
|
Allow Hours without Amount
22
|
Boolean.
|
Include hours without an amount associated with them in employee earning statements.
Note: You can set this field to true only if the earning type is Memo Calculation and EntryType is not “Generated.” The default is “No.”
|
YES
NO
|
Allows hours without an amount associated with them in employee earning statements.
|
Unpaid Time Reduces Autopay
23
|
Boolean.
|
Include unpaid time to reduce the amount associated with autopay in employee earning statements.
Note: You can set this field to true only if the earning type is Memo Calculation and EntryType is not “Generated.” The default is “No.”
|
YES
NO
|
Allows unpaid time to reduce the amount associated with autopay in employee earning statements.
|
PAYEVNT Category
24
|
Accepted Values:
-
Lump Sum Payments
- Allowances
- Bonuses and commission items
- Overtime amount
- Directors Fees
- Paid Leave
CDEP Amount
- Income Fringe Benefits Reportable
|
Note: For Australian earnings only.
Define the PAYEVNT category for STP reporting.
|
Lump Sum Payments Allowances
Paid Leave |
This information is required in Australia for STP2 reporting.
|
PAYEVNT Code (Conditional)
25
|
Accepted Values:2
-
A
- AD
- C
- CD
- KN
- LD
- MD
- O
- OD
- P
- QN
- RD
- T
- TD
- U
-
W
-
X
|
Note: For Australian earnings only.
Define the PAYEVNT code to accompany the PAYEVNT category for STP reporting.
This option is required when the PAYEVNT Category is one of the following:
- Lump Sum Payments
- Allowances
- Paid Leave
- Income Fringe Benefits Reportable
|
AD
C
CD
KN
L
|
Required in Australia for STP2 Reporting.
The entered value is only valid if the PayEvent in brackets is also present:2
- A (Paid Leave)
-
C (Paid Leave)
- O (Paid Leave)
- P (Paid Leave)
- U (Paid Leave)
- W (Paid Leave)
- AD (Allowances)
- CD (Allowances)
- KN (Allowances)
- LD (Allowances)
- MD (Allowances)
- OD (Allowances)
- QN (Allowances)
- RD (Allowances)
- TD (Allowances)
- W (Lump Sum Payments)
- T (Income Fringe Benefits Reportable)
- X (Income Fringe Benefits Reportable)
- Blank/null value (Directors Fees |
CDEP Amount | Overtime amount | Bonuses and commission items)
|
2Australian STP PAYEVNT Code descriptions and which PAYEVNT Category values they can be used with
Allowances |
AD: Award Transport Payments
|
CD: Cents Per Kilometer
|
KN: Task Allowances
|
LD: Laundry Allowance
|
MD: Overtime Meal Allowances
|
OD: Other Allowances
|
QN: Qualifications/Certificates
|
RD: Domestic or Overseas Travel
|
TD: Tool Allowances
|
Paid Leave
|
A: Ancillary and defence leave
|
C: Cash out leave in service
|
O: Other paid leave
|
P: Paid parental leave
|
U: Unused leave on termination
|
W: Workers' compensation
|
Lump Sum Payments
|
W: Return to Work Payment
|
Income Fringe Benefits Reportable |
T: Taxable
|
|
X: Exempt
|
Directors Fees
|
Leave Blank
|
CDEP Amount
|
Overtime amount
|
Bonuses and commission items
|
Other Allowance Type
26
|
Accepted Values: 3
|
Note: For Australian Earnings only.
Used to define Other Allowance Type for STP reporting.
|
V1
T1
|
Required in Australia for STP2 Reporting.
The entered value is only valid if the PAYEVNT Category is “Allowances” and the PAYEVNT Code is “OD.”
|
3Australian Other Allowance Type descriptions
V1 - Private Vehicle
|
U1 - Uniform
|
T1 - Transport/Fares
|
ND - Non Deductible
|
H1 - Home Office
|
G1 - General
|
OTE Earning
27
|
Boolean
|
Note: For Australian Earnings only.
Include the earning as part of ordinary time earnings.
|
YES
NO
|
Required in Australia for STP2 Reporting. The default value is “No.”
|
IR8A Reporting Section (Conditional)
28
|
See Accepted Values.4 |
Note: For Singapore Earnings only. This option is required for all Singapore Earnings.
This field defines how to report the earning on the IR8A form.
|
Gross Salary
Contractual Bonus |
Required in Singapore for year end reconciliation.
|
4 Singapore IR8A Reporting Section options
Compensation For Loss Of Office
|
Contractual Bonus
|
Designated Pension
|
Director Fees
|
Donation
|
Employee Fixed Income Tax
|
Employer PF Cont. Overseas
|
Entertainment
|
Exempt Income
|
Ex-Gratia
|
Gratuity
|
Gross Commission
|
Gross Salary
|
Insurance
|
Lump Sum
|
Mosque Building Fund
|
Non Contractual Bonus
|
Notice Pay
|
Other Allowance
|
Pension
|
PILON
|
Provident Fund
|
RetrenchmentBenefits93
|
RetrenchmentBenefitsUpto92
|
ShareOptionGainsS101b
|
ShareOptionGainsS101g
|
Transport
|
Payout Balance
29
|
String1
between 1-64 characters
|
Define the balance associated with the earning.
|
AU_ANNUAL
|
This field links a balance to the earning. |
Pay on Termination
30
|
Boolean.
|
This field indicates whether the associated balance is paid out on termination.
|
YES
NO
|
This field enables the linked balance to be automatically paid on termination. The default value is “No.”
|
Pay Based on Grant
31
|
Boolean.
|
This field indicates whether only the associated balance's grant amounts are paid on termination.
|
YES
NO
|
This information prevents balances that aren’t defined as a grant from being paid on termination. The default value is “No.”
|
Payout Conversion from Balance to Currency
32
|
String1
between 1-64 characters. |
The formula is applied when converting a payout balance to the earning amount to be paid.
The following elements and variables can be used:
{b} - The balance amount. It represents one unit of whatever balance that’s being paid out.
Standard mathematical symbols for multiplication (*), division (/), addition (+), and subtraction (-).
{EMP_BASE_RATE} - Returns the employee’s base rate.
{EMP_VAC_RATE} - Returns the employee’s vacation rate.
{EMP_DAILY_HR} - Returns the employee’s average daily hours.
{EMP_WEEKLY_HR} - Returns the employee’s normal weekly hours.
|
{EMP_WEEKLY_HRS}*{EMP_BASE_RATE}
|
Defines the conversion rate for the balance payout.
|