{
"leaveRequests": [
{
"amount": "string",
"appliedLeaveUnitTypeDescription": "string",
"attachment": {
"dateCreated": "date-time",
"dateScanned": "date-time",
"friendlyName": "string",
"id": "int32",
"isInfected": "boolean",
"url": "string"
},
"banner": {
"header": "string",
"items": [
"string"
]
},
"canCancel": "boolean",
"canModify": "boolean",
"canPartiallyEdit": "boolean",
"fromDate": "date-time",
"hoursPerDay": "double",
"id": "int32",
"isApproved": "boolean",
"isCancelled": "boolean",
"isDeclined": "boolean",
"isPending": "boolean",
"leaveCategoryId": "int32",
"leaveCategoryName": "string",
"manuallyApplied": "boolean",
"notes": "string",
"previouslyAppliedUnits": "double",
"requestedDate": "date-time",
"requireNotesForLeaveRequests": "boolean",
"status": "string",
"statusUpdateNotes": "string",
"toDate": "date-time",
"totalDays": "double",
"totalHours": "double",
"totalUnits": "double",
"unitType": "string",
"workTypeId": "int32",
"workTypeName": "string"
}
],
"publicHolidays": [
{
"date": "date-time",
"description": "string",
"id": "int32",
"isSystem": "boolean",
"locationIds": [
"int32"
],
"mondayisedAlternativeToId": "int32",
"notAPublicHoliday": "boolean",
"note": "string",
"states": [
"string"
]
}
],
"rosterShifts": [
{
"accepted": "boolean",
"biddable": "boolean",
"breaks": [
{
"endTime": "date-time",
"id": "int32",
"isPaidBreak": "boolean",
"startTime": "date-time"
}
],
"datePublished": "date-time",
"employeeId": "int32",
"employeeName": "string",
"endTime": "date-time",
"id": "int32",
"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",
"workTypeId": "int32",
"workTypeName": "string"
}
],
"timesheets": [
{
"attachment": {
"data": "byte",
"dateCreated": "date-time",
"dateScanned": "date-time",
"friendlyName": "string",
"id": "int32",
"isDeleted": "boolean",
"isInfected": "boolean",
"url": "string"
},
"autoApprovedByRosterShiftId": "int32",
"breaks": [
{
"end": "date-time",
"formattedEnd": "string",
"formattedStart": "string",
"id": "int32",
"isPaidBreak": "boolean",
"start": "date-time",
"submittedEnd": "date-time",
"submittedStart": "date-time"
}
],
"breaksDurationInMinutes": "int32",
"canDelete": "boolean",
"canEdit": "boolean",
"classificationId": "int32",
"classificationName": "string",
"comments": "string",
"cost": "double",
"costByLocation": "double",
"costingData": {
"allowances": [
{
"classification": {
"id": "int32",
"name": "string",
"rank": "int32"
},
"cost": "double",
"option": "string",
"payCategory": "string",
"payCategoryId": "int32",
"rateMultiplier": "double",
"type": "string",
"units": "double"
}
],
"isConsolidated": "boolean",
"liabilities": [
{
"amount": "double",
"cost": "double",
"includeInShiftCost": "boolean",
"liabilityCategoryId": "int32",
"liabilityCategoryName": "string",
"option": "string"
}
],
"shiftParts": [
{
"actualDuration": "string",
"baseRate": "double",
"calculatedRate": "double",
"classification": {
"id": "int32",
"name": "string",
"rank": "int32"
},
"cost": "double",
"displayDuration": "string",
"effectiveDuration": "string",
"endTime": "date-time",
"isAllowanceOrUnitBased": "boolean",
"isBreak": "boolean",
"isPaidBreak": "boolean",
"leaveCategory": {
"id": "int32",
"name": "string"
},
"location": {
"id": "int32",
"name": "string",
"state": "string"
},
"payCategory": "string",
"payCategoryId": "int32",
"rateMultiplier": "double",
"startTime": "date-time",
"workType": {
"id": "int32",
"linkType": "string",
"name": "string"
}
}
]
},
"costingDataByLocation": {
"allowances": [
{
"classification": {
"id": "int32",
"name": "string",
"rank": "int32"
},
"cost": "double",
"option": "string",
"payCategory": "string",
"payCategoryId": "int32",
"rateMultiplier": "double",
"type": "string",
"units": "double"
}
],
"isConsolidated": "boolean",
"liabilities": [
{
"amount": "double",
"cost": "double",
"includeInShiftCost": "boolean",
"liabilityCategoryId": "int32",
"liabilityCategoryName": "string",
"option": "string"
}
],
"shiftParts": [
{
"actualDuration": "string",
"baseRate": "double",
"calculatedRate": "double",
"classification": {
"id": "int32",
"name": "string",
"rank": "int32"
},
"cost": "double",
"displayDuration": "string",
"effectiveDuration": "string",
"endTime": "date-time",
"isAllowanceOrUnitBased": "boolean",
"isBreak": "boolean",
"isPaidBreak": "boolean",
"leaveCategory": {
"id": "int32",
"name": "string"
},
"location": {
"id": "int32",
"name": "string",
"state": "string"
},
"payCategory": "string",
"payCategoryId": "int32",
"rateMultiplier": "double",
"startTime": "date-time",
"workType": {
"id": "int32",
"linkType": "string",
"name": "string"
}
}
]
},
"dimensionValueIds": [
"int32"
],
"discard": "boolean",
"durationOverride": "string",
"employeeId": "int32",
"employeeName": "string",
"end": "date-time",
"externalReferenceId": "string",
"hiddenComments": "string",
"id": "int32",
"ignoreRounding": "boolean",
"isLocked": "boolean",
"isOverlapping": "boolean",
"isUnitBasedWorkType": "boolean",
"leaveCategoryId": "int32",
"leaveRequestId": "int32",
"locationId": "int32",
"locationIsDeleted": "boolean",
"locationName": "string",
"overdrawsLeave": "boolean",
"payCategoryId": "int32",
"payRunId": "int32",
"paySlipUrl": "string",
"rate": "double",
"readOnly": "boolean",
"reviewedBy": "string",
"shiftConditionIds": [
"int32"
],
"source": "string",
"start": "date-time",
"status": "string",
"statusId": "int32",
"submittedEnd": "date-time",
"submittedStart": "date-time",
"totalDurationInMinutes": "int32",
"unitType": "string",
"units": "double",
"workDurationInMinutes": "int32",
"workTypeId": "int32",
"workTypeName": "string"
}
]
}
Name | Type | Description |
---|---|---|
leaveRequests[] | array | |
leaveRequests[].amount | string | String |
leaveRequests[].appliedLeaveUnitTypeDescription | string | String |
leaveRequests[].attachment | object | AttachmentModel |
leaveRequests[].attachment.dateCreated | date-time |
Nullable |
leaveRequests[].attachment.dateScanned | date-time |
Nullable |
leaveRequests[].attachment.friendlyName | string | String |
leaveRequests[].attachment.id | int32 |
Nullable |
leaveRequests[].attachment.isInfected | boolean |
Nullable |
leaveRequests[].attachment.url | string | String |
leaveRequests[].banner | object | PartiallyAppliedLeaveRequestBannerModel |
leaveRequests[].banner.header | string | String |
leaveRequests[].banner.items[] | array of string | |
leaveRequests[].canCancel | boolean | Boolean |
leaveRequests[].canModify | boolean | Boolean |
leaveRequests[].canPartiallyEdit | boolean | Boolean |
leaveRequests[].fromDate | date-time | DateTime |
leaveRequests[].hoursPerDay | double | Decimal |
leaveRequests[].id | int32 | Int32 |
leaveRequests[].isApproved | boolean | Boolean |
leaveRequests[].isCancelled | boolean | Boolean |
leaveRequests[].isDeclined | boolean | Boolean |
leaveRequests[].isPending | boolean | Boolean |
leaveRequests[].leaveCategoryId | int32 | Int32 |
leaveRequests[].leaveCategoryName | string | String |
leaveRequests[].manuallyApplied | boolean | Boolean |
leaveRequests[].notes | string | String |
leaveRequests[].previouslyAppliedUnits | double | Decimal |
leaveRequests[].requestedDate | date-time | DateTime |
leaveRequests[].requireNotesForLeaveRequests | boolean | Boolean |
leaveRequests[].status | string | String |
leaveRequests[].statusUpdateNotes | string | String |
leaveRequests[].toDate | date-time | DateTime |
leaveRequests[].totalDays | double | Decimal |
leaveRequests[].totalHours | double | Decimal |
leaveRequests[].totalUnits | double | Decimal |
leaveRequests[].unitType | string |
LeaveUnitTypeEnum
Possible values are:
|
leaveRequests[].workTypeId | int32 |
Nullable |
leaveRequests[].workTypeName | string | String |
publicHolidays[] | array | |
publicHolidays[].date | date-time |
Nullable |
publicHolidays[].description | string | String |
publicHolidays[].id | int32 |
Nullable |
publicHolidays[].isSystem | boolean | Boolean |
publicHolidays[].locationIds[] | array of int32 | |
publicHolidays[].mondayisedAlternativeToId | int32 | Int32 |
publicHolidays[].notAPublicHoliday | boolean | Boolean |
publicHolidays[].note | string | String |
publicHolidays[].states[] | array of string | |
rosterShifts[] | array | |
rosterShifts[].accepted | boolean | Boolean |
rosterShifts[].biddable | boolean | Boolean |
rosterShifts[].breaks[] | array | |
rosterShifts[].breaks[].endTime | date-time | DateTime |
rosterShifts[].breaks[].id | int32 | Int32 |
rosterShifts[].breaks[].isPaidBreak | boolean | Boolean |
rosterShifts[].breaks[].startTime | date-time | DateTime |
rosterShifts[].datePublished | date-time |
Nullable |
rosterShifts[].employeeId | int32 |
Nullable |
rosterShifts[].employeeName | string | String |
rosterShifts[].endTime | date-time | DateTime |
rosterShifts[].id | int32 | Int32 |
rosterShifts[].locationId | int32 |
Nullable |
rosterShifts[].locationName | string | String |
rosterShifts[].notes | string | String |
rosterShifts[].pendingSwap | object | RosterShiftSwapModel |
rosterShifts[].pendingSwap.dateCreated | date-time | DateTime |
rosterShifts[].pendingSwap.fromEmployee | string | String |
rosterShifts[].pendingSwap.fromEmployeeId | int32 | Int32 |
rosterShifts[].pendingSwap.id | int32 | Int32 |
rosterShifts[].pendingSwap.note | string | String |
rosterShifts[].pendingSwap.rejectedReason | string | String |
rosterShifts[].pendingSwap.status | int32 | Int32 |
rosterShifts[].pendingSwap.statusDescription | string | String |
rosterShifts[].pendingSwap.toEmployee | string | String |
rosterShifts[].pendingSwap.toEmployeeId | int32 | Int32 |
rosterShifts[].published | boolean | Boolean |
rosterShifts[].qualifications[] | array | |
rosterShifts[].qualifications[].id | int32 | Int32 |
rosterShifts[].qualifications[].name | string | String |
rosterShifts[].role | object | RosterShiftRole |
rosterShifts[].role.className | string | String |
rosterShifts[].role.hexColourCode | string | String |
rosterShifts[].role.id | int32 | Int32 |
rosterShifts[].role.name | string | String |
rosterShifts[].shiftAssignmentStatus | string |
Nullable Possible values are:
|
rosterShifts[].shiftSwapCutoffTime | date-time |
Nullable |
rosterShifts[].startTime | date-time | DateTime |
rosterShifts[].token | string | String |
rosterShifts[].workTypeId | int32 |
Nullable |
rosterShifts[].workTypeName | string | String |
timesheets[] | array | |
timesheets[].attachment | object | Attachment |
timesheets[].attachment.data | byte | Byte[] |
timesheets[].attachment.dateCreated | date-time |
Nullable |
timesheets[].attachment.dateScanned | date-time |
Nullable |
timesheets[].attachment.friendlyName | string | String |
timesheets[].attachment.id | int32 |
Nullable |
timesheets[].attachment.isDeleted | boolean | Boolean |
timesheets[].attachment.isInfected | boolean |
Nullable |
timesheets[].attachment.url | string | String |
timesheets[].autoApprovedByRosterShiftId | int32 |
Nullable |
timesheets[].breaks[] | array | |
timesheets[].breaks[].end | date-time |
Nullable |
timesheets[].breaks[].formattedEnd | string | String |
timesheets[].breaks[].formattedStart | string | String |
timesheets[].breaks[].id | int32 | Int32 |
timesheets[].breaks[].isPaidBreak | boolean | Boolean |
timesheets[].breaks[].start | date-time |
Nullable |
timesheets[].breaks[].submittedEnd | date-time |
Nullable |
timesheets[].breaks[].submittedStart | date-time |
Nullable |
timesheets[].breaksDurationInMinutes | int32 | Int32 |
timesheets[].canDelete | boolean | Boolean |
timesheets[].canEdit | boolean | Boolean |
timesheets[].classificationId | int32 |
Nullable |
timesheets[].classificationName | string | String |
timesheets[].comments | string | String |
timesheets[].cost | double |
Nullable |
timesheets[].costByLocation | double |
Nullable |
timesheets[].costingData | object | ShiftCostingData |
timesheets[].costingData.allowances[] | array | |
timesheets[].costingData.allowances[].classification | object | NominalClassification |
timesheets[].costingData.allowances[].classification.id | int32 | Int32 |
timesheets[].costingData.allowances[].classification.name | string | String |
timesheets[].costingData.allowances[].classification.rank | int32 | Int32 |
timesheets[].costingData.allowances[].cost | double | Decimal |
timesheets[].costingData.allowances[].option | string |
ShiftAllowanceOption
Possible values are:
|
timesheets[].costingData.allowances[].payCategory | string | String |
timesheets[].costingData.allowances[].payCategoryId | int32 | Int32 |
timesheets[].costingData.allowances[].rateMultiplier | double | Decimal |
timesheets[].costingData.allowances[].type | string |
ShiftAllowanceType
Possible values are:
|
timesheets[].costingData.allowances[].units | double | Decimal |
timesheets[].costingData.isConsolidated | boolean | Boolean |
timesheets[].costingData.liabilities[] | array | |
timesheets[].costingData.liabilities[].amount | double | Decimal |
timesheets[].costingData.liabilities[].cost | double | Decimal |
timesheets[].costingData.liabilities[].includeInShiftCost | boolean | Boolean |
timesheets[].costingData.liabilities[].liabilityCategoryId | int32 | Int32 |
timesheets[].costingData.liabilities[].liabilityCategoryName | string | String |
timesheets[].costingData.liabilities[].option | string |
ShiftAllowanceOption
Possible values are:
|
timesheets[].costingData.shiftParts[] | array | |
timesheets[].costingData.shiftParts[].actualDuration | string | TimeSpan |
timesheets[].costingData.shiftParts[].baseRate | double | Decimal |
timesheets[].costingData.shiftParts[].calculatedRate | double | Decimal |
timesheets[].costingData.shiftParts[].classification | object | NominalClassification |
timesheets[].costingData.shiftParts[].classification.id | int32 | Int32 |
timesheets[].costingData.shiftParts[].classification.name | string | String |
timesheets[].costingData.shiftParts[].classification.rank | int32 | Int32 |
timesheets[].costingData.shiftParts[].cost | double | Decimal |
timesheets[].costingData.shiftParts[].displayDuration | string | String |
timesheets[].costingData.shiftParts[].effectiveDuration | string | TimeSpan |
timesheets[].costingData.shiftParts[].endTime | date-time | DateTime |
timesheets[].costingData.shiftParts[].isAllowanceOrUnitBased | boolean | Boolean |
timesheets[].costingData.shiftParts[].isBreak | boolean | Boolean |
timesheets[].costingData.shiftParts[].isPaidBreak | boolean | Boolean |
timesheets[].costingData.shiftParts[].leaveCategory | object | NominalLeaveCategory |
timesheets[].costingData.shiftParts[].leaveCategory.id | int32 | Int32 |
timesheets[].costingData.shiftParts[].leaveCategory.name | string | String |
timesheets[].costingData.shiftParts[].location | object | NominalLocation |
timesheets[].costingData.shiftParts[].location.id | int32 | Int32 |
timesheets[].costingData.shiftParts[].location.name | string | String |
timesheets[].costingData.shiftParts[].location.state | string | String |
timesheets[].costingData.shiftParts[].payCategory | string | String |
timesheets[].costingData.shiftParts[].payCategoryId | int32 | Int32 |
timesheets[].costingData.shiftParts[].rateMultiplier | double |
Nullable |
timesheets[].costingData.shiftParts[].startTime | date-time | DateTime |
timesheets[].costingData.shiftParts[].workType | object | NominalWorkType |
timesheets[].costingData.shiftParts[].workType.id | int32 | Int32 |
timesheets[].costingData.shiftParts[].workType.linkType | string |
WorkTypeLinkTypeRestriction
Possible values are:
|
timesheets[].costingData.shiftParts[].workType.name | string | String |
timesheets[].costingDataByLocation | object | ShiftCostingData |
timesheets[].costingDataByLocation.allowances[] | array | |
timesheets[].costingDataByLocation.allowances[].classification | object | NominalClassification |
timesheets[].costingDataByLocation.allowances[].classification.id | int32 | Int32 |
timesheets[].costingDataByLocation.allowances[].classification.name | string | String |
timesheets[].costingDataByLocation.allowances[].classification.rank | int32 | Int32 |
timesheets[].costingDataByLocation.allowances[].cost | double | Decimal |
timesheets[].costingDataByLocation.allowances[].option | string |
ShiftAllowanceOption
Possible values are:
|
timesheets[].costingDataByLocation.allowances[].payCategory | string | String |
timesheets[].costingDataByLocation.allowances[].payCategoryId | int32 | Int32 |
timesheets[].costingDataByLocation.allowances[].rateMultiplier | double | Decimal |
timesheets[].costingDataByLocation.allowances[].type | string |
ShiftAllowanceType
Possible values are:
|
timesheets[].costingDataByLocation.allowances[].units | double | Decimal |
timesheets[].costingDataByLocation.isConsolidated | boolean | Boolean |
timesheets[].costingDataByLocation.liabilities[] | array | |
timesheets[].costingDataByLocation.liabilities[].amount | double | Decimal |
timesheets[].costingDataByLocation.liabilities[].cost | double | Decimal |
timesheets[].costingDataByLocation.liabilities[].includeInShiftCost | boolean | Boolean |
timesheets[].costingDataByLocation.liabilities[].liabilityCategoryId | int32 | Int32 |
timesheets[].costingDataByLocation.liabilities[].liabilityCategoryName | string | String |
timesheets[].costingDataByLocation.liabilities[].option | string |
ShiftAllowanceOption
Possible values are:
|
timesheets[].costingDataByLocation.shiftParts[] | array | |
timesheets[].costingDataByLocation.shiftParts[].actualDuration | string | TimeSpan |
timesheets[].costingDataByLocation.shiftParts[].baseRate | double | Decimal |
timesheets[].costingDataByLocation.shiftParts[].calculatedRate | double | Decimal |
timesheets[].costingDataByLocation.shiftParts[].classification | object | NominalClassification |
timesheets[].costingDataByLocation.shiftParts[].classification.id | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].classification.name | string | String |
timesheets[].costingDataByLocation.shiftParts[].classification.rank | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].cost | double | Decimal |
timesheets[].costingDataByLocation.shiftParts[].displayDuration | string | String |
timesheets[].costingDataByLocation.shiftParts[].effectiveDuration | string | TimeSpan |
timesheets[].costingDataByLocation.shiftParts[].endTime | date-time | DateTime |
timesheets[].costingDataByLocation.shiftParts[].isAllowanceOrUnitBased | boolean | Boolean |
timesheets[].costingDataByLocation.shiftParts[].isBreak | boolean | Boolean |
timesheets[].costingDataByLocation.shiftParts[].isPaidBreak | boolean | Boolean |
timesheets[].costingDataByLocation.shiftParts[].leaveCategory | object | NominalLeaveCategory |
timesheets[].costingDataByLocation.shiftParts[].leaveCategory.id | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].leaveCategory.name | string | String |
timesheets[].costingDataByLocation.shiftParts[].location | object | NominalLocation |
timesheets[].costingDataByLocation.shiftParts[].location.id | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].location.name | string | String |
timesheets[].costingDataByLocation.shiftParts[].location.state | string | String |
timesheets[].costingDataByLocation.shiftParts[].payCategory | string | String |
timesheets[].costingDataByLocation.shiftParts[].payCategoryId | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].rateMultiplier | double |
Nullable |
timesheets[].costingDataByLocation.shiftParts[].startTime | date-time | DateTime |
timesheets[].costingDataByLocation.shiftParts[].workType | object | NominalWorkType |
timesheets[].costingDataByLocation.shiftParts[].workType.id | int32 | Int32 |
timesheets[].costingDataByLocation.shiftParts[].workType.linkType | string |
WorkTypeLinkTypeRestriction
Possible values are:
|
timesheets[].costingDataByLocation.shiftParts[].workType.name | string | String |
timesheets[].dimensionValueIds[] | array of int32 | |
timesheets[].discard | boolean | Boolean |
timesheets[].durationOverride | string |
Nullable |
timesheets[].employeeId | int32 | Int32 |
timesheets[].employeeName | string | String |
timesheets[].end | date-time |
Nullable |
timesheets[].externalReferenceId | string | String |
timesheets[].hiddenComments | string | String |
timesheets[].id | int32 | Int32 |
timesheets[].ignoreRounding | boolean | Boolean |
timesheets[].isLocked | boolean | Boolean |
timesheets[].isOverlapping | boolean | Boolean |
timesheets[].isUnitBasedWorkType | boolean | Boolean |
timesheets[].leaveCategoryId | int32 |
Nullable |
timesheets[].leaveRequestId | int32 |
Nullable |
timesheets[].locationId | int32 |
Nullable |
timesheets[].locationIsDeleted | boolean | Boolean |
timesheets[].locationName | string | String |
timesheets[].overdrawsLeave | boolean | Boolean |
timesheets[].payCategoryId | int32 |
Nullable |
timesheets[].payRunId | int32 |
Nullable |
timesheets[].paySlipUrl | string | String |
timesheets[].rate | double |
Nullable |
timesheets[].readOnly | boolean | Boolean |
timesheets[].reviewedBy | string | String |
timesheets[].shiftConditionIds[] | array of int32 | |
timesheets[].source | string |
ExternalService
Possible values are:
|
timesheets[].start | date-time |
Nullable |
timesheets[].status | string |
TimesheetLineStatusType
Possible values are:
|
timesheets[].statusId | int32 | Int32 |
timesheets[].submittedEnd | date-time |
Nullable |
timesheets[].submittedStart | date-time |
Nullable |
timesheets[].totalDurationInMinutes | int32 | Int32 |
timesheets[].unitType | string | String |
timesheets[].units | double |
Nullable |
timesheets[].workDurationInMinutes | int32 | Int32 |
timesheets[].workTypeId | int32 |
Nullable |
timesheets[].workTypeName | string | String |