Before You Start
Please note that this guide is for our Deputy Premium customers. If you're an Enterprise customer, please contact our support team for any assistance regarding Xero.
Before you get started, please make sure that you have set up both your Xero and Deputy accounts.
Next, please go to your Location Settings from your Home page. Next, please go to Settings for Payroll, then click Connect to connect to Xero.
If you have not already imported your employees from Xero, please do so now. If you have already added staff without importing from Xero, please first make sure that your employees' names and email addresses match up between Deputy and Xero, then follow the steps to import your employees. This will ensure that your employees are not duplicated.
Please note: Pay Rate Syntax is only required if you have complex rules you wish to automate. If you do not, please setup their Regular Earnings, as well as these Saturday, Sunday and Public Holiday rates, which do not require numbering.
- Saturday [SAT][ALLDAY]
- Sunday [SUN][ALLDAY]
- Public Holiday [PH][ALLDAY]
What Is Pay Rate Syntax?
Pay Rate Syntax is a custom system created by Xero and Deputy, offering unprecedented flexibility for your rates. It will allow you to:
- Pay different rates for different days of the week
- Pay different rates for different times of the day
- Pay only a maximum or minimum number of hours
- Only pay certain rates if they are working in certain areas or a specific Xero tracking code
Where Do I Write The Rates?
In Xero, please go to your Settings. Next, please select Payroll Settings. From Payroll Settings, please select Pay Items, then "Add".
After creating the rate, please apply it to your employees. To do this, please go to Payroll, then Employees. From there, please select an employee. Then go the employment tab and click "Add Salary & wages" and setup a "Salary and Wages". This will prompt you to set a regular earnings type (or regular hours) which will act as a base earning rate for that employee.
To add additional earnings go to the Pay Templates tab and click "Add New earnings".
To set a salary item in Xero, please create the rate as "Regular Earnings" with the unit type set to "Hours". Then, when applying it to employees, you will be given the option to designate it as an annual salary. Salary rates do not require Pay Rate syntax. If you have applied a Salary rate as your employee's Regular Rate in Xero, you may still export their timesheets, however the employee will not be paid any extra, unless you choose to apply an overtime rate to that employee, which we will cover below.
How To Name Your Rates
When Deputy evaluates someone's roster or timesheet to calculate the associated cost, it will calculate the wages based on how the rate is named. The way Deputy handles this depends on two things: how you name the rates in Xero and how you allocate them in employee's pay template in Xero. All that you will need to do to set up your syntax is to write your rates in a specific manner. For example, you have probably written a pay item in Xero as "Casual Adult Public Holiday". Now you will write it as "Casual Adult [PH][ALLDAY]".
Here's how it works:
NUMBER The title of the rate [DAY][FROMTIME-TOTIME][MIN - MAX][TRACKING]
The Number determines the order in which the Deputy will sort the rate, with 0 being the most common rate. Generally, this will be your Regular Rate.
You can set the title of the rate as whatever you'd like.
The [Day] bracket determines the days on which the rate will apply.
The [FROMTIME-TOTIME] bracket allows you to set a specific time of day for the rate to apply.
The [MIN-MAX] bracket sets the hours of a shift that a rate may apply for. This is generally used for allowances and overtime.
The [TRACKING] bracket will restrict the pay rate to a certain rostering area, for example if you have set up a "kitchen" rostering area in Deputy, you can set the tracking category so that it will only apply to people working in the kitchen. The Area Export Codes and Tracking Codes will need to be set up first. You may also use the name of the Rostering Area in this bracket, which will be used to pay employees working from that area.
For the syntax to work, you must use specific language when naming your rates. Below is a list of the terms you may use and which bracket it must be used in. Please note that even for a bracket you want to leave empty, you must write the bracket itself into the rate. Please open it and close it with no space in the middle, like this: . You must have all four brackets present in the rate for the system to work.
When you assign these pay items in employee's profile, you must place the most common pay item at the top (e.g., regular hours) and the least common item at the bottom (e.g., public holiday rate). Please note that Xero may order the pay items back to front. To ensure that this doesn't happen, please order your rates with a number before the rate, with 0 being the most common rate. There is also a 50 character limit.
When Deputy evaluates a Timesheet to check which rate should be paid, it will look at the bottom-most condition first, then work it's way to the top. When it finds an applicable rate, it will check which portion of the shift applies before going on to next pay item.
- PH - Indicates public holiday
- DAILY - all the hours of the day is counted towards as one
- !PH - not public holiday.
- WEEKDAY,!PH - Applies every weekday but no public holiday
- WED,FRI - Only applies Wednesday and Friday
- WEEKLY - If you wanted to count the entire week towards these hours. Handy for 40 or 38 hours per week items. You must also specify the weekly total hours and daily hours exclusion below.
- ALLDAY- The default, which will make the rate apply for the whole day.
- 0000-2359 - must be 4 digit 24-hour time.
- 0.0~2.0 - The rate will apply from the beginning (0.0) to the second hour (2.0) of the shift. For this to apply, you will need to set MON/TUE/WED/PH as above. Aggregates such as DAILY, WEEKDAY, WEEKEND can also be used.
- 40|8 - On the left of the bracket should be your weekly hours, then a vertical line with the number of hours per day to include. For example, pay overtime for more than 40 hours per week but don't count more than 8 hours per day as they will be counted by other overtime scripts.
- NONE- You can use this, or leave the bracket empty.
- 1-4 - This rate will be paid for a minimum of 1 hour and maximum of 4 hours. Note that it's only applicable if the Xero rate type is "Allowance".
- TOUCHFULL- If part of the shift matches the TIME bracket, then the whole shift will be paid in this rate. For example, if you have Rate A that applies between 3 PM and 6 PM, then a Rate B that applies from 6 PM til midnight, and B is set to TOUCHFULL, a shift that is worked from 3 PM till 9 PM would be paid entirely at the B rate.
In the tracking bracket, you can write the name of one of your Tracking Codes or Rostering Areas. If you do so, the rate will only apply if a shift has been worked in the corresponding area. This is useful for settings multiple rates on an individual who works in more than one area, such as a barista who also works in the bar.
There are occasionally scenarios that the above syntax cannot cover, such as split shifts and period loadings. For scenarios like this, we use custom scripts that have their own syntax, which looks like this:
15 Uniform allowance [SCRIPT][once_per_day_0914][0.0-1.0]
You can view our available scripts in Deputy's github repository. Currently these are the only available scripts for use with syntax.
For 40hr over time:
1 Regular Hours [DAILY][ALLDAY]
2 Weekly Overtime [WEEKLY][40|24]
For 48 hr overtime:
1 Regular Hours [DAILY][ALLDAY]
2 Weekly Overtime [WEEKLY][48|24]
With area specific rates :
1 Regular Hours [DAILY][ALLDAY]
2 Kitchen Hours [DAILY][ALLDAY][Kitchen]
3 Supervisor Hours [DAILY][ALLDAY][Supervisor]
You can copy and paste these rates into Xero as Pay Items.