Add Note to Shift

Adds a note to an existing shift.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/kiosk/{kioskId}/shift/{shiftId}/notes

Path parameters

Parameter name Value Description Additional
kioskId int32 Required
shiftId int32 Required
businessId string Required

Request body

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

{
    "employeeId": "int32",
    "isAdminInitiated": "boolean",
    "note": "string",
    "type": "string",
    "visibility": "string"
}

Properties

Name Type Description
employeeId int32 Int32
isAdminInitiated boolean Boolean
note string String
type string TimeAttendanceShiftNoteType

Possible values are:

  • Shift
  • ClockOn
  • ClockOff
visibility string TimeAttendanceShiftNoteVisibility

Possible values are:

  • Hidden
  • Visible

Response

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

Status code Description Resource
200 OK

OK