Start Break

Starts a break for an employee who is clocked on for a shift.

Request

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

Path parameters

Parameter name Value Description Additional
kioskId int32 Required
businessId string Required

Request body

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

{
    "employeeId": "int32",
    "image": "byte",
    "ipAddress": "string",
    "isAdminInitiated": "boolean",
    "isPaidBreak": "boolean",
    "kioskId": "int32",
    "latitude": "double",
    "longitude": "double",
    "noteVisibility": "string",
    "recordedTimeUtc": "date-time",
    "utcOffset": "string"
}

Properties

Name Type Description
employeeId int32 Nullable
image byte Byte[]
ipAddress string String
isAdminInitiated boolean Boolean
isPaidBreak boolean Boolean
kioskId int32 Nullable
latitude double Nullable
longitude double Nullable
noteVisibility string Nullable

Possible values are:

  • Hidden
  • Visible
recordedTimeUtc date-time Nullable
utcOffset string Nullable

Response

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

Status code Description Resource
200 OK

OK