Employees
The employee is at the heart of every operation within Wagestream
Below is a table of all the fields/attributes/columns that you can supply to Wagestream on an employee.
Attribute | Description | Data Type |
---|---|---|
employee_id | This is typically the unique identifier for the employee across your many HR/WFM/Payroll systems, it's typically an employees payroll number, or similar | string |
name | Friendly name for the employee e.g Daffy Duck | string (256 characters) |
The employees email address, should default to their personal email address | string (email) | |
mobile_number | The employees personal mobile number | string (phone number) format +447976123123 |
group | The legal entity which, on pay day, pays this employee. If you have employees paid from different businesses within your organisation - you will need to include this | string (256 characters) |
division | Setting this attributes allows you to identify which division, or maybe which site, or hotel, or department an employee works in. It is generally used to segment the workforce within our employer portal | string (256 characters) |
assignment_id | If an employee can work multiple positions, e.g Manager by day, but front-of-house at night. You will need to include their equivalent position, occupancy, assignment And include 1 record per employee per assignment - e.g if an employee holds 3 assignments - you would send us 3 employee records all with different assignment_id's | string (256 characters) |
pay_schedule_id | A unique identifier relating to the pay schedule an employee is assigned to. For example you may have 1 group of employees on a weekly pay-cycle, but another on a monthly, you can use this field to tell us which pay-cycle/schedule the employee is on | string (256 characters) |
start_date | The date in which the main employment, contract, or assignment for this employee starts | ISO 8601 Date ex. 2021-10-12 |
termination_date | Synonymous with leaving date, the date the main contract or assignment for this employee ends. This information is used to off-board and un-enrol an employee in Wagestream | ISO 8601 Date ex. 2021-10-12 |
salary | Gross salary amount, decimal to two decimal places | decimal (2 decimal places) |
contracted_hours | A decimal value (2 decimal places) representing the number of contracted hours for a defined period, which by default is monthly, but can be overridden using the salary_frequency column. This field is only required if you have employees on contracted hours and are using the rate field | decimal (2 decimal places) |
rate | A decimal value (2 decimal places) which represents the base/default hourly rate for this employee | decimal (2 places) |
bank_account_number | The employees UK Bank primary account number which is used to receive their salary, or EU IBAN number | string (256 characters) |
bank_sort_code | The employees UK sortcode (8 digits without the dashes representing a UK bank sortcode or a EU BIC code Please note we do not support UK building society roll numbers | string (256 characters) |
Updated 12 months ago