Skip to main content

Pay rule calculation type - Timesheet Field Payment

Chris Knight
  • Updated
Note: From October 1st, 2025, we introduced new plans that better reflect how our customers use Deputy: Lite, Core, and Pro. If you're an existing customer, look out for an email with all the details you’ll need. Learn more about the new plans and what this change means for you.

This article discusses the Timesheet Field Payment pay rule calculations as part of Deputy's Pay Rate Builder.

Before you begin, please read about adding and editing pay rule calculations

Description

The Timesheet Field Payment pay calculation rule pays out allowances based on the numerical answer entered in a custom timesheet field. You can click to learn more about Creating custom timesheet fields for shift questions.

Example use case

You can click to learn about Automating Allowances with Pay Rate Builders.

Some team members are paid a particular amount per unit of distance they drive, for the number of sales they have made, or for another metric-based calculation. 

When setting this up, you need a Custom Timesheet Field configured with a field type of Number. This needs to be set up to ask the employee how many kilometers they've driven in a shift, the number of sales they made, or another metric you need to calculate the allowance for. You can then enter how they are paid. For example, if a user enters 100, they will pay 100x whatever value is entered. Note: You can also set limits on this to pay a minimum or maximum amount.

Supported rule types

This rule is only available as a shift loading. This means it will be paid as an additional payment on top of other calculated hours, such as ordinary time and overtime.

 

Outputs

This rule will return the entered number in the timesheet field multiplied by the configured payment option.

Configurable parameters (standard)

You can configure these standard fields in the Shift Loading pay rule calculation.

Name Defines the name of the pay rule
Timesheet Custom Field Select a timesheet custom field. This must be a Numeric field.
Export code Defines if this pay rule should be exported to payroll. If yes, they can also specify a code for the rule.
Days of the week this calculation applies

Defines which days of the week this rule applies to.

For example, if Saturday and Sunday are selected, this rule calculates only the parts of the timesheet that overlap Saturday and Sunday.
Time of the day this calculation applies

Defines which part of the day this rule applies to.

By default, this is all day. However, it can define a portion of a day (e.g., a defined night shift, such as 6 pm-6 am). If this is done, only those parts of the timesheet that overlap with this are calculated.
Public holiday

Select whether this pay rule applies:

  • Always applies (i.e., applies whether the day is marked as a public holiday or not).
  • Applies only on days marked as a public holiday.
  • Does not apply on public holidays (i.e., only on days not marked as public holidays).
Areas

The rule applies to all areas by default. However, you can apply it only when a timesheet is worked in a specific area/location.
Options include:

  • Certain Areas - pick particular areas to apply
  • Key Area Names - type in a title of an area, like 'Supervisor', to apply to all areas containing this name.
Classifications If you have set up classifications within the pay rate, you can select if a rule only applies to a particular classification.

Configurable parameters (advanced):

These are the advanced fields you can configure in the Consecutive days worked pay rule calculation

Apply to Training

This pay rule will only be applied to team members with the selected Training record on their employee profile. 

Read more at Managing Training Records.
Does this apply to a specific date
 		 If set as Yes, the pay rule will only apply on the defined date, assuming the date falls on the previously defined allowable day and time above.
Apply pay rule to unscheduled shifts

Defines how the pay rule interacts with scheduled and unscheduled shifts:

  • If set to unscheduled, this rule will only trigger for unscheduled shifts.
  • If set to scheduled, this rule will only trigger on scheduled shifts.
  • If set to both, it will trigger on all shifts provided other conditions are met.
Pay portion rule

Generally, an hourly rate will be assigned according to the exact hours that are matched, however, it is possible to enforce an hourly rate for a full shift even if it only matches a minor or major portion of that shift.

Deputy recommends using the Exact Hours option in most cases.
Rate type

Categorizes the pay rule as Overtime, Ordinary, Penalty or Non-Payable time.

These are used to define time worked for other calculation types (for example, Periodic Overtime counts Ordinary and some penalty hours towards it).
Rate tag

A custom value that can be applied to the timesheets.

Deputy recommends only using this if advised by your implementation consultant.
Pay once per day
 		 If set as Yes, this pay rule may only apply once per day. If No, it may apply to multiple timesheets on a given day.
Clock in and out requirements

For this rule to apply, the team member must clock in and clock out within the defined periods.

By default this is midnight to midnight (ie. any time is allowed.)
Apply this pay rule for custom timesheet fields

With this, the rule will only apply if particular values are selected in the custom timesheet field questions.

Note that only List and Boolean questions are available.

Read more at Creating custom timesheet fields for shift questions.
Apply this pay rule when shift custom fields

This rule will only apply if particular values are selected in the custom shift fields in the schedule.

Note that only List and Boolean questions are available.

Read more at: Creating custom shift fields
Custom Employee Fields

This rule will only apply if particular values are selected in the employee’s custom fields (for example, job position).

Note that only List and Boolean fields are available. 

(Available to customers on most Deputy plans).

Read more about setting up custom fields for team members. 

 

Related articles