Explore the Deputy API data model

Pulling data from the Deputy API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SYNCHUB, we not only sync your Deputy API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Browse the data model below, or if you'd prefer, we also have an interactive ERD over here.

Address

Documentation: https://developer.deputy.com/reference/getaddresses

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
ContactName	string	-	-
UnitNo	string	-	-
StreetNo	string	-	-
SuiteNo	string	-	-
PoBox	string	-	-
Street1	string	-	-
Street2	string	-	-
City	string	-	-
State	string	-	-
Postcode	string	-	-
Country	int	-	-
Phone	string	-	-
Notes	string	-	-
Format	int	-	-
Saved	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Contact

Documentation: https://developer.deputy.com/reference/getcontactobjectinfo

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Phone1	string	-	-
Phone2	string	-	-
Phone3	string	-	-
Fax	string	-	-
Phone1Type	string	-	-
Phone2Type	string	-	-
Phone3Type	string	-	-
PrimaryPhone	int	-	-
Email1	string	-	-
Email1Type	string	-	-
Email2Type	string	-	-
Email2	string	-	-
PrimaryEmail	int	-	-
Im1	string	-	-
Im2	string	-	-
Im1Type	string	-	-
Im2Type	string	-	-
Web	string	-	-
Saved	boolean	-	-
Mobile	string	-	-
Email	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

CustomField

Documentation: https://developer.deputy.com/reference/getcustomfields

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
System	string	-	-
ApiName	string	-	-
DeputyField	string	-	-
SortOrder	int	-	-
Default	string	-	-
Type	int	-	-
Published	int	-	-
TriggerScript	int	-	-
Helptext	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

CustomFieldResponse

Documentation: https://developer.deputy.com/docs/customfielddata

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
System	string	-	-
F01	string	-	-
F02	string	-	-
F03	string	-	-
F04	string	-	-
F05	string	-	-
F06	string	-	-
F07	string	-	-
F08	string	-	-
F09	string	-	-
F10	string	-	-
F11	string	-	-
F12	string	-	-
F13	string	-	-
F14	string	-	-
F15	string	-	-
F16	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

CategoryDetails

Documentation: https://developer.deputy.com/reference/getcategories

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Category	string	-	-
Group	string	-	-
SortOrder	int	-	-
Stafflog	boolean	-	-
System	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Employee

Documentation: https://developer.deputy.com/reference/searchforanemployee

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Company	int	Location → ID	-
FirstName	string	-	-
LastName	string	-	-
DisplayName	string	-	-
OtherName	string	-	-
Salutation	string	-	-
MainAddress	int	Address → ID	-
PostalAddress	int	Address → ID	-
Contact	int	Contact → ID	-
EmergencyAddress	int	Address → ID	-
DateOfBirth	datetime	-	-
Gender	int	-	-
Photo	int	-	-
UserID	int	-	-
JobAppID	int	-	-
Active	boolean	-	-
StartDate	datetime	-	-
TerminationDate	datetime	-	-
StressProfile	int	-	12 May 2020 Foreign Key: Refers to `StressProfile` (not implemented).
Position	string	-	-
HigherDuty	boolean	-	-
Role	int	-	12 May 2020 Foreign Key: Refers to `EmployeeRole` (not implemented).
AllowAppraisal	boolean	-	-
HistoryID	int	-	12 May 2020 Foreign Key: Refers to `EmployeeHistory` (not implemented).
CustomFieldData	int	CustomField → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeAgreement

Documentation: https://developer.deputy.com/reference/getemployeeagreements

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
EmployeeID	int	Employee → ID	-
PayPoint	int	-	-
EmpType	int	-	-
CompanyName	string	-	-
Active	boolean	-	-
StartDate	datetime	-	-
EndDate	datetime	-	-
Contract	int	-	-
SalaryPayRule	int	-	-
ContractFile	int	-	-
PayrollID	string	-	-
PayPeriod	int	-	-
HistoryID	int	EmployeeAgreementHistory → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeAgreementHistory

Documentation: https://developer.deputy.com/reference/getemployeeagreementhistory

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
AgreementID	int	EmployeeAgreement → ID	-
PayPoint	int	-	-
EmpType	int	-	-
CompanyName	string	-	-
Active	boolean	-	-
StartDate	datetime	-	-
Contract	int	-	-
SalaryPayRule	int	PayRule → ID	-
ContractFile	int	-	-
PayrollID	string	-	-
PayPeriod	int	PayPeriod → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeAppraisal

Documentation: https://developer.deputy.com/reference/getemployeeappraisals

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Employee	int	Employee → ID	-
DayTimestamp	long	-	-
WhenDayTimestamp	datetime	-	-
Date	datetime	-	-
Mark01	decimal	-	-
Mark02	decimal	-	-
Mark03	decimal	-	-
Mark04	decimal	-	-
Mark05	decimal	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeAvailability

Documentation: https://developer.deputy.com/reference/getemployeeavailability

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Employee	int	Employee → ID	-
Type	int	-	11 May 2020 Type=0 is a one-off and type=1 is recurring
MaxDateRecurringGenerated	datetime	-	-
StartTime	long	-	-
EndTime	long	-	-
Date	datetime	-	-
Comment	string	-	-
Schedule	int	Schedule → ID	-
StartTimeLocalized	datetime	-	-
EndTimeLocalized	datetime	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeRole

Documentation: https://developer.deputy.com/reference/searchforanemployeerole

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Role	string	-	-
Ranking	int	-	-
Require2fa	boolean	-	-
ReportTo	int	Employee → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmployeeSentiment

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
Date	datetime	-	-
Index	int	-	-
Score	string	-	-
Comment	string	-	-
Emoji	string	-	-
LocationID	int	Location → ID	-

EmployeeWorkplace

Documentation: https://developer.deputy.com/reference/getemployeeworkplaces

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
EmployeeID	int	Employee → ID	-
Company	int	Location → ID	-
SortOrder	int	-	-
Agreement1	int	EmployeeAgreement → ID	-
Agreement2	int	EmployeeAgreement → ID	-
Agreement3	int	EmployeeAgreement → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmploymentCondition

Documentation: https://developer.deputy.com/reference/getemploymentconditions

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
Description	string	-	-
AwardLevel	string	-	-
EmploymentBasis	int	-	-
EmploymentCategory	int	-	-
EmploymentPeriod	int	-	-
EmploymentStatus	int	-	-
ProbationaryPeriod	int	-	-
WorkingDaysPerPeriod	decimal	-	-
UsualStartTime	datetime	-	-
UsualFinishTime	datetime	-	-
UsualMealbreak	datetime	-	-
AvgHoursPerDay	decimal	-	-
MinHoursPerDay	decimal	-	-
MinHoursForLeave	decimal	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmploymentContract

Documentation: https://developer.deputy.com/reference/searchforanemploymentcontract

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
Description	string	-	-
Code	string	-	-
EmploymentBasis	int	-	-
EmploymentCategory	int	-	-
EmploymentStatus	int	-	-
EmploymentCondition	int	-	-
BasePayRule	int	-	-
StressProfile	int	-	-
StartDate	datetime	-	-
EndDate	datetime	-	-
PeriodType	int	-	-
File	int	-	-
StrictLeaveApproval	boolean	-	-
Award	string	-	-
EmploymentSubType	string	-	-
AwardStartDate	datetime	-	-
PpID	string	-	-
CountryID	int	-	-
IsSalaryContract	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

EmploymentContractLeaveRule

Documentation: https://developer.deputy.com/reference/searchforemploymentcontractleaverules

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
ContractID	int	EmploymentContract → ID	-
LeaveRuleID	int	-	-
BasePayRule	string	-	-
LoadingPayRule1	int	-	-
LoadingPayRule2	int	-	-
LoadingPayRule3	int	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Event

Documentation: https://developer.deputy.com/reference/getevents

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Title	string	-	-
Schedule	int	Schedule → ID	-
Colour	string	-	-
ShowOnRoster	boolean	-	-
BlockTimeOff	boolean	-	-
AddToBudget	decimal	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Geo

Documentation: https://developer.deputy.com/docs/geo

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Latitude	decimal	-	-
Longitude	decimal	-	-
RecID	decimal	-	-
Orm	string	-	-
No	string	-	16 Dec 2021 The street number
Street	string	-	-
State	string	-	-
Postcode	string	-	-
Country	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Kiosk

Documentation: https://developer.deputy.com/docs/kiosk

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
Company	int	Location → ID	-
ConnectionMode	int	-	-
SubnetRestriction	string	-	-
AuthenticationMode	int	-	-
UseBiometric	boolean	-	-
LastActivity	string	-	-
IpAddress	string	-	-
EnableMultiLocations	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Leave

Documentation: https://developer.deputy.com/docs/leave

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Employee	int	Employee → ID	-
EmployeeHistory	int	-	12 May 2020 Foreign Key: Refer to `EmployeeHistory` (not implemented).
Company	int	Location → ID	-
LeaveRule	int	-	-
Start	long	-	-
DateStart	datetime	-	-
End	long	-	-
DateEnd	datetime	-	-
Days	decimal	-	-
ApproverTime	int	-	-
ApproverPay	int	-	-
Comment	string	-	-
Status	int	-	-
ApprovalComment	string	-	-
TotalHours	decimal	-	-
StartTimeLocalized	datetime	-	-
EndTimeLocalized	datetime	-	-
DateStartAllDay	boolean	-	-
DateEndAllDay	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

LeaveAccrual

Documentation: https://developer.deputy.com/docs/leave-accrual

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Employee	int	Employee → ID	-
EmployeeHistory	int	-	1 Apr 2026 Foreign Key: Refer to `EmployeeHistory` (not implemented).
TransactionDate	datetime	-	-
BalanceCalculatedAt	datetime	-	-
Creator	int	Employee → ID	-
Type	long	-	-
LeaveRule	long	-	-
Hours	decimal	-	-
Days	decimal	-	-
Comment	string	-	-
Created	datetime	-	-
Modified	datetime	-	-

LeavePayLine

Documentation: https://developer.deputy.com/docs/leave-pay-line

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
LeaveID	int	Leave → ID	-
LeaveRule	int	-	12 May 2020 Foreign Key: Refers to `LeaveRule` (not Implemented).
EmployeeAgreement	int	-	11 May 2020 Foreign Key: Refers to `EmployeeAgreement`(not Implemented)
Date	datetime	-	-
StartTime	datetime	-	-
EndTime	datetime	-	-
Hours	string	-	-
Comment	string	-	-
TimesheetID	int	Timesheet → ID	-
StartTimeLocalized	datetime	-	-
EndTimeLocalized	datetime	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

LeaveRule

Documentation: https://developer.deputy.com/docs/leave-rules

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
Description	string	-	-
SvcLeavePolicyID	string	-	-
Type	string	-	-
MaxAllowedAnnually	int	-	-
PaidLeave	boolean	-	-
AnnualRollOver	boolean	-	-
Visible	boolean	-	-
UnitType	int	-	-
ResetType	int	-	-
ResetSchedule	string	-	-
ResetValue	string	-	-
PayoutOnTermination	boolean	-	-
EntitlementAfterMonth	int	-	-
ExportType	int	-	-
PayrollCategory	string	-	-
CalcType	int	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Location

Documentation: https://developer.deputy.com/reference/getlocations

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Portfolio	int	-	-
Code	string	-	-
Active	boolean	-	-
ParentCompany	int	Location → ID	-
ParentLocation	int	-	-
CompanyName	string	-	-
TradingName	string	-	-
BusinessNumber	string	-	-
CompanyNumber	string	-	-
IsWorkplace	boolean	-	-
IsPayrollEntity	boolean	-	-
PayrollExportCode	string	-	-
Address	int	Address → ID	-
Contact	string	-	12 May 2020 `Contact here does not refer to contact id in contact endpoint.
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

LocationTimeInfo

Column	Type	Relates to	Notes
RemoteID	string	-	-
LocationRemoteID	string	Location → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
LocationID	int	Location → ID	-
Timezone	string	-	-

OperationalUnit

Documentation: https://developer.deputy.com/reference/getoperationalunits

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Company	int	Location → ID	-
ParentOperationalUnit	int	OperationalUnit → ID	-
OperationalUnitName	string	-	-
Active	boolean	-	-
PayrollExportName	string	-	-
Address	int	Address → ID	-
Contact	int	Contact → ID	-
RosterSortOrder	int	-	-
ShowOnRoster	boolean	-	-
Colour	string	-	-
RosterActiveHoursSchedule	int	Schedule → ID	-
DailyRosterBudget	decimal	-	-
OperationalUnitType	int	-	-
CompanyCode	string	-	-
CompanyName	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

PayPeriod

Documentation: https://developer.deputy.com/docs/payperiod

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
Active	boolean	-	-
StartDate	datetime	-	-
Cycle	int	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

PayRule

Documentation: https://developer.deputy.com/docs/pay-rules

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
PayTitle	string	-	-
RemunerationType	int	-	-
RemunerationBy	int	-	-
AnnualSalary	decimal	-	-
HourlyRate	decimal	-	-
IsMultiplier	boolean	-	-
MultiplierValue	boolean	-	-
MultiplierBaseRate	int	-	-
MinimumType	int	-	-
MaximumType	int	-	-
MinimumValue	boolean	-	-
MaximumValue	boolean	-	-
MinimumShiftLength	string	-	-
MaximumShiftLength	string	-	-
AdvancedCalculation	string	-	-
IsExported	boolean	-	-
UnitValue	decimal	-	-
Schedule	int	Schedule → ID	-
RecommendWith	int	-	-
DexmlScript	int	-	-
DexmlScriptParam	string	-	-
PeriodType	int	-	-
PayPortionRule	int	-	-
PayrollCategory	string	-	-
Comment	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

PublicHoliday

Documentation: https://developer.deputy.com/docs/public-holiday

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Title	string	-	-
Schedule	int	Schedule → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

SalesData

Documentation: https://developer.deputy.com/docs/sales-data

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Date	datetime	-	-
Timestamp	long	-	-
WhenTimestamp	datetime	-	-
Employee	int	Employee → ID	-
OperationalUnit	int	OperationalUnit → ID	-
SalesType	string	-	-
SalesRef	string	-	-
SalesQty	decimal	-	-
SalesAmount	decimal	-	-
SalesPayload	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Schedule

Documentation: https://developer.deputy.com/docs/schedule

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
StartDate	datetime	-	-
EndDate	datetime	-	-
StartTime	datetime	-	-
EndTime	datetime	-	-
RepeatType	int	-	-
RepeatEvery	int	-	-
WeeklyOnDays	string	-	-
MonthlyOnDates	string	-	-
MonthlyOnDays	string	-	-
Exception	string	-	-
Saved	boolean	-	-
Orm	string	-	-
Template	boolean	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Shift

Documentation: https://developer.deputy.com/docs/roster

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Date	datetime	-	-
StartTime	long	-	-
EndTime	long	-	-
WhenStart	datetime	-	-
WhenEnd	datetime	-	-
Mealbreak	datetime	-	-
TotalTime	decimal	-	-
Cost	decimal	-	-
OperationalUnit	int	OperationalUnit → ID	-
Employee	int	Employee → ID	-
Comment	string	-	-
Warning	string	-	-
WarningOverrideComment	string	-	-
Published	boolean	-	-
MatchedByTimesheet	int	Timesheet → ID	-
Open	boolean	-	-
ConfirmStatus	int	-	-
ConfirmComment	string	-	-
ConfirmBy	int	Employee → ID	-
ConfirmTime	int	-	-
SwapStatus	int	-	-
SwapManageBy	int	-	-
ShiftTemplate	int	-	-
ConnectStatus	int	-	-
OnCost	decimal	-	-
StartTimeLocalized	datetime	-	-
EndTimeLocalized	datetime	-	-
ExternalID	int	-	-
ConnectCreator	int	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

StressProfile

Documentation: https://developer.deputy.com/docs/stressprofile

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
MaxHoursPerShift	decimal	-	-
MaxHoursPerPeriod	decimal	-	-
MaxDaysPerPeriod	decimal	-	-
MaxHoursPerDay	decimal	-	-
GapHoursBetweenShifts	decimal	-	-
CustomRules	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

SystemUsageBalance

Documentation: https://developer.deputy.com/docs/systemusagebalance

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Description	string	-	-
Type	int	-	-
Date	datetime	-	-
Credit	decimal	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

SystemUsageTracking

Documentation: https://developer.deputy.com/docs/systemusagetracking

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Description	string	-	-
Date	datetime	-	-
EmpID	int	-	-
CompanyID	int	Location → ID	-
BalanceID	int	SystemUsageBalance → ID	-
UsageType	int	-	-
UsageRecordID	int	-	-
Usage	decimal	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Task

Documentation: https://developer.deputy.com/docs/task

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
TaskSetupID	int	TaskSetup → ID	-
OpUnitID	int	OperationalUnit → ID	-
GroupID	int	TaskGroup → ID	-
DayTimestamp	long	-	-
WhenDayTimestamp	datetime	-	-
Date	datetime	-	-
OrigDayTimestamp	long	-	-
WhenOrigDatTimestamp	datetime	-	-
OrigDate	datetime	-	-
AvailableAfterTimestamp	long	-	-
WhenAvailableAfterTimestamp	datetime	-	-
DueDate	datetime	-	-
DueTimestamp	long	-	-
WhenDueTimestamp	datetime	-	-
RepeatIfNotCompleted	boolean	-	-
SortOrder	int	-	-
Type	int	-	-
Question	string	-	-
Answer	string	-	-
Comment	string	-	-
UserEntry	int	-	-
UserPerformTask	int	-	-
UserResponsible	int	-	-
TsCompleted	int	-	-
Start	long	-	-
End	long	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

TaskGroup

Documentation: https://developer.deputy.com/docs/taskgroup

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
GroupSetupID	int	-	12 May 2020 Foreign Key: Refers to `TaskGroupSetup` (not implemented).
Key	string	-	-
DayTimestamp	long	-	-
WhenDayTimestamp	datetime	-	-
Date	datetime	-	-
OrigDayTimestamp	long	-	-
WhenOrigDayTimestamp	datetime	-	-
OrigDate	datetime	-	-
OpUnitID	int	OperationalUnit → ID	-
SortOrder	int	-	-
Comment	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

TaskSetup

Documentation: https://developer.deputy.com/docs/tasksetup

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
GroupID	int	TaskGroup → ID	-
Type	int	-	-
Parent	int	-	-
Question	string	-	-
Default	string	-	-
SortOrder	int	-	-
Schedule	int	Schedule → ID	-
OnYes	string	-	-
OnNo	string	-	-
RenderFunc	string	-	-
Active	boolean	-	-
AvailableAfter	string	-	-
RepeatIfNotCompleted	boolean	-	-
Time	string	-	-
Section	string	-	-
Priority	string	-	-
Helptext	string	-	-
SupercedePrev	boolean	-	-
Colour	string	-	-
OnStart	string	-	-
OnSubmit	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Team

Documentation: https://developer.deputy.com/docs/team

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Name	string	-	-
LeaderEmployee	int	Employee → ID	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

Timesheet

Documentation: https://developer.deputy.com/docs/timesheet

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Employee	int	Employee → ID	-
EmployeeHistory	int	-	-
EmployeeAgreement	int	-	11 May 2020 Foreign Key: Refers to `EmployeeAgreement` (not implemented).
Date	datetime	-	-
StartTime	int	-	-
EndTime	int	-	-
Mealbreak	datetime	-	-
TotalTime	decimal	-	-
TotalTimeInv	decimal	-	-
Cost	decimal	-	-
Roster	int	Shift → ID	-
EmployeeComment	string	-	-
SupervisorComment	string	-	-
Supervisor	int	-	-
Disputed	boolean	-	-
TimeApproved	boolean	-	-
TimeApprover	int	-	-
Discarded	boolean	-	-
ValidationFlag	int	-	-
OperationalUnit	int	OperationalUnit → ID	-
IsInProgress	boolean	-	-
IsLeave	boolean	-	-
LeaveID	int	Leave → ID	-
LeaveRule	int	-	12 May 2020 Foreign Key: Refers to `LeaveRules` (not implemented).
Invoiced	boolean	-	-
InvoiceComment	string	-	-
PayRuleApproved	boolean	-	-
Exported	boolean	-	-
StagingID	int	-	-
PayStaged	boolean	-	-
PaycycleID	int	-	12 May 2020 Foreign Key: Refers to `EmployeePaycycle` (not implemented).
File	int	-	-
CustomFieldData	int	CustomField → ID	-
RealTime	boolean	-	-
AutoProcessed	boolean	-	-
AutoRounded	boolean	-	-
AutoTimeApproved	boolean	-	-
AutoPayRuleApproved	boolean	-	-
OnCost	decimal	-	-
StartTimeLocalized	datetime	-	-
EndTimeLocalized	datetime	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

TimesheetPayReturn

Documentation: https://developer.deputy.com/docs/timesheetpayreturn

Column	Type	Relates to	Notes
RemoteID	string	-	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	-	-
Timesheet	int	Timesheet → ID	-
PayRule	int	PayRule → ID	-
Overridden	boolean	-	-
Value	decimal	-	-
Cost	decimal	-	-
OverrideComment	string	-	-
Creator	int	Employee → ID	-
Created	datetime	-	-
Modified	datetime	-	-

CustomFieldResponseValue

Column	Type	Relates to	Notes
RemoteID	string	-	-
CustomFieldResponseRemoteID	string	CustomFieldResponse → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
CustomFieldResponseID	int	CustomFieldResponse → ID	-
FieldName	string	-	-
FieldValue	string	-	-

EmployeeRolePermission

Column	Type	Relates to	Notes
RemoteID	string	-	-
EmployeeRoleRemoteID	string	EmployeeRole → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
ID	int	EmployeeRole → ID	-
Name	string	-	-
HasAccess	boolean	-	-

ShiftSlot

Column	Type	Relates to	Notes
RemoteID	string	-	-
ShiftRemoteID	string	Shift → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
BlnEmptySlot	boolean	-	-
BlnCanStartEarly	boolean	-	-
BlnCanEndEarly	boolean	-	-
BlnIsMandatory	boolean	-	-
StrType	string	-	-
IntStart	int	-	11 May 2020 The intStart is the number of seconds since the parent Roster start date
IntEnd	int	-	11 May 2020 The intEnd is the number of seconds since the parent Roster end date
IntUnixStart	long	-	22 Mar 2021 Unix Epoch Time
IntUnixEnd	long	-	22 Mar 2021 Unix Epoch Time
WhenStart	datetime	-	-
WhenEnd	datetime	-	-
StrTypeName	string	-	-
StrState	string	-	-
Shift	int	Shift → ID	-

TimesheetSlot

Column	Type	Relates to	Notes
RemoteID	string	-	-
TimesheetRemoteID	string	Timesheet → RemoteID	-
WhenUpsertedIntoDataStore	datetime	-	-
MirrorRemoteID	int	-	-
IsDeleted	boolean	-	-
WhenCreated	datetime	-	-
WhenModified	datetime	-	-
BlnEmptySlot	boolean	-	-
BlnCanStartEarly	boolean	-	-
BlnCanEndEarly	boolean	-	-
BlnIsMandatory	boolean	-	-
StrType	string	-	-
IntStart	int	-	-
IntEnd	int	-	-
IntUnixStart	long	-	-
IntUnixEnd	long	-	-
WhenStart	datetime	-	-
WhenEnd	datetime	-	-
StrTypeName	string	-	-
StrState	string	-	-
Timesheet	int	Timesheet → ID	-