POS Employee

Methods

Retrieve employees

Retrieve a specific location employees

GET /pos/v2/{locationId}/employees

Response 200

Returns employees in requested location

{
  "results": [
    {
      "posRef": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "payrollId": "string",
      "isActive": true,
      "jobs": [
        "string"
      ],
      "payRates": [
        {
          "jobRef": "string",
          "payRate": 0,
          "isPaidHourly": true
        }
      ],
      "emails": [
        "user@example.com"
      ],
      "phones": [
        {
          "number": "string",
          "type": "WORK"
        }
      ]
    }
  ],
  "meta": {}
}

Definitions

Employee

Employee data

Name Type Description
posRef* string Employee reference ID. Unique per location
name* string Employee display name (e.g. first name & last name
firstName string Employee's first name
lastName string Employee's last name
payrollId string Employee's payroll identifier which is manually entered in employee details form
isActive* boolean Indicates whether this employee is active in POS or not
jobs* array Employee's job references
payRates* array A collection of Employee's pay rates settings for a particular job
emails array A collection of employee's emails
phones array A collection of employee's phone numbers

Pay Rate

Employee's pay rate settings for a particular job

Name Type Description
jobRef* string Employee's job reference
payRate* integer Pay Rate in US-cents for the particular job
isPaidHourly* boolean Determines whether the "job" is paid hourly

Employee Phone

Employee Phone data

Name Type Description
number* string The phone number exactly as stored in the POS
type* string Type of the employee phone. One of the following:
  • WORK - A phone number that the employee is reachable by while at the workplace.
  • MOBILE - A phone number that the employee is reachable by while on the go.
  • OTHER - A phone number that doesn't fall into any other category - for example, a home phone number

results matching ""

    No results matching ""