Methods

  • get - Get Business Timesheets

Resource

{
    "currentPage": "int32",
    "itemCount": "int32",
    "itemCountFuture": {
        "value": "int32"
    },
    "items": [
        {
            "attachment": {
                "dateCreated": "date-time",
                "dateScanned": "date-time",
                "friendlyName": "string",
                "id": "int32",
                "isInfected": "boolean",
                "url": "string"
            },
            "breaks": [
                {
                    "end": "date-time",
                    "formattedEnd": "string",
                    "formattedStart": "string",
                    "id": "int32",
                    "start": "date-time",
                    "submittedEnd": "date-time",
                    "submittedStart": "date-time"
                }
            ],
            "breaksDurationInMinutes": "double",
            "canApprove": "boolean",
            "canDelete": "boolean",
            "canEdit": "boolean",
            "canEditNotesOnly": "boolean",
            "canViewCosts": "boolean",
            "classificationId": "int32",
            "classificationName": "string",
            "comments": "string",
            "cost": "double",
            "costFormatted": "string",
            "costingData": {
                "allowances": [
                    {
                        "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",
                        "isBreak": "boolean",
                        "leaveCategory": {
                            "id": "int32",
                            "name": "string"
                        },
                        "payCategory": "string",
                        "payCategoryId": "int32",
                        "rateMultiplier": "double",
                        "startTime": "date-time",
                        "workType": {
                            "id": "int32",
                            "linkType": "string",
                            "name": "string"
                        }
                    }
                ]
            },
            "defaultLocationId": "int32",
            "defaultLocationName": "string",
            "discard": "boolean",
            "durationOverride": "string",
            "employeeGroups": [
                {
                    "id": "int32",
                    "name": "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",
            "locationName": "string",
            "overdrawsLeave": "boolean",
            "payCategoryId": "int32",
            "payRunId": "int32",
            "payScheduleId": "int32",
            "payScheduleName": "string",
            "paySlipUrl": "string",
            "rate": "double",
            "readOnly": "boolean",
            "reviewedBy": "string",
            "shiftConditions": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "source": "string",
            "start": "date-time",
            "status": "string",
            "submittedEnd": "date-time",
            "submittedStart": "date-time",
            "terminationDate": "date-time",
            "totalDurationInMinutes": "double",
            "unitType": "string",
            "units": "double",
            "workDurationInMinutes": "double",
            "workTypeId": "int32",
            "workTypeName": "string"
        }
    ],
    "pageCount": "int32",
    "pageSize": "int32"
}

Properties

Name Type Description
currentPage int32 Int32
itemCount int32 Int32
itemCountFuture object IFutureValue
itemCountFuture.value int32 Int32
items[] array
items[].attachment object AttachmentModel
items[].attachment.dateCreated date-time Nullable
items[].attachment.dateScanned date-time Nullable
items[].attachment.friendlyName string String
items[].attachment.id int32 Nullable
items[].attachment.isInfected boolean Nullable
items[].attachment.url string String
items[].breaks[] array
items[].breaks[].end date-time Nullable
items[].breaks[].formattedEnd string String
items[].breaks[].formattedStart string String
items[].breaks[].id int32 Int32
items[].breaks[].start date-time Nullable
items[].breaks[].submittedEnd date-time Nullable
items[].breaks[].submittedStart date-time Nullable
items[].breaksDurationInMinutes double Double
items[].canApprove boolean Boolean
items[].canDelete boolean Boolean
items[].canEdit boolean Boolean
items[].canEditNotesOnly boolean Boolean
items[].canViewCosts boolean Boolean
items[].classificationId int32 Nullable
items[].classificationName string String
items[].comments string String
items[].cost double Nullable
items[].costFormatted string String
items[].costingData object ShiftCostingData
items[].costingData.allowances[] array
items[].costingData.allowances[].cost double Decimal
items[].costingData.allowances[].option string ShiftAllowanceOption

Possible values are:

  • Fixed
  • PerHourWorked
  • PercentageOfShiftCost
  • PerShiftUnit
items[].costingData.allowances[].payCategory string String
items[].costingData.allowances[].payCategoryId int32 Int32
items[].costingData.allowances[].rateMultiplier double Decimal
items[].costingData.allowances[].type string ShiftAllowanceType

Possible values are:

  • Standard
  • AllPurpose
items[].costingData.allowances[].units double Decimal
items[].costingData.isConsolidated boolean Boolean
items[].costingData.liabilities[] array
items[].costingData.liabilities[].amount double Decimal
items[].costingData.liabilities[].cost double Decimal
items[].costingData.liabilities[].includeInShiftCost boolean Boolean
items[].costingData.liabilities[].liabilityCategoryId int32 Int32
items[].costingData.liabilities[].liabilityCategoryName string String
items[].costingData.liabilities[].option string ShiftAllowanceOption

Possible values are:

  • Fixed
  • PerHourWorked
  • PercentageOfShiftCost
  • PerShiftUnit
items[].costingData.shiftParts[] array
items[].costingData.shiftParts[].actualDuration string TimeSpan
items[].costingData.shiftParts[].baseRate double Decimal
items[].costingData.shiftParts[].calculatedRate double Decimal
items[].costingData.shiftParts[].classification object NominalClassification
items[].costingData.shiftParts[].classification.id int32 Int32
items[].costingData.shiftParts[].classification.name string String
items[].costingData.shiftParts[].classification.rank int32 Int32
items[].costingData.shiftParts[].cost double Decimal
items[].costingData.shiftParts[].displayDuration string String
items[].costingData.shiftParts[].effectiveDuration string TimeSpan
items[].costingData.shiftParts[].endTime date-time DateTime
items[].costingData.shiftParts[].isBreak boolean Boolean
items[].costingData.shiftParts[].leaveCategory object NominalLeaveCategory
items[].costingData.shiftParts[].leaveCategory.id int32 Int32
items[].costingData.shiftParts[].leaveCategory.name string String
items[].costingData.shiftParts[].payCategory string String
items[].costingData.shiftParts[].payCategoryId int32 Int32
items[].costingData.shiftParts[].rateMultiplier double Nullable
items[].costingData.shiftParts[].startTime date-time DateTime
items[].costingData.shiftParts[].workType object NominalWorkType
items[].costingData.shiftParts[].workType.id int32 Int32
items[].costingData.shiftParts[].workType.linkType string WorkTypeLinkTypeRestriction

Possible values are:

  • PayCategory
  • LeaveCategory
  • ShiftCondition
items[].costingData.shiftParts[].workType.name string String
items[].defaultLocationId int32 Int32
items[].defaultLocationName string String
items[].discard boolean Boolean
items[].durationOverride string Nullable
items[].employeeGroups[] array
items[].employeeGroups[].id int32 Int32
items[].employeeGroups[].name string String
items[].employeeId int32 Int32
items[].employeeName string String
items[].end date-time Nullable
items[].externalReferenceId string String
items[].hiddenComments string String
items[].id int32 Int32
items[].ignoreRounding boolean Boolean
items[].isLocked boolean Boolean
items[].isOverlapping boolean Boolean
items[].isUnitBasedWorkType boolean Boolean
items[].leaveCategoryId int32 Nullable
items[].leaveRequestId int32 Nullable
items[].locationId int32 Nullable
items[].locationName string String
items[].overdrawsLeave boolean Boolean
items[].payCategoryId int32 Nullable
items[].payRunId int32 Nullable
items[].payScheduleId int32 Int32
items[].payScheduleName string String
items[].paySlipUrl string String
items[].rate double Nullable
items[].readOnly boolean Boolean
items[].reviewedBy string String
items[].shiftConditions[] array
items[].shiftConditions[].id int32 Int32
items[].shiftConditions[].name string String
items[].source string ExternalService

Possible values are:

  • None
  • Saasu
  • Xero
  • MYOB
  • Deputy
  • EmployeeTimePunch
  • ClickSuper
  • IntegratedTimesheets
  • FileImport
  • FileExport
  • QuickBooks
  • Harmony
  • AwardStore
  • Attache
  • IntegratedRostering
  • ReckonAccounts
  • API
  • MicroPower
  • RosterLive
  • NetSuite
  • Kounta
  • TimeAndAttendanceKiosk
  • DetailedFileExport
  • JonasPremier
  • WageEasy
  • Maestrano
  • WorkZone
  • EmployeePortal
  • RosterTemplate
  • Onboarding
  • Admin
  • WorkZoneClockOnOff
  • NetSuiteOneWorld
  • Sage50
  • PensionSync
  • FinancialsOffice
  • ProntoXI
  • PayRunDefault
  • StandardWorkDay
  • Beam
  • PayRunAutomation
  • BureauDashboard
  • Wiise
items[].start date-time Nullable
items[].status string TimesheetLineStatusType

Possible values are:

  • Missing
  • Submitted
  • Approved
  • Rejected
  • Processed
  • AnyExceptRejected
items[].submittedEnd date-time Nullable
items[].submittedStart date-time Nullable
items[].terminationDate date-time Nullable
items[].totalDurationInMinutes double Double
items[].unitType string String
items[].units double Nullable
items[].workDurationInMinutes double Double
items[].workTypeId int32 Nullable
items[].workTypeName string String
pageCount int32 Int32
pageSize int32 Int32