Employment Hero Payroll API Reference: EmploymentAgreementModel

Methods

get - Get Employment Agreement by ID

Resource

{
    "agePayRateTemplates": [
        {
            "maxAge": "int32",
            "maxAnniversaryMonths": "int32",
            "minAge": "int32",
            "minAnniversaryMonths": "int32",
            "payRateTemplate": {
                "externalId": "string",
                "id": "int32",
                "maximumQuarterlySuperContributionsBase": "double",
                "name": "string",
                "payCategories": [
                    {
                        "calculatedRate": "double",
                        "payCategoryId": "int32",
                        "standardWeeklyHours": "double",
                        "superRate": "double",
                        "userSuppliedRate": "double"
                    }
                ],
                "primaryPayCategoryId": "int32",
                "reapplyToLinkedEmployees": "boolean",
                "source": "string",
                "superThresholdAmount": "double"
            },
            "payRateTemplateId": "int32"
        }
    ],
    "classification": "string",
    "employmentType": "string",
    "externalId": "string",
    "id": "int32",
    "leaveAllowanceTemplateIds": [
        "int32"
    ],
    "leaveAllowanceTemplates": [
        {
            "externalId": "string",
            "id": "int32",
            "leaveAccrualStartDateType": "string",
            "leaveCategories": [
                {
                    "canApplyForLeave": "boolean",
                    "contingentPeriod": "double",
                    "entitlementPeriod": "double",
                    "leaveAccrualRuleAccrualType": "string",
                    "leaveAccrualRuleAccrueInAdvance": "boolean",
                    "leaveAccrualRuleCapType": "string",
                    "leaveAccrualRuleCarryOverAmount": "double",
                    "leaveAccrualRuleCarryOverBehaviour": "string",
                    "leaveAccrualRuleId": "int32",
                    "leaveAccrualRuleUnitCap": "double",
                    "leaveCategoryId": "int32",
                    "leaveLoading": "double",
                    "unitType": "string",
                    "units": "double"
                }
            ],
            "leaveLoadingCalculatedFromPayCategoryId": "int32",
            "leaveYearStart": "date-time",
            "name": "string",
            "source": "string"
        }
    ],
    "payConditionRuleSet": {
        "dayOfMonthEnding": "int32",
        "dayOfWeekEnding": "int32",
        "description": "string",
        "disabledRules": [
            "string"
        ],
        "id": "int32",
        "name": "string",
        "periodEnding": "date-time",
        "periodType": "string",
        "rulesJson": "string",
        "shiftConsolidationOption": "string",
        "shiftConsolidationThreshold": "string"
    },
    "payConditionRuleSetId": "int32",
    "payRateTemplateType": "string",
    "rank": "int32",
    "source": "string"
}

Properties

Name	Type	Description
agePayRateTemplates[]	array
agePayRateTemplates[].maxAge	int32	Nullable
agePayRateTemplates[].maxAnniversaryMonths	int32	Nullable
agePayRateTemplates[].minAge	int32	Nullable
agePayRateTemplates[].minAnniversaryMonths	int32	Nullable
agePayRateTemplates[].payRateTemplate	object	PayRateTemplateModel
agePayRateTemplates[].payRateTemplate.externalId	string	String
agePayRateTemplates[].payRateTemplate.id	int32	Int32
agePayRateTemplates[].payRateTemplate.maximumQuarterlySuperContributionsBase	double	Nullable
agePayRateTemplates[].payRateTemplate.name	string	String
agePayRateTemplates[].payRateTemplate.payCategories[]	array
agePayRateTemplates[].payRateTemplate.payCategories[].calculatedRate	double	Decimal
agePayRateTemplates[].payRateTemplate.payCategories[].payCategoryId	int32	Int32
agePayRateTemplates[].payRateTemplate.payCategories[].standardWeeklyHours	double	Decimal
agePayRateTemplates[].payRateTemplate.payCategories[].superRate	double	Nullable
agePayRateTemplates[].payRateTemplate.payCategories[].userSuppliedRate	double	Decimal
agePayRateTemplates[].payRateTemplate.primaryPayCategoryId	int32	Int32
agePayRateTemplates[].payRateTemplate.reapplyToLinkedEmployees	boolean	Boolean
agePayRateTemplates[].payRateTemplate.source	string	String
agePayRateTemplates[].payRateTemplate.superThresholdAmount	double	Nullable
agePayRateTemplates[].payRateTemplateId	int32	Nullable
classification	string	String
employmentType	string	EmploymentTypeEnum Possible values are: `Unknown` `FullTime` `PartTime` `LabourHire` `SuperannuationIncomeStream` `Casual` `NotApplicable` `IndependentContractor` `Management` `Contract` `Intern` `Other`
externalId	string	String
id	int32	Int32
leaveAllowanceTemplateIds[]	array of int32
leaveAllowanceTemplates[]	array
leaveAllowanceTemplates[].externalId	string	String
leaveAllowanceTemplates[].id	int32	Int32
leaveAllowanceTemplates[].leaveAccrualStartDateType	string	Nullable Possible values are: `EmployeeStartDate` `SpecifiedDate` `CalendarYear` `CategorySpecificDate`
leaveAllowanceTemplates[].leaveCategories[]	array
leaveAllowanceTemplates[].leaveCategories[].canApplyForLeave	boolean	Boolean
leaveAllowanceTemplates[].leaveCategories[].contingentPeriod	double	Nullable
leaveAllowanceTemplates[].leaveCategories[].entitlementPeriod	double	Nullable
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleAccrualType	string	LeaveAccrualType Possible values are: `Ongoing` `Yearly` `BasedOnLengthOfService`
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleAccrueInAdvance	boolean	Boolean
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleCapType	string	LeaveAccrualCapType Possible values are: `NotLimited` `Limited`
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleCarryOverAmount	double	Decimal
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleCarryOverBehaviour	string	LeaveAccrualCarryOverBehaviour Possible values are: `CarryEntireAmount` `CarryHours`
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleId	int32	Int32
leaveAllowanceTemplates[].leaveCategories[].leaveAccrualRuleUnitCap	double	Decimal
leaveAllowanceTemplates[].leaveCategories[].leaveCategoryId	int32	Int32
leaveAllowanceTemplates[].leaveCategories[].leaveLoading	double	Nullable
leaveAllowanceTemplates[].leaveCategories[].unitType	string	Nullable Possible values are: `Days` `Weeks` `HoursPerHourWorked` `HoursPerPayRun` `StandardDays` `StandardWeeks` `DayPerCalendarDay` `DayPerMonth`
leaveAllowanceTemplates[].leaveCategories[].units	double	Nullable
leaveAllowanceTemplates[].leaveLoadingCalculatedFromPayCategoryId	int32	Nullable
leaveAllowanceTemplates[].leaveYearStart	date-time	Nullable
leaveAllowanceTemplates[].name	string	String
leaveAllowanceTemplates[].source	string	ExternalService Possible values are: `None` `Saasu` `Xero` `MYOB` `Deputy` `EmployeeTimePunch` `ClickSuper` `IntegratedTimesheets` `FileImport` `FileExport` `QuickBooks` `Harmony` `AwardStore` `Attache` `IntegratedRostering` `ReckonAccounts` `API` `MicroPower` `RosterLive` `NetSuite` `Kounta` `TimeAndAttendanceKiosk` `DetailedFileExport` `JonasPremier` `WageEasy` `Maestrano` `WorkZone` `EmployeePortal` `RosterTemplate` `Onboarding` `Admin` `WorkZoneClockOnOff` `NetSuiteOneWorld` `Sage50` `PensionSync` `FinancialsOffice` `ProntoXI` `PayRunDefault` `StandardWorkDay` `Beam` `PayRunAutomation` `BureauDashboard` `Wiise` `QBOMigrationTool` `AbridgedFileImport` `QBOForcedMigration` `HmrcDpsUpdate` `HmrcDpsStudentLoan` `HmrcDpsPostGradLoan` `Sage50FileImporter` `FPSFileImporter` `OAuth` `FreshBooks` `StarFileImporter` `ActiveCampaign` `SummaryAndDetailsExport` `Telleroo` `EmployeeAdvancedHoursUpload` `BusinessCentral` `Paytron` `AccessFinancials` `Comma` `Zoho` `FlatFileEmployeeImporter` `Twinfield` `SageAccounting` `Square` `Quickfile` `Tide` `TideSso` `FreeAgent` `Akahu` `InstaPay` `Zepto` `Slack` `Caxton` `QuickbooksStandalonePayroll` `ImportEmployeeSelfSetup` `XeroIdentityPayrollSignUp` `XeroIdentityHrSignUp` `SageIntacct` `InstaPayDaily`
payConditionRuleSet	object	PayConditionRuleSetModel
payConditionRuleSet.dayOfMonthEnding	int32	Nullable
payConditionRuleSet.dayOfWeekEnding	int32	Nullable
payConditionRuleSet.description	string	String
payConditionRuleSet.disabledRules[]	array of string
payConditionRuleSet.id	int32	Int32
payConditionRuleSet.name	string	String
payConditionRuleSet.periodEnding	date-time	Nullable
payConditionRuleSet.periodType	string	RuleSetPeriodType Possible values are: `Weekly` `Fortnightly` `Monthly` `CalendarMonth` `FourWeekly` `SixWeekly` `ThreeWeekly` `EightWeekly`
payConditionRuleSet.rulesJson	string	String
payConditionRuleSet.shiftConsolidationOption	string	Nullable Possible values are: `None` `Duration` `SameDay`
payConditionRuleSet.shiftConsolidationThreshold	string	Nullable
payConditionRuleSetId	int32	Nullable
payRateTemplateType	string	PayRateTemplateTypeEnum Possible values are: `DateOfBirth` `Anniversary` `AnniversaryInMonths` `DateOfBirthAndAnniversaryInMonths`
rank	int32	Int32
source	string	ExternalService Possible values are: `None` `Saasu` `Xero` `MYOB` `Deputy` `EmployeeTimePunch` `ClickSuper` `IntegratedTimesheets` `FileImport` `FileExport` `QuickBooks` `Harmony` `AwardStore` `Attache` `IntegratedRostering` `ReckonAccounts` `API` `MicroPower` `RosterLive` `NetSuite` `Kounta` `TimeAndAttendanceKiosk` `DetailedFileExport` `JonasPremier` `WageEasy` `Maestrano` `WorkZone` `EmployeePortal` `RosterTemplate` `Onboarding` `Admin` `WorkZoneClockOnOff` `NetSuiteOneWorld` `Sage50` `PensionSync` `FinancialsOffice` `ProntoXI` `PayRunDefault` `StandardWorkDay` `Beam` `PayRunAutomation` `BureauDashboard` `Wiise` `QBOMigrationTool` `AbridgedFileImport` `QBOForcedMigration` `HmrcDpsUpdate` `HmrcDpsStudentLoan` `HmrcDpsPostGradLoan` `Sage50FileImporter` `FPSFileImporter` `OAuth` `FreshBooks` `StarFileImporter` `ActiveCampaign` `SummaryAndDetailsExport` `Telleroo` `EmployeeAdvancedHoursUpload` `BusinessCentral` `Paytron` `AccessFinancials` `Comma` `Zoho` `FlatFileEmployeeImporter` `Twinfield` `SageAccounting` `Square` `Quickfile` `Tide` `TideSso` `FreeAgent` `Akahu` `InstaPay` `Zepto` `Slack` `Caxton` `QuickbooksStandalonePayroll` `ImportEmployeeSelfSetup` `XeroIdentityPayrollSignUp` `XeroIdentityHrSignUp` `SageIntacct` `InstaPayDaily`

EmploymentAgreementModel resource

Methods

Resource

Properties