V1Employee

July 10, 2019 ยท View on GitHub

Description

Represents one of a business's employees.

Properties

NameTypeDescriptionNotes
idStringThe employee's unique ID.[optional]
firstNameStringThe employee's first name.
lastNameStringThe employee's last name.
roleIdsList<String>The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.[optional]
authorizedLocationIdsList<String>The IDs of the locations the employee is allowed to clock in at.[optional]
emailStringThe employee's email address.[optional]
statusStringCWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See V1EmployeeStatus for possible values[optional]
externalIdStringAn ID the merchant can set to associate the employee with an entity in another system.[optional]
createdAtStringThe time when the employee entity was created, in ISO 8601 format.[optional]
updatedAtStringThe time when the employee entity was most recently updated, in ISO 8601 format.[optional]