Create Kiosk

Creates a new kiosk for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "allowEmployeeShiftSelection": "boolean",
    "allowHigherClassificationSelection": "boolean",
    "availableToAllRestrictedUsersWithKioskAccess": "boolean",
    "branding": {
        "backgroundColour": "string",
        "backgroundImageUrl": "string",
        "darkModeBackgroundColour": "string",
        "darkModeLogoUrl": "string",
        "darkModeTextColour": "string",
        "darkModeTextSecondaryColour": "string",
        "logoUrl": "string",
        "textColour": "string",
        "textHoverColour": "string",
        "textSecondaryColour": "string"
    },
    "canAddEmployees": "boolean",
    "clockOffWindowMinutes": "int32",
    "clockOnWindowMinutes": "int32",
    "externalId": "string",
    "id": "int32",
    "isLocationRequired": "boolean",
    "isPhotoRequired": "boolean",
    "isWorkTypeRequired": "boolean",
    "locationId": "int32",
    "name": "string",
    "paidBreaksEnabled": "boolean",
    "restrictLocationsForEmployees": "boolean",
    "timeZone": "string",
    "timesheetDimensionsEnabled": "boolean"
}

Properties

Name Type Description
allowEmployeeShiftSelection boolean Nullable
allowHigherClassificationSelection boolean Boolean
availableToAllRestrictedUsersWithKioskAccess boolean Boolean
branding object WhiteLabelBrandingModel
branding.backgroundColour string String
branding.backgroundImageUrl string String
branding.darkModeBackgroundColour string String
branding.darkModeLogoUrl string String
branding.darkModeTextColour string String
branding.darkModeTextSecondaryColour string String
branding.logoUrl string String
branding.textColour string String
branding.textHoverColour string String
branding.textSecondaryColour string String
canAddEmployees boolean Boolean
clockOffWindowMinutes int32 Nullable
clockOnWindowMinutes int32 Nullable
externalId string String
id int32 Int32
isLocationRequired boolean Boolean
isPhotoRequired boolean Nullable
isWorkTypeRequired boolean Boolean
locationId int32 Nullable
name string String
paidBreaksEnabled boolean Boolean
restrictLocationsForEmployees boolean Boolean
timeZone string String
timesheetDimensionsEnabled boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 TimeAndAttendanceKioskModel