Deputy

Rosters, timesheets, pay lines and leave. Read-only.

Connects with	Permanent token
Reads	15 operations
Writes	None
Irreversible	None
Personal data	Employee names, hours, pay lines and leave.
Data stays in	AWS Sydney (ap-southeast-2)

What it reads

• The person the token acts as, their access level and location. Everything else returns only what that person is permitted to see.
• Locations and areas of work.
• Employees, current and past.
• Rostered shifts (the plan) and timesheets (what was worked), with hours and cost.
• The pay lines an approved timesheet produced, and the pay rules behind them, so ordinary hours and overtime separate.
• Leave requests and leave types.
• Sales figures, where a point of sale pushes them into Deputy.

What it does not read

Employee contact and bank details. The employee list carries name, position, location, status and dates, and nothing else.

What it writes

Nothing. There are no write operations in this connector.

How you connect it

Connect with a permanent token. In Deputy, open /exec/devapp/oauth_clients on your install, create an OAuth client, then choose Get an Access Token.

What StoriBot will ask for

• Your install name: the first label of the address you sign in at, so acme for acme.au.deputy.com.
• The region label after it, so au in that example.
• The access token.

Every operation

These are the names the Integrations page shows beside each tick box, in the order it lists them. Generated from the connector registry; do not edit by hand.

All 15 operations

Operation	Kind	What it does
get_me	Read	Retrieve the person the token acts as: their name, their employee Id, their access level and the location they belong to.
describe_resource	Read	Retrieve one Deputy object’s field list: each field’s name and type, the objects it links to, and count, the total number of records.
list_locations	Read	List locations, which Deputy calls Company: CompanyName, Code, Active, and ParentCompany for a location inside another.
list_areas	Read	List areas of work, which Deputy calls OperationalUnit: OperationalUnitName, the Company (location) Id each belongs to, and Active.
list_employees	Read	List employees: DisplayName, FirstName, LastName, Position, the Company (location) Id they belong to, Active, StartDate and TerminationDate.
get_employee	Read	Retrieve one employee by Id, to turn the Employee number on a shift, timesheet or leave record into a name.
list_rosters	Read	List rostered shifts, the plan, not what was worked.
get_roster	Read	Retrieve one rostered shift by Id.
list_timesheets	Read	List timesheets, what was actually worked.
get_timesheet	Read	Retrieve one timesheet by Id.
list_timesheet_pay	Read	List the pay lines an approved timesheet produced, one per pay rule applied: Timesheet Id, PayRule Id, Value in hours and Cost.
list_pay_rules	Read	List pay rules: PayTitle, HourlyRate, and IsMultiplier with MultiplierValue for a penalty rate.
list_leave	Read	List leave requests: Employee Id, LeaveRule Id, DateStart and DateEnd, Start and End as Unix seconds, Days, TotalHours, AllDay, and Status as a number Deputy…
list_leave_rules	Read	List leave types: Name, Type, PaidLeave and MaxAllowedAnnually.
list_sales	Read	List sales figures pushed into Deputy from a point of sale: OperationalUnit (area) Id, Timestamp as Unix seconds, Date, SalesType, SalesQty and SalesAmount.