V1Employee

March 13, 2019 ยท View on GitHub

Description

Represents one of a business's employees.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe employee's unique ID.[optional]
first_namegetFirstName()setFirstName($value)stringThe employee's first name.
last_namegetLastName()setLastName($value)stringThe employee's last name.
role_idsgetRoleIds()setRoleIds($value)string[]The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee.[optional]
authorized_location_idsgetAuthorizedLocationIds()setAuthorizedLocationIds($value)string[]The IDs of the locations the employee is allowed to clock in at.[optional]
emailgetEmail()setEmail($value)stringThe employee's email address.[optional]
statusgetStatus()setStatus($value)stringCWhether 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_idgetExternalId()setExternalId($value)stringAn ID the merchant can set to associate the employee with an entity in another system.[optional]
created_atgetCreatedAt()setCreatedAt($value)stringThe time when the employee entity was created, in ISO 8601 format.[optional]
updated_atgetUpdatedAt()setUpdatedAt($value)stringThe time when the employee entity was most recently updated, in ISO 8601 format.[optional]

Note: All properties are protected and only accessed via getters and setters.

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