Staff
 |
Staff provides editors to manage staff records, including individual employee maintenance, time punches, and payroll period management.
Staff API provides resources 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 all required child entities, such as Site Statuses, POS Credentials, and other entities.
The Update an Employee Record endpoint updates employee data. Use this endpoint to update an employee or to create/update its child entities. The endpoint updates only the fields and entities included in the request.
Create Employee Jobs endpoint allows users to create employee job data together with a corresponding employee’s rate information for a single employee. And the PATCH /External/General/Employee/[ID]/Job/[ID] endpoint allows users to deactivate a single employee’s job, or create and update its rates.
Delete endpoints allow users to remove erroneous data, such as incorrect phone numbers and email addresses.
See also: Authentication for a description and example of how an integrator token can be generated.
To acquire calculated payroll details, use the Get Calculated Payroll Details endpoint.
For instructions on synchronizing shift data, see the Scheduled Shifts API.