V1Employee

March 13, 2019 ยท View on GitHub

squareconnect.models.v1_employee

Description

Represents one of a business's employees.

Properties

NameTypeDescriptionNotes
idstrThe employee's unique ID.[optional]
first_namestrThe employee's first name.
last_namestrThe employee's last name.
role_idslist[str]The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.[optional]
authorized_location_idslist[str]The IDs of the locations the employee is allowed to clock in at.[optional]
emailstrThe employee's email address.[optional]
statusstrCWhether 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]
external_idstrAn ID the merchant can set to associate the employee with an entity in another system.[optional]
created_atstrThe time when the employee entity was created, in ISO 8601 format.[optional]
updated_atstrThe time when the employee entity was most recently updated, in ISO 8601 format.[optional]

[Back to Model list] [Back to API list] [Back to README]