Edits the timesheet with the specified ID.

Request

POST https://api.yourpayroll.com.au/api/v2/ess/{employeeId}/timesheet/{timesheetId}

Path parameters

Parameter name Value Description Additional
timesheetId int32 Required
employeeId string Required

Request body

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

{
    "attachment": {
        "dateCreated": "date-time",
        "friendlyName": "string",
        "id": "int32",
        "url": "string"
    },
    "breaks": [
        {
            "end": "date-time",
            "id": "int32",
            "start": "date-time",
            "submittedEnd": "date-time",
            "submittedStart": "date-time"
        }
    ],
    "classificationId": "int32",
    "classificationName": "string",
    "comments": "string",
    "cost": "double",
    "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",
                "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"
                }
            }
        ]
    },
    "discard": "boolean",
    "durationOverride": "string",
    "employeeId": "int32",
    "employeeName": "string",
    "end": "date-time",
    "externalReferenceId": "string",
    "id": "int32",
    "isLocked": "boolean",
    "isOverlapping": "boolean",
    "isUnitBasedWorkType": "boolean",
    "leaveCategoryId": "int32",
    "leaveRequestId": "int32",
    "locationId": "int32",
    "locationName": "string",
    "overdrawsLeave": "boolean",
    "payCategoryId": "int32",
    "payRunId": "int32",
    "paySlipUrl": "string",
    "rate": "double",
    "reviewedBy": "string",
    "shiftConditionIds": [
        "int32"
    ],
    "source": "string",
    "start": "date-time",
    "status": "string",
    "submittedEnd": "date-time",
    "submittedStart": "date-time",
    "unitType": "string",
    "units": "double",
    "workTypeId": "int32",
    "workTypeName": "string"
}

Properties

Name Type
attachment object
attachment.dateCreated date-time
attachment.friendlyName string
attachment.id int32
attachment.url string
breaks[] array
breaks[].end date-time
breaks[].id int32
breaks[].start date-time
breaks[].submittedEnd date-time
breaks[].submittedStart date-time
classificationId int32
classificationName string
comments string
cost double
costingData object
costingData.allowances[] array
costingData.allowances[].cost double
costingData.allowances[].option string
costingData.allowances[].payCategory string
costingData.allowances[].payCategoryId int32
costingData.allowances[].rateMultiplier double
costingData.allowances[].type string
costingData.allowances[].units double
costingData.isConsolidated boolean
costingData.liabilities[] array
costingData.liabilities[].amount double
costingData.liabilities[].cost double
costingData.liabilities[].includeInShiftCost boolean
costingData.liabilities[].liabilityCategoryId int32
costingData.liabilities[].liabilityCategoryName string
costingData.liabilities[].option string
costingData.shiftParts[] array
costingData.shiftParts[].actualDuration string
costingData.shiftParts[].baseRate double
costingData.shiftParts[].calculatedRate double
costingData.shiftParts[].classification object
costingData.shiftParts[].classification.id int32
costingData.shiftParts[].classification.name string
costingData.shiftParts[].classification.rank int32
costingData.shiftParts[].cost double
costingData.shiftParts[].effectiveDuration string
costingData.shiftParts[].endTime date-time
costingData.shiftParts[].isBreak boolean
costingData.shiftParts[].leaveCategory object
costingData.shiftParts[].leaveCategory.id int32
costingData.shiftParts[].leaveCategory.name string
costingData.shiftParts[].payCategory string
costingData.shiftParts[].payCategoryId int32
costingData.shiftParts[].rateMultiplier double
costingData.shiftParts[].startTime date-time
costingData.shiftParts[].workType object
costingData.shiftParts[].workType.id int32
costingData.shiftParts[].workType.linkType string
costingData.shiftParts[].workType.name string
discard boolean
durationOverride string
employeeId int32
employeeName string
end date-time
externalReferenceId string
id int32
isLocked boolean
isOverlapping boolean
isUnitBasedWorkType boolean
leaveCategoryId int32
leaveRequestId int32
locationId int32
locationName string
overdrawsLeave boolean
payCategoryId int32
payRunId int32
paySlipUrl string
rate double
reviewedBy string
shiftConditionIds[] array of int32
source string
start date-time
status string
submittedEnd date-time
submittedStart date-time
unitType string
units double
workTypeId int32
workTypeName string

Response

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

Status code Description Resource
200 OK

OK