GetEmployeePositions

The Employees Position & Renumeration details are retrieved for the date range entered.

If you're using EmpowerHR 2025.1.02 or later, you can now use flexible date filters when retrieving employee position data via the standard extract web service. This update introduces three new parameters:

  • FromDate: Returns positions active from a specific date
  • UptoDate: Lets you define the end of the date range
  • IncludeFutureDatedFlag: Use this option to view both current and upcoming positions without having to enter any specific dates

These enhancements allow you to:

  • Pull historical position data for audits or reporting
  • Plan ahead by retrieving future assignments

The API supports six date formats (e.g. dd/MM/yyyy, dd MMM yyyy, and ddMMMyyyy ) and includes clear error messages for invalid inputs. Existing integrations won’t break—if you don’t use the new parameters, the API behaves as it always has, returning current positions.

Below are the request restrictions available when retrieving the employee position & renumeration details returned by the EmpowerStandardExtract web service via ‘GetEmployeePositions’.


Request Element

Options

Default
Restriction/EmployeeCodes include
exclude
 
Restriction/EmployeeStatuses include
exclude
 
Restriction/NonEmployees include
exclude
include
Restriction/DeletedEmployees include
exclude
exclude
Restriction/ActingOrSubstantive a(Acting) or s(Substantive) A(Acting)

To employees retrieved can be restricted via their employee and status codes. The restriction can either be to include or exclude employees based on their employee and status codes.

To exclude non employees set the ‘Restriction/NonEmployees’ element to ‘exclude’. By default, non employees are included in the extract.

Below is an example where employee position with employee codes of ‘000001’ or ‘000008’ would be retrieved:

Below is an example where employees with employee codes of ‘000001’ or ‘000008’ would not be retrieved:

Below is an example where only employees with status codes of ‘e’ or ‘epla’ would be retrieved:

To retrieve acting positions set the ‘Restriction/ActingOrSubstantive flag to ‘a’.

To include deleted employees set the ‘Restriction/DeletedEmployees’ element to ‘include’.  By default deleted employees are not included in the extract.

Below is an example where positions are retrieved for a specific date range using the ‘Restriction/FromDate’ and ‘Restriction/UptoDate’ elements:

Screenshot showing where positions are retrieved for a specific date range using the 'Restriction/FromDate' and 'Restriction/UptoDate' elements

Below is an example where current and future-dated positions are retrieved using the ‘Restriction/IncludeFutureDatedFlag’ element set to ‘yes’:

Screenshot showing where current and future-dated positions are retrieved using the 'Restriction/IncludeFutureDatedFlag' element set to 'yes'

Below are the position and pay fields returned by the EmpowerStandardExtract web service via ‘GetEmployeePositions’.

Element

Default Screen Title

Employee/EmployeeCode

Employee Code

Employee/Positions/Position/PositionNumber

Position

Employee/Positions/Position/PositionTitle

Position Description

Employee/Positions/Position/Employment

Employment Number

Employee/Positions/Position/Acting

Temp Position

Employee/Positions/Position/Reason/Code

Reason Code

Employee/Positions/Position/Reason/Description

Reason Description

Employee/Positions/Position/Reason/Abbreviation

Reason Description

Employee/Positions/Position/PositionType/Code

Position Type Code

Employee/Positions/Position/PositionType/Description

Position Type Description

Employee/Positions/Position/PositionType/Abbreviation

Position Type Description

Employee/Positions/Position/PositionStartDate

Position Start Date

Employee/Positions/Position/PositionEndDate

Position End Date

Employee/Positions/Position/IsBudgeted

Budgeted

Employee/Positions/Position/AscoCode

ASCO Code

Employee/Positions/Position/CostCentre/Code

Cost Centre Code

Employee/Positions/Position/CostCentre/Description

Cost Centre Description

Employee/Positions/Position/CostCentre/Abbreviation

Cost Centre Description

Employee/Positions/Position/AdminUnit/Code

Admin Unit Code

Employee/Positions/Position/AdminUnit/Description

Admin Unit Description

Employee/Positions/Position/AdminUnit/Abbreviation

Admin Unit Description

Employee/Positions/Position/Job/Code

P/A or Job Code

Employee/Positions/Position/Job/Description

P/A or Job Description

Employee/Positions/Position/Job/Abbreviation

P/A or Job Description

Employee/Positions/Position/OrgLevel1/Code

Org Level 1 Code

Employee/Positions/Position/OrgLevel1/Description

Org Level 1 Description

Employee/Positions/Position/OrgLevel1/Abbreviation

Org Level 1 Description

Employee/Positions/Position/OrgLevel2/Code

Org Level 2 Code

Employee/Positions/Position/OrgLevel2/Description

Org Level 2 Description

Employee/Positions/Position/OrgLevel2/Abbreviation

Org Level 2 Description

Employee/Positions/Position/OrgLevel3/Code

Org Level 3 Code

Employee/Positions/Position/OrgLevel3/Description

Org Level 3 Description

Employee/Positions/Position/OrgLevel3/Abbreviation

Org Level 3 Description

Employee/Positions/Position/Division/Code

Division Code

Employee/Positions/Position/Division/Description

Division Description

Employee/Positions/Position/Division/Abbreviation

Division Description

Employee/Positions/Position/Branch/Code

Branch Code

Employee/Positions/Position/Branch/Description

Branch Description

Employee/Positions/Position/Branch/Abbreviation

Branch Description

Employee/Positions/Position/Section/Code

Section Code

Employee/Positions/Position/Section/Description

Section Description

Employee/Positions/Position/Section/Abbreviation

Section Description

Employee/Positions/Position/Duties/Code

Duties Code

Employee/Positions/Position/Duties/Description

Duties Description

Employee/Positions/Position/Duties/Abbreviation

Duties Description

Employee/Positions/Position/Location/Code

Location Code

Employee/Positions/Position/Location/Description

Location Description

Employee/Positions/Position/Location/Abbreviation

Location Description

Employee/Positions/Position/Authority/Code

Authority Code

Employee/Positions/Position/Authority/Description

Authority Description

Employee/Positions/Position/Authority/Abbreviation

Authority Description

Employee/Positions/Position/EmployeeType/Code

Employee Type Code

Employee/Positions/Position/EmployeeType/Description

Employee Type Description

Employee/Positions/Position/EmployeeType/Abbreviation

Employee Type Description

Employee/Positions/Position/OccupancyType

N/A

Employee/Positions/Position/EmploymentCondition/Code

Employment Condition Code

Employee/Positions/Position/EmploymentCondition/Description

Employment Condition Name

Employee/Positions/Position/EmploymentCondition/Abbreviation

Employment Condition Name

Employee/Positions/Position/ProbationPeriod

Probation Period

Employee/Positions/Position/WorkPattern/Code

Work Pattern Code

Employee/Positions/Position/WorkPattern/Description

Work Pattern Name

Employee/Positions/Position/WorkPattern/Abbreviation

Work Pattern Name

Employee/Positions/Position/ContractExpiryReason/Code

Contract Reason Code

Employee/Positions/Position/ContractExpiryReason/Description

Contract Reason Description

Employee/Positions/Position/ContractExpiryReason/Abbreviation

Contract Reason Description

Employee/Positions/Position/PublicHolidayCode/Code

Public Holiday Code

Employee/Positions/Position/PublicHolidayCode/Description

Public Holiday Name

Employee/Positions/Position/PublicHolidayCode/Abbreviation

Public Holiday Name

Employee/Positions/Position/ContractExpiryDate

Contract Expiry Date

Employee/Positions/Position/UserField4

User Field4

Employee/Positions/Position/ContractSigned

Contract Signed

Employee/Positions/Position/UserField5

User Field5

Employee/Positions/Position/Narrative

Narrative

Employee/Positions/Position/AuthorisingOfficer

Authorising Officer

Employee/Positions/Position/ReportsTo/PositionNumber

Position

Employee/Positions/Position/ReportsTo/PositionTitle

Position Title 

Employee/Positions/Position/PositionClassification/Code

Classification Code

Employee/Positions/Position/PositionClassification/Level

Classification Level

Employee/Positions/Position/PositionClassification/Name

Classification Name

Employee/Positions/Position/PositionClassification/Abbreviation

Classification Name

Employee/Positions/Position/PositionClassification/Salary

Class Salary

Employee/Positions/Position/PositionClassification/Rate

Class Rate

Employee/Positions/Position/SalaryPackage

 

Employee/Positions/Position/PayBasis/Code

Pay Basis

Employee/Positions/Position/PayBasis/Description

Pay Basis

Employee/Positions/Position/PayBasis/Abbreviation

Pay Basis

Employee/Positions/Position/BaseHours

Hours Per Period

Employee/Positions/Position/HoursPerWeek

Hours Per Week

Employee/Positions/Position/FTE

FTE%

Employee/Positions/Position/BaseSalary

Base Salary

Employee/Positions/Position/HourlyRate

Hourly Rate

Employee/Positions/Position/VariationPercent

Variation %

Employee/Positions/Position/VariationAmoun

Amount

Employee/Positions/Position/SalaryMaintenance/Code

Salary Maint?

Employee/Positions/Position/SalaryMaintenance/Description

Salary Maint?

Employee/Positions/Position/SalaryMaintenance/Abbreviation

Salary Maint?

Employee/Positions/Position/SalaryBarrierLevel

Sal.Bar.Level

Employee/Positions/Position/NextIncrementDate

Next Increment

Employee/Positions/Position/AutoIncrement

Auto Increment

Employee/Positions/Position/PayByException

Pay By Exception

Employee/Positions/Position/Schedule

Schedule

Employee/Positions/Position/Pay

Pay

Employee/Positions/Position/PaymentStartDate

Pay Start Date

Employee/Positions/Position/PayNarrative

Narrative


Next topic

GetEmployeeLeaveBalances




© 2023 Fusion5. All rights reserved.