Clock In Employee

Clocks in an employee for a new shift.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/manager/kiosk/{kioskId}/clockon

Path parameters

Parameter name Value Description Additional
kioskId int32 Required
businessId string Required

Request body

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

{
    "classificationId": "int32",
    "dimensionValueIds": [
        "int32"
    ],
    "employeeId": "int32",
    "image": "byte",
    "ipAddress": "string",
    "isAdminInitiated": "boolean",
    "kioskId": "int32",
    "latitude": "double",
    "locationId": "int32",
    "longitude": "double",
    "note": "string",
    "noteVisibility": "string",
    "recordedTimeUtc": "date-time",
    "shiftConditionIds": [
        "int32"
    ],
    "utcOffset": "string",
    "workTypeId": "int32"
}

Properties

Name Type Description
classificationId int32 Nullable
dimensionValueIds[] array of int32
employeeId int32 Nullable
image byte Byte[]
ipAddress string String
isAdminInitiated boolean Boolean
kioskId int32 Nullable
latitude double Nullable
locationId int32 Nullable
longitude double Nullable
note string String
noteVisibility string Nullable

Possible values are:

  • Hidden
  • Visible
recordedTimeUtc date-time Nullable
shiftConditionIds[] array of int32
utcOffset string Nullable
workTypeId int32 Nullable

Response

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

Status code Description Resource
200 OK

OK

 KioskEmployeeModel