Explore the Employment Hero data model

See how the various Employment Hero endpoints relate to each other, using our handy Entity Relationship Diagram.

Pulling data from Employment Hero 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 pull your Employment Hero 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.

Endpoints

Certification

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Type string - -

Employee

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
AccountEmail string - -
Title string - -
Role string - -
FirstName string - -
LastName string - -
MiddleName string - -
Address string - -
AvatarUrl string - -
KnownAs string - -
JobTitle string - -
Gender string - -
Country string - -
Nationality string - -
DateOfBirth datetime - -
MaritalStatus string - -
PersonalEmail string - -
PersonalMobileNumber string - -
HomePhone string - -
EmployingEntity string - -
Code string - -
Location string - -
CompanyEmail string - -
CompanyMobile string - -
CompanyLandline string - -
StartDate datetime - -
TerminationDate datetime - -

EmployeeBankAccount

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
EmployeeID guid Employee → ID -
AccountName string - -
AccountNumber string - -
Bsb string - -
Amount string - -
PrimaryAccount boolean - -

EmployeeCertification

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
EmployeeID guid Employee → ID -
CertificationID guid Certification → ID -
Type string - -
ExpiryDate datetime - -
CompletionDate datetime - -
DriverProblems boolean - -
DriverDetails string - -
Status string - -
Reason string - -

EmployeeEmergencyContact

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
EmployeeID guid Employee → ID -
ContactName string - -
DaytimeContactNumber string - -
AfterHoursNo string - -
AfterMobileNumber string - -
Relationship string - -
ContactType string - -

EmployeeEmploymentHistory

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
EmployeeID guid Employee → ID -
Title string - -
StartDate datetime - -
EndDate datetime - -
EmploymentType string - -

EmployeePayDetail

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
EmployeeID guid Employee → ID -
EffectiveFrom datetime - -
Classification string - -
IndustrialInstrument string - -
PayRateTemplate string - -
AnniversaryDate datetime - -
Salary decimal - -
SalaryType string - -
PayUnit string - -
PayCategory string - -
LeaveAllowanceTemplate string - -
ChangeReason string - -
Comments string - -

EmployeePayslip

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
EmployeeID guid Employee → ID -
FirstName string - -
LastName string - -
TotalDeduction decimal - -
NetPay decimal - -
Super decimal - -
Wages decimal - -
Reimbursements decimal - -
Tax decimal - -
AddressLine1 string - -
AddressLine2 string - -
Suburb string - -
Postcode string - -
AddressState string - -
Note string - -
PostTaxDeduction decimal - -
PreTaxDeduction decimal - -
BusinessName string - -
BusinessAddress string - -
BusinessAbn string - -
BaseRate decimal - -
HourlyRate decimal - -
PayPeriodStarting datetime - -
PayPeriodEnding datetime - -
BaseRateUnit string - -
EmploymentType string - -
PayrollType string - -
PaymentDate datetime - -

EmployeeSuperannuation

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID guid Employee → ID -
FundName string - -
MemberNumber string - -
ProductCode string - -
EmployerNominatedFund boolean - -
FundAbn string - -
ElectronicServiceAddress string - -
FundEmail string - -
AccountName string - -
AccountBsb string - -
AccountNumber string - -

EmployeeTaxDeclaration

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID guid Employee → ID -
FirstName string - -
LastName string - -
TaxFileNumber string - -
TaxAuResident boolean - -
TaxForeignResident boolean - -
WorkingHolidayMaker boolean - -
TaxFree boolean - -
TaxHelpDebt boolean - -
TaxFinancialSupplementDebt boolean - -

EmployeeTimesheet

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
EmployeeID guid Employee → ID -
Date datetime - -
StartTime datetime - -
EndTime datetime - -
Status string - -
Units decimal - -
Reason string - -
Comment string - -
Time long - -

LeaveRequest

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
StartDate datetime - -
EndDate datetime - -
TotalHours decimal - -
Comment string - -
Status string - -
LeaveBalanceAmount decimal - -
LeaveCategoryName string - -
Reason string - -
EmployeeID guid Employee → ID -

Organisation

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
PrimaryAddress string - -
EndOfWeek string - -
TypicalWorkDay string - -
SubscriptionPlan string - -
SuperfundName string - -
EmployeesCount int - -
ActiveEmployeesCount int - -
PendingEmplyeesCount int - -
CreatedAt datetime - -
Phone string - -
Country string - -
LogoUrl string - -
TenantID string - -

Policy

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Induction boolean - -
CreatedAt datetime - -

Team

Column Type Relates to Notes
RemoteID string - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Status string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.