Pulling data from the Employment Hero 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 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.
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | guid | - | - |
Name | string | - | - |
Type | string | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - | - |
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 | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | guid | - | - |
Name | string | - | - |
Status | string | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
TeamRemoteID | string | Team → RemoteID | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
TeamID | guid | Team → ID | - |
EmployeeID | guid | Employee → ID | - |
SyncHub lives and breathes APIs and data. Keep exploring using the links below.