Staff
 |
Staff provides editors to manage staff records, including individual employee maintenance, time punches, and payroll period management.
Staff API provides resources to to create, update and delete employee records, schedules, and payroll, including general employee information (Name, Birth Date), contact details, job rate information, site assignment information, and credentials required for an employee to work with the point of sale (POS) system. Creating an employee record also creates an employee identifier, which our products use to link time card data and payroll data to the employee.
Use Create an Employee Record to create employee data for one employee, together with Employee Site Statuses and POS Credentials. Use this endpoint to send less than 50 Site Status records in one request.Create an Employee RecordEmployeeSiteStatuses ArrayPosCredentials Array
Use Site Status Bulk Update to create, update, or delete site status information for 50 or more Site Status records in the request. This can be used to update a large number of site status records in one request after creating an employee.Site Status Bulk Update
The Update an Employee Record endpoint updates employee data, together with Employee Site Statuses and POS Credentials. Use the Request Employee Data endpoint to receive all previously created employee data. This is useful when updating employee data.Update an Employee RecordEmployeeSiteStatuses ArrayPosCredentials ArrayGET /Staff/Employee/EmployeeDetail
Update All Employee Jobs endpoint allows users to create and update employee job data together with a corresponding employee’s rate information. It allows multiple job updates in one request.Update All Employee Jobs
See also: Authentication for a description and example of how an integrator token can be generated.
For information on acquiring calculated payroll details, see the Get Calculated Payroll Details topic.Get Calculated Payroll Details
For instructions on synchronizing shift data, see the Scheduled Shifts API.Scheduled Shifts API
Release notes include data, functional, configuration, reporting, and infrastructure updates for this production version of Staff.
To view release notes, select either the production or UAT environment.