Explore the Employment Hero HR API data model

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

Try our interactive ERD Or, browse below

Pulling data from the Employment Hero HR 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 Employment Hero HR 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.

Endpoints

Certification

Documentation: https://developer.employmenthero.com/api-references/#get-all-certification

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

CostCenter

Documentation: https://developer.employmenthero.com/api-references/#get-employees

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

CustomField

Documentation: https://secure.employmenthero.com/app/v2/organisations/372226/custom_fields

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
Name string - -
Description string - -
Hint string - -
Type string - -
InOnboarding boolean - -
Required boolean - -

Employee

Documentation: https://developer.employmenthero.com/api-references/#get-employees

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
AccountEmail string - -
Title string - -
Role string - -
FirstName string - -
LastName string - -
MiddleName 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 - -
TerminationSummary string - -
TerminationReason string - -
PrimaryCostCenterID guid CostCenter → ID -
PrimaryManagerID guid Employee → ID -
SecondaryManagerID guid Employee → ID -
Address string - -

EmployeeBankAccount

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 - -

EmployeeCostCenter

Documentation: https://developer.employmenthero.com/api-references/#get-employees

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CostCenterID guid CostCenter → ID -
EmployeeID guid Employee → ID -

EmployeeCustomField

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

EmployeeEmergencyContact

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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 - -
CreatedAt datetime - -
UpdatedAt datetime - -
PayrunID guid - -
TotalHours decimal - -
TaxableEarnings decimal - -
Currency string - -
CountryCode string - -
ReviewUrl string - -
YtdSfss decimal - -
YtdHelp decimal - -
HelpAmount decimal - -
YtdGross decimal - -
YtdNet decimal - -
YtdPayg decimal - -
YtdSuper decimal - -
YtdTaxableEarnings decimal - -
YtdPreTaxDeduction decimal - -
YtdPostTaxDeduction decimal - -
PdfUrl string - -
KeypayBasePayRate string - -
TotalPay decimal - -
YtdDeductions decimal - -
YtdTax decimal - -

EmployeeSuperannuation

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
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 -
WhenUpsertedIntoDataStore datetime - -
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

Documentation: https://developer.employmenthero.com/api-references/#get-timesheet-entries

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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 - -

EmployeeWorkEligibility

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
EmployeeID guid Employee → ID -
IsOceanicResident boolean - -
WorkEligibilityAcknowledged boolean - -
VisaVerified boolean - -
VisaStatus string - -
PassportStatus string - -
VisaType string - -
VisaComment string - -
VisaExpiryDate datetime - -
VisaStartDate datetime - -
PassportNumber string - -
PassportExpiryDate datetime - -
PassportIssueCountry string - -

LeaveRequest

Documentation: https://developer.employmenthero.com/api-references/#get-leave-requests

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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

Documentation: https://developer.employmenthero.com/api-references/#get-all-organisations

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
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

Documentation: https://developer.employmenthero.com/api-references/#get-policies

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

Team

Documentation: https://developer.employmenthero.com/api-references/#get-all-team

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

CustomFieldPermission

Column Type Relates to Notes
RemoteID string - -
CustomFieldRemoteID string CustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
CustomFieldID guid CustomField → ID -
Permission string - -
Role string - -

CustomFieldOption

Column Type Relates to Notes
RemoteID string - -
CustomFieldRemoteID string CustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid - -
CustomFieldID guid CustomField → ID -
Value string - -

AddressDetails

Column Type Relates to Notes
RemoteID string - -
EmployeeRemoteID string Employee → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeID guid Employee → ID -
AddressType string - -
Line1 string - -
Line2 string - -
Line3 string - -
BlockNumber string - -
LevelNumber string - -
UnitNumber string - -
City string - -
Postcode string - -
State string - -
Suburb string - -
Country string - -
IsResidential string - -
StreetName string - -
IsManuallyEntered string - -

EmployeeCustomFieldValue

Column Type Relates to Notes
RemoteID string - -
EmployeeCustomFieldRemoteID string EmployeeCustomField → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID guid CustomFieldOption → ID
  • 24 Jul 2024 There is no id field if we are dealing with a free text custom field, so empty values here are fine. Note that if we have multiple options selected in a multi-choice type, then of course this will be a different id for each of the choices
EmployeeCustomFieldID guid EmployeeCustomField → ID -
Value string - -

PayslipEarningsLine

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
PayCategoryName string - -
Notes string - -
NumberOfUnits decimal - -
RatePerUnit decimal - -
GrossEarnings decimal - -
SuperContribution decimal - -
TaxableEarnings decimal - -
IsFixed boolean - -
IsTaxExempt boolean - -

PayslipSuperannuationLine

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
ContributionType string - -
FundName string - -
MemberNumber string - -
Amount decimal - -
PaymentDateForThisPeriod datetime - -

PayslipDisplayedLeaveBalance

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
LeaveCategoryName string - -
UnitType string - -
Amount decimal - -

PayslipTakenLeave

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
LeaveCategoryName string - -
Notes string - -
UnitType string - -
Amount decimal - -

PayslipDisplayedAccruedLeave

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
LeaveCategoryName string - -
UnitType string - -
Amount decimal - -

PayslipDeduction

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
IsTaxExempt boolean - -
Amount decimal - -

PayslipPAYGAdjustment

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
IsTaxExempt boolean - -
Amount decimal - -

PayslipSuperAdjustment

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
Amount decimal - -

PayslipGrossYTD

Column Type Relates to Notes
RemoteID string - -
EmployeePayslipRemoteID string EmployeePayslip → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayslipID guid EmployeePayslip → ID -
Iterator int - -
PayCategoryName string - -
Amount decimal - -
CreatedAt datetime - -
UpdatedAt datetime - -

EmployeeWorkEligibilityDocument

Column Type Relates to Notes
RemoteID string - -
EmployeeWorkEligibilityRemoteID string EmployeeWorkEligibility → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
EmployeeWorkEligibilityID guid EmployeeWorkEligibility → ID -
Filename string - -
Url string - -
CreatedAt datetime - -

EmployeeWorkEligibilityVevoCheck

Column Type Relates to Notes
RemoteID string - -
EmployeeWorkEligibilityRemoteID string EmployeeWorkEligibility → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
EmployeeWorkEligibilityID guid EmployeeWorkEligibility → ID -
Iterator long - -
ErrorMessage string - -
Error string - -
Status string - -
Date datetime - -
VisaClassSubclass string - -
VisaStream string - -
VisaApplicant string - -
VisaGrantDate string - -
VisaExpiryDate string - -
WorkEntitlements string - -
VisaValidAt string - -
VisaCondition string - -

TeamEmployee

Column Type Relates to Notes
RemoteID string - -
TeamRemoteID string Team → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TeamID guid Team → ID -
EmployeeID guid Employee → ID -

Need more?

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

Connect your own Employment Hero HR data Querying Employment Hero HR using regular SQL