^
Login

Frequently Asked Questions

Authors
Category   Billing   Employee   Employee Profile   Employee Settings   EOFY   Fingerprint   Fingerprint Scanners   General   Glossary   Groups   HR   Jobs   Leave   Mobile App   Notification Config   Payroll   Payroll Rules   Reports   Roster   Security   Settings   Skills Matrix   STP   Superannuation   Timesheet   VEVO   Xero

How can Extra Rules be imported via CSV?

Author Joel Davis@Microkeeper
Category Payroll
Last Modified 23/04/2025

Extra Rules can be imported via CSV.

Prepare the CSV file formatted with columns in the exact order mentioned below:

Variable name
Description
Required
Accepted Formats
Example
ERID
The ID of the existing rule if updating
FALSE
Numeric
123
extraname
The name of the extra rule that will appear on payslips
TRUE
Alphanumerical

Night Shift Allowance
eusername
Who the rule applies to
TRUE
"ALL" or specific employee usernames/group IDs
john_smith
type
The type of extra rule
TRUE
"fixed" or "percent"
fixed
value
The dollar amount ($10) or percentage value (0.75 for 75%)
TRUE
Decimal


10.25
extraafter
Hours worked required before the rule applies
TRUE
Decimal
0
ts_logic
How the rule applies to timesheets:
  • "na" - No timesheet condition
  • "less" - Applies if shifts/days are less than or equal to the multiplier
  • "equal" - Applies if shifts/days equal the multiplier
  • "great" - Applies if shifts/days are greater than or equal to the multiplier
  • "shift" - Applies per shift worked
  • "hours" - Applies per hour worked
  • "hrs_c" - Applies per hour when code is present in timesheet notes
  • "hrs_m" - Applies up to maximum hours
  • "split" - Applies for split shifts
TRUE
"na", "less", "equal", "great", "shift", "hours", "hrs_c", "hrs_m", "split"
na
multi
The multiplier value or shift count threshold
TRUE
Intereger

1
overtime
The payment classification:
  • "FALSE" - Normal
  • "TRUE" - Overtime
  • "BONUS" - Bonus
  • "EXTRA" - Extra
  • "ALLOW" - Allowance
  • "ALLO2" - Taxfree Allowance
  • "WCE" - Workers Comp Entitlements
  • "RBURS" - Reimbursement
TRUE
"FALSE", "TRUE", "BONUS", "EXTRA", "ALLOW", "ALLO2", "WCE", "RBURS"
ALLOW
stp_extra
STP Classification Chart
TRUE
String (from STP Classification Chart)
Other
condition1
When the rule applies based on time:
  • "0" - No time condition
  • "1" - Start time between specified times
  • "2" - End time between specified times
FALSE
"0", "1", "2"
1
bw_start
Start time for time condition
FALSE
HH:MM (24-hour format)
19:00
bw_end
End time for time condition
FALSE
HH:MM (24-hour format)
06:00
day
Day of week the rule applies to:
  • "" - All days
  • "Weekdays" - Monday to Friday
  • Specific day names ("Monday", "Tuesday", etc)
FALSE
"", "Weekdays", or specific day names
Friday
job
How jobs are recorded:
  • "0" - No Job
  • "1" - Job on Roster or Timesheet
  • "2" - Default Job in Employee Profile
  • Specific Job ID
FALSE
"0", "1", "2", or specific Job ID
0
shadow
When the rule applies:
  • "0" - Normal payrun only
  • "1" - Shadow (Annualised Salary) only
  • "2" - Both normal and shadow
FALSE
"0", "1", "2"
0
day_v_shift
Whether to count days or shifts:
  • "0" - Count shifts
  • "1" - Count days
FALSE
"0" or "1"
0


Example CSV Format

ERID
extraname
eusername
type
value
extraafter
ts_logic
multi
overtime
stp_extra
condition1
bw_start
bw_end
day
job
shadow
day_v_shift

Extra Payment
ALL
fixed
10
0
na
1
ALLOW

0
00:00
00:00

0
0
0

Night Shift Allowance
john_smith
fixed
20
0
great
2
ALLOW
Other
1
19:00
06:00
Weekdays
1
0
0


Uploading the Extra Rules CSV File

Uploading the CSV File

  1. Navigate to Menu > Settings > Payroll Rules > Extra Rules
  2. Click the "CSV Transfer" button
  3. Select "Import CSV"
  4. Choose the prepared CSV file

A confirmation message will indicating the number of records that were successfully imported or updated.


Important Notes

  • When updating existing rules, include the ERID in the CSV file
  • For new rules, leave the ERID column blank
  • Time values should be in 24-hour format (HH:MM)
  • Make sure all required fields are populated
  • Values should match exactly with the options listed above
M