Deputy

hours staff

Hours worked between two days, by employee, area or day, largest first: hours, the approved part, cost and shifts. Discarded shifts and leave are left out.

from*

string. First day, e.g. 2026-09-01.

to

string. Last day, inclusive. Default today; at most 400 days.

by

string. Default employee.

addresses Addresses

Addresses (employees' home, postal and emergency addresses, locations' and areas' addresses): street, city, state, postcode.

Keyed by source_id

areas Areas

Areas inside a location (Deputy's OperationalUnit) that shifts are rostered to: record_name, location_id, active.

Keyed by source_id

categories Categories

Categories Deputy sorts records into: record_name and category_group.

Keyed by source_id

comments Comments

Comments on Deputy records: orm names the kind of record and rec_id its Id.

Keyed by source_id

company_periods Company periods

Each location's pay period dates: location_id, pay_period_id, date_start and date_end.

Keyed by source_id

contacts Contacts

Contact records (email, phone) that employees, locations and areas name by Id.

Keyed by source_id

countries Countries

Deputy's list of countries, which addresses name by Id.

Keyed by source_id

custom_app_data Custom app data

Data other apps installed in Deputy keep there: label, key_string, employee_id and area_id.

Keyed by source_id

custom_field_data Custom field data

The values of custom fields (F01 to F128) that a record names by its CustomFieldData Id.

Keyed by source_id

custom_fields Custom fields

Custom fields set up in Deputy: record_name and api_name.

Keyed by source_id

employee_agreement_histories Employee agreement histories

Each version of an employee's pay agreement: employee_agreement_id, start_date, effective_date, base_rate and annual_salary.

Keyed by source_id

employee_agreements Employee agreements

Each employee's pay agreement: employee_id, active, start_date, payroll_id and the pay rates in the document.

Keyed by source_id

employee_appraisals Employee appraisals

Performance ratings given to employees: employee_id, day and the marks.

Keyed by source_id

employee_availabilities Employee availabilities

When each employee says they can or cannot work: employee_id, day and the schedule.

Keyed by source_id

employee_histories Employee histories

Each version of an employee's record over time: employee_id, record_name, start_date and termination_date.

Keyed by source_id

employee_paycycle_returns Employee paycycle returns

The pay lines of a pay cycle: employee_paycycle_id, pay_rule_id, value (hours or units), cost and approved.

Keyed by source_id

employee_paycycles Employee paycycles

One employee's pay for one pay period: employee_id, pay_period_id, time_total (hours), cost_total, paid and exported.

Keyed by source_id

employee_profiles Employee profiles

Deputy's v2 employee list: each person with their contact, addresses, workplaces, training records and stress profile nested.

Keyed by source_id

employee_roles Employee roles

Access levels in Deputy (employee, supervisor, location manager…) and their ranking.

Keyed by source_id

employee_salary_opunit_costings Employee salary opunit costings

A salaried employee's cost spread across areas by day: employee_id, area_id, day and cost.

Keyed by source_id

employee_workplaces Employee workplaces

Which locations each employee works at (employee_id, location_id), with their agreements there.

Keyed by source_id

employees Employees

Staff: record_name, active, location_id, start_date, termination_date, email, and the whole contact record (ContactObject).

Keyed by source_id

employment_conditions Employment conditions

Award conditions behind a contract: record_name, award_level and hours per day.

Keyed by source_id

employment_contract_leave_rules Employment contract leave rules

Which leave rules each contract allows (employment_contract_id, leave_rule_id), with their pay rules.

Keyed by source_id

employment_contracts Employment contracts

Awards and contracts employees are paid under: record_name, code, start_date, end_date and the pay rules.

Keyed by source_id

events Events

Events on the roster calendar: record_name and schedule_id.

Keyed by source_id

geo_tags Geo tags

Where a record was made (a clock-in, for example): orm and rec_id name the record, with latitude and longitude.

Keyed by source_id

journals Journals

Journal notes written against an employee: employee_id, day and the comment.

Keyed by source_id

kiosks Kiosks

Clock-in kiosks: record_name, location_id and when each was last used.

Keyed by source_id

leave_accruals Leave accruals

Leave earned and taken, line by line: employee_id, leave_rule_id, day and hours. Balances: summarize hours by employee_id and leave_rule_id.

Keyed by source_id

leave_pay_lines Leave pay lines

The pay lines for leave taken: leave_request_id, leave_rule_id, timesheet_id, day, hours and cost.

Keyed by source_id

leave_requests Leave requests

Leave: employee_id, leave_rule_id (leave_rules), date_start, date_end, total_hours and status (0 awaiting, 1 approved, 2 declined, 3 cancelled, 4 date only approved, 5 pay approved).

Keyed by source_id

leave_rules Leave rules

The kinds of leave set up in Deputy (annual, personal and so on).

Keyed by source_id

locations Locations

Deputy's locations (its Company object): record_name, code, active and whether each is a workplace.

Keyed by source_id

memos Memos

Newsfeed memos posted to staff.

Keyed by source_id

pay_periods Pay periods

Pay periods: record_name, start_date and active.

Keyed by source_id

pay_rules Pay rules

Pay rules: record_name (PayTitle), hourly_rate and payroll_category.

Keyed by source_id

public_holidays Public holidays

Public holidays set up in Deputy: record_name and schedule_id (the schedule holds the date).

Keyed by source_id

roster_opens Roster opens

Open shifts offered to employees, and who accepted (roster_id, employee_id, accepted).

Keyed by source_id

roster_swaps Roster swaps

Shift swap requests between two rosters (source_roster_id, target_roster_id), with status.

Keyed by source_id

rosters Rosters

The PLAN: shifts rostered to employee_id in area_id, by day, with total_hours, cost, published and open (unassigned). Never time worked.

Keyed by source_id

sales_data Sales data

Sales figures used to plan rosters: day, area_id, employee_id, sales_type, sales_qty and sales_amount.

Keyed by source_id

schedules Schedules

Schedules that events, holidays and availability repeat on: record_name, start_date and end_date.

Keyed by source_id

sms_logs Sms logs

Text messages Deputy sent: destination, the message and how many parts.

Keyed by source_id

states States

Deputy's list of states, by country.

Keyed by source_id

stress_profiles Stress profiles

Fatigue rules: the most hours a shift, a day or a week may hold.

Keyed by source_id

system_usage_balances System usage balances

Deputy's account balance entries for paid features (text messages and so on): day, credit and description.

Keyed by source_id

system_usage_tracking System usage tracking

Each use of a paid Deputy feature: day, usage, description and employee_id.

Keyed by source_id

task_group_setups Task group setups

Task group templates: record_name and active.

Keyed by source_id

task_groups Task groups

Groups of tasks for an area on a day: record_name, area_id and day.

Keyed by source_id

task_opunit_configs Task opunit configs

Which task templates run in which area: task_setup_id, area_id and active.

Keyed by source_id

task_setups Task setups

The task templates: record_name (the question) and active.

Keyed by source_id

tasks Tasks

Tasks set against areas: record_name (the question), area_id, day and due_date.

Keyed by source_id

teams Teams

Teams of employees and their leader (leader_employee_id).

Keyed by source_id

timesheet_pay_returns Timesheet pay returns

The pay lines Deputy worked out for a timesheet: timesheet_id, pay_rule_id, value (hours or units), cost and overridden.

Keyed by source_id

timesheets Timesheets

Time WORKED, as Deputy holds it: employee_id, area_id, day (the install's own day), started_at, total_hours, cost, approved, discarded, leave (a leave entry, not work) and in_progress. Hours worked: summarize total_hours where discarded is false.

Keyed by source_id

training_modules Training modules

Training and qualifications set up in Deputy: record_name, provider, cost and renewal period.

Keyed by source_id

training_records Training records

Training each employee completed: employee_id, training_module_id, training_date and expiry_date.

Keyed by source_id

webhooks Webhooks

Webhooks set up on the install: topic and enabled. Their headers and any credentials in their address are not held.

Keyed by source_id