Evaluates shift costings for the employment agreement with the specified ID.

Request

POST https://keypay.yourpayroll.com.au/api/v2/business/{businessId}/employmentagreement/{id}/shiftcosting

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

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

{
    "employee": {
        "anniversaryDate": "date-time",
        "dateOfBirth": "date-time",
        "standardHoursPerWeek": "double",
        "tags": [
            "string"
        ]
    },
    "includeEvaluationResults": "boolean",
    "locationIdType": "string",
    "shifts": [
        {
            "attachmentId": "int32",
            "breaks": [
                {
                    "endTime": "date-time",
                    "startTime": "date-time"
                }
            ],
            "classificationId": "string",
            "comments": "string",
            "employeeId": "int32",
            "endTime": "date-time",
            "externalId": "string",
            "id": "int32",
            "leaveCategoryId": "string",
            "locationId": "string",
            "payCategoryId": "string",
            "rate": "double",
            "shiftConditionIds": [
                "string"
            ],
            "source": "string",
            "startTime": "date-time",
            "state": "string",
            "status": "string",
            "units": "double",
            "workTypeId": "string"
        }
    ],
    "transactionExternalId": "string",
    "workTypeIdType": "string"
}

Properties

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

Possible values are:

  • Standard
  • External
shifts[] array
shifts[].attachmentId int32 Nullable
shifts[].breaks[] array
shifts[].breaks[].endTime date-time Nullable
shifts[].breaks[].startTime date-time Nullable
shifts[].classificationId string String
shifts[].comments string String
shifts[].employeeId int32 Int32
shifts[].endTime date-time Nullable
shifts[].externalId string String
shifts[].id int32 Int32
shifts[].leaveCategoryId string String
shifts[].locationId string String
shifts[].payCategoryId string String
shifts[].rate double Nullable
shifts[].shiftConditionIds[] array of 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
shifts[].startTime date-time Nullable
shifts[].state string String
shifts[].status string String
shifts[].units double Nullable
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