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

Request

POST https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/timeandattendance/startbreak

Path parameters

Parameter name Value Description Additional
employeeId int32 Required

Request body

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

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

Properties

Name Type
employeeId int32
image byte
ipAddress string
isAdminInitiated boolean
kioskId int32
latitude double
longitude double
noteVisibility string
recordedTimeUtc date-time
utcOffset string

Response

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

Status code Description Resource
200 OK

OK