People and employments
A person and their job at the business are separate records. Staff are added and changed in Shiftly, not through the API.
An employee is a person: their name, contact details, date of birth and address. An employment is that person's job at this business: when it started, whether it is full-time, part-time or casual, which positions they hold, and, with the pay permission, what they are paid. One person has one employment at a business: the employee carries employment_id and the employment carries employee_id.
People join a business in Shiftly, through its onboarding. Your app cannot create an employee or an employment, and it cannot end one. Someone who has left shows as an archived employment, and their personal record stops being shared with the business, and so with your app.
Employees and employments are read-only to partner apps. Staff keep their own details current in Shiftly, and managers change the rest there. Each employee lists the locations they work at and the positions they may not be rostered to.
Staff details are personal information. Dates of birth and home addresses are included with people:read, and the business is told so when it connects your app. Store them only if your product needs them.
- Employees and Employments need people:read; pay fields need pay:read as well.
