Add an Employee

Quickly add an employee with minimal details and kiosk enabled.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/kiosk/{kioskId}/staff

Path parameters

Parameter name Value Description Additional
kioskId int32 Required
businessId string Required

Request body

The request body takes a complete KioskCreateEmployeeModel resource, containing the following writable properties:

{
    "email": "string",
    "firstName": "string",
    "mobileNumber": "string",
    "pin": "string",
    "surname": "string"
}

Properties

Name Type Description
email string String
firstName string String
mobileNumber string String
pin string String
surname string String

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 BasicKioskEmployeeModel