Employment Hero Payroll API Reference: SgManagerRosterDataModel

Methods

get - Manage Roster Data

Resource

{
    "biddableShifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "biddingEmployees": [
                {
                    "employeeName": "string",
                    "employeePhoneNumber": "string",
                    "id": "int32"
                }
            ],
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "isPaidBreak": "boolean",
                    "startTime": "date-time"
                }
            ],
            "cost": "double",
            "costFormatted": "string",
            "currentShift": {
                "isLate": "boolean",
                "isNotClockedOff": "boolean",
                "status": "string"
            },
            "datePublished": "date-time",
            "employeeId": "int32",
            "employeeName": "string",
            "employeePhoneNumber": "string",
            "endTime": "date-time",
            "id": "int32",
            "isLeaveBasedRosterShift": "boolean",
            "locationId": "int32",
            "locationName": "string",
            "notes": "string",
            "pendingSwap": {
                "dateCreated": "date-time",
                "fromEmployee": "string",
                "fromEmployeeId": "int32",
                "id": "int32",
                "note": "string",
                "rejectedReason": "string",
                "status": "int32",
                "statusDescription": "string",
                "toEmployee": "string",
                "toEmployeeId": "int32"
            },
            "published": "boolean",
            "qualifications": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "role": {
                "className": "string",
                "hexColourCode": "string",
                "id": "int32",
                "name": "string"
            },
            "shiftAssignmentStatus": "string",
            "shiftSwapCutoffTime": "date-time",
            "startTime": "date-time",
            "token": "string",
            "totalBiddingEmployees": "int32",
            "warnings": [
                "string"
            ],
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "leaveRequests": [
        {
            "isLeaveBasedRosterShift": "boolean"
        }
    ],
    "rosteredShifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "isPaidBreak": "boolean",
                    "startTime": "date-time"
                }
            ],
            "cost": "double",
            "costFormatted": "string",
            "currentShift": {
                "isLate": "boolean",
                "isNotClockedOff": "boolean",
                "status": "string"
            },
            "datePublished": "date-time",
            "employeeId": "int32",
            "employeeName": "string",
            "employeePhoneNumber": "string",
            "endTime": "date-time",
            "id": "int32",
            "isLeaveBasedRosterShift": "boolean",
            "locationId": "int32",
            "locationName": "string",
            "notes": "string",
            "pendingSwap": {
                "dateCreated": "date-time",
                "fromEmployee": "string",
                "fromEmployeeId": "int32",
                "id": "int32",
                "note": "string",
                "rejectedReason": "string",
                "status": "int32",
                "statusDescription": "string",
                "toEmployee": "string",
                "toEmployeeId": "int32"
            },
            "published": "boolean",
            "qualifications": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "role": {
                "className": "string",
                "hexColourCode": "string",
                "id": "int32",
                "name": "string"
            },
            "shiftAssignmentStatus": "string",
            "shiftSwapCutoffTime": "date-time",
            "startTime": "date-time",
            "token": "string",
            "warnings": [
                "string"
            ],
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "unassignedShifts": [
        {
            "accepted": "boolean",
            "biddable": "boolean",
            "breaks": [
                {
                    "endTime": "date-time",
                    "id": "int32",
                    "isPaidBreak": "boolean",
                    "startTime": "date-time"
                }
            ],
            "cost": "double",
            "costFormatted": "string",
            "currentShift": {
                "isLate": "boolean",
                "isNotClockedOff": "boolean",
                "status": "string"
            },
            "datePublished": "date-time",
            "employeeId": "int32",
            "employeeName": "string",
            "employeePhoneNumber": "string",
            "endTime": "date-time",
            "id": "int32",
            "isLeaveBasedRosterShift": "boolean",
            "locationId": "int32",
            "locationName": "string",
            "notes": "string",
            "pendingSwap": {
                "dateCreated": "date-time",
                "fromEmployee": "string",
                "fromEmployeeId": "int32",
                "id": "int32",
                "note": "string",
                "rejectedReason": "string",
                "status": "int32",
                "statusDescription": "string",
                "toEmployee": "string",
                "toEmployeeId": "int32"
            },
            "published": "boolean",
            "qualifications": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "role": {
                "className": "string",
                "hexColourCode": "string",
                "id": "int32",
                "name": "string"
            },
            "shiftAssignmentStatus": "string",
            "shiftSwapCutoffTime": "date-time",
            "startTime": "date-time",
            "token": "string",
            "warnings": [
                "string"
            ],
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "unavailability": [
        {
            "employeeId": "int32",
            "employeeName": "string",
            "endDate": "date-time",
            "fromDate": "date-time",
            "id": "int32",
            "isAllDay": "boolean",
            "reason": "string",
            "recurring": "boolean",
            "recurringDay": "string",
            "recurringDays": "string",
            "recurringDaysCsv": "string",
            "terminationDate": "date-time",
            "toDate": "date-time",
            "viewOnly": "boolean"
        }
    ]
}

Properties

Name	Type	Description
biddableShifts[]	array
biddableShifts[].accepted	boolean	Boolean
biddableShifts[].biddable	boolean	Boolean
biddableShifts[].biddingEmployees[]	array
biddableShifts[].biddingEmployees[].employeeName	string	String
biddableShifts[].biddingEmployees[].employeePhoneNumber	string	String
biddableShifts[].biddingEmployees[].id	int32	Int32
biddableShifts[].breaks[]	array
biddableShifts[].breaks[].endTime	date-time	DateTime
biddableShifts[].breaks[].id	int32	Int32
biddableShifts[].breaks[].isPaidBreak	boolean	Boolean
biddableShifts[].breaks[].startTime	date-time	DateTime
biddableShifts[].cost	double	Nullable
biddableShifts[].costFormatted	string	String
biddableShifts[].currentShift	object	ManagerCurrentRosterShift
biddableShifts[].currentShift.isLate	boolean	Boolean
biddableShifts[].currentShift.isNotClockedOff	boolean	Boolean
biddableShifts[].currentShift.status	string	TimeAttendanceStatus Possible values are: `NotClockedOn` `ClockedOn` `OnBreak` `ClockedOff`
biddableShifts[].datePublished	date-time	Nullable
biddableShifts[].employeeId	int32	Nullable
biddableShifts[].employeeName	string	String
biddableShifts[].employeePhoneNumber	string	String
biddableShifts[].endTime	date-time	DateTime
biddableShifts[].id	int32	Int32
biddableShifts[].isLeaveBasedRosterShift	boolean	Boolean
biddableShifts[].locationId	int32	Nullable
biddableShifts[].locationName	string	String
biddableShifts[].notes	string	String
biddableShifts[].pendingSwap	object	RosterShiftSwapModel
biddableShifts[].pendingSwap.dateCreated	date-time	DateTime
biddableShifts[].pendingSwap.fromEmployee	string	String
biddableShifts[].pendingSwap.fromEmployeeId	int32	Int32
biddableShifts[].pendingSwap.id	int32	Int32
biddableShifts[].pendingSwap.note	string	String
biddableShifts[].pendingSwap.rejectedReason	string	String
biddableShifts[].pendingSwap.status	int32	Int32
biddableShifts[].pendingSwap.statusDescription	string	String
biddableShifts[].pendingSwap.toEmployee	string	String
biddableShifts[].pendingSwap.toEmployeeId	int32	Int32
biddableShifts[].published	boolean	Boolean
biddableShifts[].qualifications[]	array
biddableShifts[].qualifications[].id	int32	Int32
biddableShifts[].qualifications[].name	string	String
biddableShifts[].role	object	RosterShiftRole
biddableShifts[].role.className	string	String
biddableShifts[].role.hexColourCode	string	String
biddableShifts[].role.id	int32	Int32
biddableShifts[].role.name	string	String
biddableShifts[].shiftAssignmentStatus	string	Nullable Possible values are: `Pending` `Assigned` `Bidding` `PendingShiftSwap` `PendingShiftSwapAwaitingApproval` `ProposedShiftSwap` `ProposedShiftSwapAwaitingApproval`
biddableShifts[].shiftSwapCutoffTime	date-time	Nullable
biddableShifts[].startTime	date-time	DateTime
biddableShifts[].token	string	String
biddableShifts[].totalBiddingEmployees	int32	Int32
biddableShifts[].warnings[]	array of string
biddableShifts[].workTypeId	int32	Nullable
biddableShifts[].workTypeName	string	String
leaveRequests[]	array
leaveRequests[].isLeaveBasedRosterShift	boolean	Boolean
rosteredShifts[]	array
rosteredShifts[].accepted	boolean	Boolean
rosteredShifts[].biddable	boolean	Boolean
rosteredShifts[].breaks[]	array
rosteredShifts[].breaks[].endTime	date-time	DateTime
rosteredShifts[].breaks[].id	int32	Int32
rosteredShifts[].breaks[].isPaidBreak	boolean	Boolean
rosteredShifts[].breaks[].startTime	date-time	DateTime
rosteredShifts[].cost	double	Nullable
rosteredShifts[].costFormatted	string	String
rosteredShifts[].currentShift	object	ManagerCurrentRosterShift
rosteredShifts[].currentShift.isLate	boolean	Boolean
rosteredShifts[].currentShift.isNotClockedOff	boolean	Boolean
rosteredShifts[].currentShift.status	string	TimeAttendanceStatus Possible values are: `NotClockedOn` `ClockedOn` `OnBreak` `ClockedOff`
rosteredShifts[].datePublished	date-time	Nullable
rosteredShifts[].employeeId	int32	Nullable
rosteredShifts[].employeeName	string	String
rosteredShifts[].employeePhoneNumber	string	String
rosteredShifts[].endTime	date-time	DateTime
rosteredShifts[].id	int32	Int32
rosteredShifts[].isLeaveBasedRosterShift	boolean	Boolean
rosteredShifts[].locationId	int32	Nullable
rosteredShifts[].locationName	string	String
rosteredShifts[].notes	string	String
rosteredShifts[].pendingSwap	object	RosterShiftSwapModel
rosteredShifts[].pendingSwap.dateCreated	date-time	DateTime
rosteredShifts[].pendingSwap.fromEmployee	string	String
rosteredShifts[].pendingSwap.fromEmployeeId	int32	Int32
rosteredShifts[].pendingSwap.id	int32	Int32
rosteredShifts[].pendingSwap.note	string	String
rosteredShifts[].pendingSwap.rejectedReason	string	String
rosteredShifts[].pendingSwap.status	int32	Int32
rosteredShifts[].pendingSwap.statusDescription	string	String
rosteredShifts[].pendingSwap.toEmployee	string	String
rosteredShifts[].pendingSwap.toEmployeeId	int32	Int32
rosteredShifts[].published	boolean	Boolean
rosteredShifts[].qualifications[]	array
rosteredShifts[].qualifications[].id	int32	Int32
rosteredShifts[].qualifications[].name	string	String
rosteredShifts[].role	object	RosterShiftRole
rosteredShifts[].role.className	string	String
rosteredShifts[].role.hexColourCode	string	String
rosteredShifts[].role.id	int32	Int32
rosteredShifts[].role.name	string	String
rosteredShifts[].shiftAssignmentStatus	string	Nullable Possible values are: `Pending` `Assigned` `Bidding` `PendingShiftSwap` `PendingShiftSwapAwaitingApproval` `ProposedShiftSwap` `ProposedShiftSwapAwaitingApproval`
rosteredShifts[].shiftSwapCutoffTime	date-time	Nullable
rosteredShifts[].startTime	date-time	DateTime
rosteredShifts[].token	string	String
rosteredShifts[].warnings[]	array of string
rosteredShifts[].workTypeId	int32	Nullable
rosteredShifts[].workTypeName	string	String
unassignedShifts[]	array
unassignedShifts[].accepted	boolean	Boolean
unassignedShifts[].biddable	boolean	Boolean
unassignedShifts[].breaks[]	array
unassignedShifts[].breaks[].endTime	date-time	DateTime
unassignedShifts[].breaks[].id	int32	Int32
unassignedShifts[].breaks[].isPaidBreak	boolean	Boolean
unassignedShifts[].breaks[].startTime	date-time	DateTime
unassignedShifts[].cost	double	Nullable
unassignedShifts[].costFormatted	string	String
unassignedShifts[].currentShift	object	ManagerCurrentRosterShift
unassignedShifts[].currentShift.isLate	boolean	Boolean
unassignedShifts[].currentShift.isNotClockedOff	boolean	Boolean
unassignedShifts[].currentShift.status	string	TimeAttendanceStatus Possible values are: `NotClockedOn` `ClockedOn` `OnBreak` `ClockedOff`
unassignedShifts[].datePublished	date-time	Nullable
unassignedShifts[].employeeId	int32	Nullable
unassignedShifts[].employeeName	string	String
unassignedShifts[].employeePhoneNumber	string	String
unassignedShifts[].endTime	date-time	DateTime
unassignedShifts[].id	int32	Int32
unassignedShifts[].isLeaveBasedRosterShift	boolean	Boolean
unassignedShifts[].locationId	int32	Nullable
unassignedShifts[].locationName	string	String
unassignedShifts[].notes	string	String
unassignedShifts[].pendingSwap	object	RosterShiftSwapModel
unassignedShifts[].pendingSwap.dateCreated	date-time	DateTime
unassignedShifts[].pendingSwap.fromEmployee	string	String
unassignedShifts[].pendingSwap.fromEmployeeId	int32	Int32
unassignedShifts[].pendingSwap.id	int32	Int32
unassignedShifts[].pendingSwap.note	string	String
unassignedShifts[].pendingSwap.rejectedReason	string	String
unassignedShifts[].pendingSwap.status	int32	Int32
unassignedShifts[].pendingSwap.statusDescription	string	String
unassignedShifts[].pendingSwap.toEmployee	string	String
unassignedShifts[].pendingSwap.toEmployeeId	int32	Int32
unassignedShifts[].published	boolean	Boolean
unassignedShifts[].qualifications[]	array
unassignedShifts[].qualifications[].id	int32	Int32
unassignedShifts[].qualifications[].name	string	String
unassignedShifts[].role	object	RosterShiftRole
unassignedShifts[].role.className	string	String
unassignedShifts[].role.hexColourCode	string	String
unassignedShifts[].role.id	int32	Int32
unassignedShifts[].role.name	string	String
unassignedShifts[].shiftAssignmentStatus	string	Nullable Possible values are: `Pending` `Assigned` `Bidding` `PendingShiftSwap` `PendingShiftSwapAwaitingApproval` `ProposedShiftSwap` `ProposedShiftSwapAwaitingApproval`
unassignedShifts[].shiftSwapCutoffTime	date-time	Nullable
unassignedShifts[].startTime	date-time	DateTime
unassignedShifts[].token	string	String
unassignedShifts[].warnings[]	array of string
unassignedShifts[].workTypeId	int32	Nullable
unassignedShifts[].workTypeName	string	String
unavailability[]	array
unavailability[].employeeId	int32	Int32
unavailability[].employeeName	string	String
unavailability[].endDate	date-time	Nullable
unavailability[].fromDate	date-time	DateTime
unavailability[].id	int32	Int32
unavailability[].isAllDay	boolean	Boolean
unavailability[].reason	string	String
unavailability[].recurring	boolean	Boolean
unavailability[].recurringDay	string	Nullable Possible values are: `Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`
unavailability[].recurringDays	string	Nullable Possible values are: `Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`
unavailability[].recurringDaysCsv	string	String
unavailability[].terminationDate	date-time	Nullable
unavailability[].toDate	date-time	Nullable
unavailability[].viewOnly	boolean	Boolean

SgManagerRosterDataModel resource

Methods

Resource

Properties