The GetEmployeePayMasterDetails API is based on the Desktop Pay Master Enquiry screen.
It accepts optional parameters including the payment from and to dates, whether to include ad-hoc pays and the ability to restrict to a single payroll or employee.
If the payment dates are not supplied, the latest finalised normal paid date will be used to get the pay history data from that date.
The following optional parameters are available in the request:
| Element | Comments |
|---|---|
| PaymentDateFrom |
Optional Default to latest finalised pay date if not supplied. Standard date formats are supported (e.g. DDMMYY, DDMMMYY, DDMMYYYY, DDMMMYYYY) |
| PaymentDateTo | As above |
| AdhocFlag |
Optional y- only include adhoc pays n - do not include adhoc pays blank (default) - include both normal and adhoc pays |
| Payroll |
Optional Allows data to be retrieved data for a single payroll if necessary |
| EmployeeCode |
Optional Allows clients to retrieve data for a single employee if necessary |
The following fields will be included in each Employee Pay Master (Employees/Employee) record:
| Element | Comments |
|---|---|
| EmployeeCode | |
| Name/FormattedName | The employee formatted name, in the format ‘family name, first name’ |
| Name/FamilyName | The employee family or surname |
| Name/FirstName | The employee given names |
| Name/PreferredName | The employee preferred name |
| Name/Title | |
| Pays/Pay/Payroll/Code | |
| Pays/Pay/Payroll/Abbreviation | |
| Pays/Pay/Payroll/Description | |
| Pays/Pay/Year | |
| Pays/Pay/Period | |
| Pays/Pay/PaymentDate | Standard date output format dd MMM yyyy |
| Pays/Pay/AdhocFlag | Set to 'A' if an adhoc row otherwise blank. This is as per screen. |
| Pays/Pay/PayRows/PayRow/CostCentre/Code | |
| Pays/Pay/PayRows/PayRow/CostCentre/Abbreviation | |
| Pays/Pay/PayRows/PayRow/CostCentre/Description | The cost centre name |
| Pays/Pay/PayRows/PayRow/PaJobNumber | |
| Pays/Pay/PayRows/PayRow/Payment/Code | |
| Pays/Pay/PayRows/PayRow/Payment/Type | |
| Pays/Pay/PayRows/PayRow/Payment/Abbreviation | |
| Pays/Pay/PayRows/PayRow/Payment/Description | The payment name |
| Pays/Pay/PayRows/PayRow/PriorEmployment | |
| Pays/Pay/PayRows/PayRow/Employment | |
| Pays/Pay/PayRows/PayRow/Classification/Code | |
| Pays/Pay/PayRows/PayRow/Classification/Level | |
| Pays/Pay/PayRows/PayRow/Classification/Abbreviation | |
| Pays/Pay/PayRows/PayRow/Classification/Name | |
| Pays/Pay/PayRows/PayRow/Hours | |
| Pays/Pay/PayRows/PayRow/Amount | |
| Pays/Pay/PayRows/PayRow/ImpliedSign | -1 for deductions and +1 for allowances. |
© 2023 Fusion5. All rights reserved.