Pulling data from the Employment Hero Payroll (Keypay) 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 Payroll (Keypay) 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.
Documentation: https://api.keypay.com.au/australia/reference/chart-of-accounts/au-chart-of-accounts--get
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
LocationID | long | Location → ID |
|
IsDefaultBusinessSettings | boolean | - |
|
DefaultExpenseAccountID | long | JournalAccount → ID | - |
DefaultLiabilityAccountID | long | JournalAccount → ID | - |
EmployeeExpenseAccountID | long | JournalAccount → ID | - |
EmployerLiabilityExpenseAccountID | long | JournalAccount → ID | - |
EmployerLiabilityLiabilityAccountID | long | JournalAccount → ID | - |
PaygExpenseAccountID | long | JournalAccount → ID | - |
PaygLiabilityAccountID | long | JournalAccount → ID | - |
PaymentAccountID | long | JournalAccount → ID | - |
SuperannuationExpenseAccountID | long | JournalAccount → ID | - |
SuperannuationLiabilityAccountID | long | JournalAccount → ID | - |
Documentation: https://api.keypay.com.au/australia/reference/deduction-categories/au-deduction-category--get-deduction-categories
Documentation: https://api.keypay.com.au/new-zealand/reference/employee/nz-employee--get-employees
Documentation: https://api.keypay.com.au/australia/reference/employee-expense-categories/employee-expense-category--get-employee-expense-categories
Documentation: https://api.keypay.com.au/new-zealand/reference/employee-leave-allowances/nz-employee-leave-allowances--get
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
EmployeeRemoteID | string | Employee → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
EmployeeID | long | Employee → ID | - |
AutomaticallyAccrues | boolean | - | - |
CanApplyForLeave | boolean | - | - |
HoursPerYear | decimal | - | - |
LeaveCategoryID | long | - |
|
LeaveUnitType | string | - | - |
UnitType | string | - | - |
Units | decimal | - | - |
LeaveAccrualRuleID | long | - | - |
RuleAccrualType | string | - | - |
RuleAccrueInAdvance | boolean | - | - |
RuleCapType | string | - | - |
RuleCarryOverAmount | decimal | - | - |
RuleCarryOverBehaviour | string | - | - |
RuleLeaveYearOffsetAmount | string | - | - |
RuleUnitCap | decimal | - | - |
Documentation: https://api.keypay.com.au/new-zealand/reference/invoices/invoice--get-business-invoices
Documentation: https://api.keypay.com.au/new-zealand/reference/chart-of-accounts/accounts--get
Documentation: https://api.keypay.com.au/australia/reference/leave-categories/au-leave-category--get-leave-categories
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Name | string | - | - |
AccruesFirstPayRunPerPeriodOnly | boolean | - | - |
AutomaticallyAccrues | boolean | - | - |
ContingentPeriod | decimal | - | - |
DeductFromPayCategoryID | long | PayCategory → ID | - |
DeductFromPrimaryPayCategory | boolean | - | - |
EntitlementPeriod | decimal | - | - |
ExcludeFromTerminationPayout | boolean | - | - |
ExternalID | string | - | - |
HideAccrualsOnPayslip | boolean | - | - |
IsBalanceUntracked | boolean | - | - |
IsNamePrivate | boolean | - | - |
IsPrivate | boolean | - | - |
LeaveCategoryType | string | - | - |
LeaveLoading | decimal | - | - |
LeaveUnitType | string | - | - |
PayoutAsETP | boolean | - | - |
PreventNegativeBalanceUnpaidLeaveCategoryID | long | - | - |
Source | string | - | - |
TransferOnTerminationToPayCategoryID | long | PayCategory → ID | - |
TransferToPayCategoryID | long | PayCategory → ID | - |
UnitType | string | - | - |
Units | decimal | - | - |
UseDeductFromPayCategoryRate | boolean | - | - |
LeaveAccrualRuleID | long | - | - |
Documentation: https://api.keypay.com.au/australia/reference/leave-requests/au-business-hours-leave-request--list-leave-requests
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
AttachmentID | long | - | - |
EmployeeID | long | Employee → ID | - |
FromDate | datetime | - | - |
ToDate | datetime | - | - |
HoursApplied | decimal | - | - |
LeaveCategoryID | long | LeaveCategory → ID | - |
Notes | string | - | - |
Status | string | - | - |
TotalHours | decimal | - | - |
Documentation: https://api.keypay.com.au/new-zealand/reference/location/nz-location--get-locations
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Name | string | - | - |
Country | string | - | - |
ExternalAccountingLocationID | string | - | - |
ExternalID | string | - | - |
FullyQualifiedName | string | - | - |
GeneralLedgerMappingCode | string | - | - |
IsGlobal | boolean | - | - |
IsRollupReportingLocation | boolean | - | - |
ParentID | long | Location → ID | - |
Source | string | - | - |
State | string | - | - |
Documentation: https://api.keypay.com.au/australia/reference/pay-category/au-pay-category--get-pay-categories
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Name | string | - | - |
AccruesLeave | boolean | - | - |
AllowanceDescription | string | - | - |
AwardID | long | - | - |
DefaultSuperRate | decimal | - | - |
ExternalID | string | - | - |
GeneralLedgerMappingCode | string | - | - |
HideUnitsOnPaySlip | boolean | - | - |
IsPayrollTaxExempt | boolean | - | - |
IsPrimary | boolean | - | - |
IsSystemPayCategory | boolean | - | - |
IsTaxExempt | boolean | - | - |
NumberOfDecimalPlaces | long | - | - |
ParentID | long | PayCategory → ID | - |
PayCategoryType | string | - | - |
PaymentSummaryClassification | string | - | - |
PenaltyLoadingPercent | decimal | - | - |
RateLoadingPercent | decimal | - | - |
RateUnit | string | - | - |
RoundingMethod | string | - | - |
Source | string | - | - |
SuperExpenseMappingCode | string | - | - |
SuperLiabilityMappingCode | string | - | - |
Documentation: https://api.keypay.com.au/australia/reference/employee/au-employee-pay-rates--get
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
EmployeeRemoteID | string | Employee → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
EmployeeID | long | Employee → ID | - |
AccruesLeave | boolean | - | - |
CalculatedRate | decimal | - | - |
IsPrimaryPayCategory | boolean | - | - |
PayCategoryID | long | PayCategory → ID | - |
Rate | decimal | - | - |
RateUnit | string | - | - |
HasSuperRateOverride | boolean | - |
|
SuperRate | decimal | - |
|
Documentation: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run--get
Documentation: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run--payments
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
PayRunRemoteID | string | PayRun → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
EmployeeID | long | Employee → ID | - |
PayRunID | long | PayRun → ID | - |
GrossEarnings | decimal | - | - |
IsPublished | boolean | - | - |
NetEarnings | decimal | - | - |
Notation | string | - | - |
PostTaxDeductions | decimal | - | - |
PreTaxDeductions | decimal | - | - |
TaxableEarnings | decimal | - | - |
TotalEmployeeExpenses | decimal | - | - |
TotalEmployerLiabilities | decimal | - | - |
TotalHours | decimal | - | - |
AccLevyAmount | decimal | - | - |
EsctContribution | decimal | - | - |
KiwiSaverEmployeeContribution | decimal | - | - |
KiwiSaverEmployerContribution | decimal | - | - |
PayeWithheld | decimal | - | - |
StudentLoanAdditionalMandatoryAmount | decimal | - | - |
StudentLoanAdditionalVoluntaryAmount | decimal | - | - |
StudentLoanAmount | decimal | - | - |
HelpWithheld | decimal | - | - |
PaygWithheld | decimal | - | - |
SfssWithheld | decimal | - | - |
SuperContribution | decimal | - | - |
Documentation: https://api.keypay.com.au/australia/reference/qualifications/qualification--get-qualifications?v=latest
Documentation: https://api.keypay.com/new-zealand/resources/rostershiftrole?v=latest
Documentation: https://api.keypay.com.au/australia/reference/roster-shifts/au-roster-shift--get?v=latest
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Description | string | - | - |
IsDifferent | boolean | - | - |
Token | string | - | - |
EmployeeID | long | Employee → ID | - |
LocationID | long | Location → ID | - |
WorkTypeID | long | WorkType → ID | - |
StartTime | datetime | - | - |
EndTime | datetime | - | - |
Notes | string | - | - |
Published | boolean | - | - |
Accepted | boolean | - | - |
DatePublished | datetime | - | - |
Biddable | boolean | - | - |
ShiftSwapCutoffTime | datetime | - | - |
ShiftAssignmentStatus | string | - | - |
ClassificationID | long | - | - |
PendingSwapID | long | - | - |
RoleID | long | Role → ID | - |
Documentation: https://api.keypay.com.au/new-zealand/reference/timesheets/nz-timesheet--get
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
AttachmentID | long | - | - |
Comments | string | - | - |
EmployeeID | long | Employee → ID | - |
StartTime | datetime | - | - |
EndTime | datetime | - | - |
ExternalID | string | - | - |
HiddenComments | string | - | - |
LeaveCategoryID | long | - | - |
LocationID | long | Location → ID | - |
PayCategoryID | long | PayCategory → ID | - |
Rate | decimal | - | - |
Source | string | - | - |
Status | string | - | - |
SubmittedByUser | string | - | - |
WorkTypeID | long | WorkType → ID | - |
Documentation: https://api.keypay.com.au/australia/reference/work-types/au-work-type--get-work-types
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Name | string | - | - |
AccruesLeave | boolean | - | - |
AwardPackageID | long | - | - |
ExternalID | string | - | - |
LeaveCategoryID | long | - | - |
MappingType | string | - | - |
PayCategoryID | long | PayCategory → ID | - |
ShortCode | string | - | - |
Source | string | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
AccountSettingRemoteID | string | AccountSetting → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
CategoryType | string | - | - |
ExpenseAccountID | long | JournalAccount → ID |
|
LiabilityAccountID | long | JournalAccount → ID |
|
AccrueFromContingentPeriod | boolean | - |
|
DeductionCategoryID | long | DeductionCategory → ID | - |
EmployeeExpenseCategoryID | long | EmployeeExpenseCategory → ID | - |
PayCategoryID | long | PayCategory → ID | - |
LeaveCategoryID | long | LeaveCategory → ID | - |
EmployerLiabilityCategoryID | long | EmployerLiabilityCategory → ID | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
EmployeeRemoteID | string | Employee → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
EmployeeID | long | Employee → ID | - |
LocationID | long | Location → ID | - |
IsPrimaryLocation | boolean | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
InvoiceRemoteID | string | Invoice → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
Description | string | - | - |
InvoiceID | long | Invoice → ID | - |
LineNumber | int | - | - |
Abn | string | - | - |
BillingPlan | string | - | - |
BrandName | string | - | - |
BusinessNumber | string | - | - |
Quantity | decimal | - | - |
TotalIncludingGst | decimal | - | - |
UnitPriceIncludingGst | decimal | - | - |
WhiteLabelName | string | - | - |
DetailedDescription | string | - | - |
GroupName | string | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
RosterShiftRemoteID | string | RosterShift → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
RosterID | long | RosterShift → ID | - |
StartTime | datetime | - | - |
EndTime | datetime | - | - |
IsPaidBreak | boolean | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
RosterShiftRemoteID | string | RosterShift → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
RosterID | long | RosterShift → ID | - |
OpportunityID | long | - |
|
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
TimesheetRemoteID | string | Timesheet → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
TimesheetID | long | Timesheet → ID | - |
EndTime | datetime | - | - |
IsPaidBreak | boolean | - | - |
StartTime | datetime | - | - |
Column | Type | Relates to | Notes |
---|---|---|---|
RemoteID | string | - | - |
TimesheetRemoteID | string | Timesheet → RemoteID | - |
WhenUpsertedIntoDataStore | datetime | - | - |
MirrorRemoteID | int | - | - |
IsDeleted | boolean | - | - |
WhenCreated | datetime | - | - |
WhenModified | datetime | - | - |
ID | long | - | - |
Name | string | - | - |
TimesheetID | long | Timesheet → ID | - |
ReportingDimensionID | long | - | - |
SyncHub lives and breathes APIs and data. Keep exploring using the links below.