Clocks in an employee for a new shift.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/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",
    "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
classificationId 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[] array of int32
utcOffset string
workTypeId int32

Response

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

Status code Description Resource
200 OK

OK