Add Complete Shift for Employee

Clocks in / out an employee for a complete shift.

Request

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

Path parameters

Parameter name Value Description Additional
kioskId int32 Required
businessId string Required

Request body

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

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

Properties

Name Type Description
breaks[] array
breaks[].employeeId int32 Nullable
breaks[].end object EndBreakModel
breaks[].end.employeeId int32 Nullable
breaks[].end.image byte Byte[]
breaks[].end.ipAddress string String
breaks[].end.isAdminInitiated boolean Boolean
breaks[].end.isPaidBreak boolean Boolean
breaks[].end.kioskId int32 Nullable
breaks[].end.latitude double Nullable
breaks[].end.longitude double Nullable
breaks[].end.noteVisibility string Nullable

Possible values are:

  • Hidden
  • Visible
breaks[].end.recordedTimeUtc date-time Nullable
breaks[].end.utcOffset string Nullable
breaks[].image byte Byte[]
breaks[].ipAddress string String
breaks[].isAdminInitiated boolean Boolean
breaks[].isPaidBreak boolean Boolean
breaks[].kioskId int32 Nullable
breaks[].latitude double Nullable
breaks[].longitude double Nullable
breaks[].noteVisibility string Nullable

Possible values are:

  • Hidden
  • Visible
breaks[].recordedTimeUtc date-time Nullable
breaks[].start object StartBreakModel
breaks[].start.employeeId int32 Nullable
breaks[].start.image byte Byte[]
breaks[].start.ipAddress string String
breaks[].start.isAdminInitiated boolean Boolean
breaks[].start.isPaidBreak boolean Boolean
breaks[].start.kioskId int32 Nullable
breaks[].start.latitude double Nullable
breaks[].start.longitude double Nullable
breaks[].start.noteVisibility string Nullable

Possible values are:

  • Hidden
  • Visible
breaks[].start.recordedTimeUtc date-time Nullable
breaks[].start.utcOffset string Nullable
breaks[].utcOffset string Nullable
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
recordedEndTimeUtc date-time DateTime
recordedStartTimeUtc date-time DateTime
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