Get Shift Costings for Employee

Gets the shift costings for the specified employee.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftcosting

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "employee": {
        "anniversaryDate": "date-time",
        "dateOfBirth": "date-time",
        "name": "string",
        "standardHoursPerDay": "double",
        "standardHoursPerWeek": "double",
        "tags": [
            "string"
        ]
    },
    "includeEvaluationResults": "boolean",
    "locationIdType": "string",
    "overrideRates": [
        {
            "payCategoryId": "int32",
            "rate": "double",
            "useRateAsIs": "boolean"
        }
    ],
    "shifts": [
        {
            "attachment": {
                "data": "byte",
                "dateCreated": "date-time",
                "dateScanned": "date-time",
                "friendlyName": "string",
                "id": "int32",
                "isDeleted": "boolean",
                "isInfected": "boolean",
                "url": "string"
            },
            "attachmentId": "int32",
            "breaks": [
                {
                    "endTime": "date-time",
                    "isPaidBreak": "boolean",
                    "startTime": "date-time"
                }
            ],
            "classification": "string",
            "classificationId": "string",
            "comments": "string",
            "dimensionValueIds": [
                "int32"
            ],
            "employeeId": "int32",
            "endTime": "date-time",
            "externalId": "string",
            "fullyQualifiedLocationName": "string",
            "hiddenComments": "string",
            "id": "int32",
            "leaveCategoryId": "string",
            "locationId": "string",
            "locationIsDeleted": "boolean",
            "overrideRates": [
                {
                    "payCategoryId": "int32",
                    "rate": "double",
                    "useRateAsIs": "boolean"
                }
            ],
            "payCategoryId": "string",
            "rate": "double",
            "shiftConditionIds": [
                "string"
            ],
            "shiftConditions": [
                {
                    "id": "int32",
                    "name": "string"
                }
            ],
            "source": "string",
            "startTime": "date-time",
            "state": "string",
            "status": "string",
            "submittedByUser": "string",
            "units": "double",
            "workType": "string",
            "workTypeId": "string"
        }
    ],
    "transactionExternalId": "string",
    "workTypeIdType": "string"
}

Properties

Name Type Description
employee object ShiftCostingsEmployeeModel
employee.anniversaryDate date-time Nullable
employee.dateOfBirth date-time Nullable
employee.name string String
employee.standardHoursPerDay double Nullable
employee.standardHoursPerWeek double Nullable
employee.tags[] array of string
includeEvaluationResults boolean Boolean
locationIdType string IdType

Possible values are:

  • Standard
  • External
overrideRates[] array
overrideRates[].payCategoryId int32 Int32
overrideRates[].rate double Decimal
overrideRates[].useRateAsIs boolean

Nullable

Note:If set to "true", the system assumes the Rate value is inclusive of rate loading and penalty loading.
shifts[] array
shifts[].attachment object Attachment
shifts[].attachment.data byte Byte[]
shifts[].attachment.dateCreated date-time Nullable
shifts[].attachment.dateScanned date-time Nullable
shifts[].attachment.friendlyName string String
shifts[].attachment.id int32 Nullable
shifts[].attachment.isDeleted boolean Boolean
shifts[].attachment.isInfected boolean Nullable
shifts[].attachment.url string String
shifts[].attachmentId int32 Nullable
shifts[].breaks[] array
shifts[].breaks[].endTime date-time Nullable
shifts[].breaks[].isPaidBreak boolean Boolean
shifts[].breaks[].startTime date-time Nullable
shifts[].classification string String
shifts[].classificationId string String
shifts[].comments string String
shifts[].dimensionValueIds[] array of int32
shifts[].employeeId int32 Int32
shifts[].endTime date-time Nullable
shifts[].externalId string String
shifts[].fullyQualifiedLocationName string String
shifts[].hiddenComments string String
shifts[].id int32 Int32
shifts[].leaveCategoryId string String
shifts[].locationId string String
shifts[].locationIsDeleted boolean Boolean
shifts[].overrideRates[] array
shifts[].overrideRates[].payCategoryId int32 Int32
shifts[].overrideRates[].rate double Decimal
shifts[].overrideRates[].useRateAsIs boolean

Nullable

Note:If set to "true", the system assumes the Rate value is inclusive of rate loading and penalty loading.
shifts[].payCategoryId string String
shifts[].rate double Nullable
shifts[].shiftConditionIds[] array of string
shifts[].shiftConditions[] array
shifts[].shiftConditions[].id int32 Int32
shifts[].shiftConditions[].name string String
shifts[].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
  • QBOMigrationTool
  • AbridgedFileImport
  • QBOForcedMigration
  • HmrcDpsUpdate
  • HmrcDpsStudentLoan
  • HmrcDpsPostGradLoan
  • Sage50FileImporter
  • FPSFileImporter
  • OAuth
  • FreshBooks
  • StarFileImporter
  • ActiveCampaign
  • SummaryAndDetailsExport
  • Telleroo
  • EmployeeAdvancedHoursUpload
  • BusinessCentral
  • Paytron
  • AccessFinancials
  • Comma
  • Zoho
  • FlatFileEmployeeImporter
  • Twinfield
  • SageAccounting
  • Square
  • Quickfile
  • Tide
  • TideSso
  • FreeAgent
  • Akahu
  • InstaPay
  • Zepto
  • Slack
  • Caxton
  • QuickbooksStandalonePayroll
  • ImportEmployeeSelfSetup
  • XeroIdentityPayrollSignUp
  • XeroIdentityHrSignUp
  • SageIntacct
  • InstaPayDaily
  • Salesforce
  • AutomatedPublicHolidayNotWorked
  • EmployeePayRatesUpload
  • Zapier
  • StapledSuperFund
  • Swag
shifts[].startTime date-time Nullable
shifts[].state string String
shifts[].status string String
shifts[].submittedByUser string String
shifts[].units double Nullable
shifts[].workType string String
shifts[].workTypeId string String
transactionExternalId string String
workTypeIdType string IdType

Possible values are:

  • Standard
  • External

Response

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

Status code Description Resource
200 OK

OK

 ShiftCostingsResponseModel