Adds PAYG adjustments to the specified pay run.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

{
    "employeeIdType": "string",
    "payRunId": "int32",
    "paygAdjustments": {
        "<key>": "array"
    },
    "replaceExisting": "boolean",
    "suppressCalculations": "boolean"
}

Properties

Name Type
employeeIdType string
payRunId int32
paygAdjustments object
paygAdjustments.<key> map of array
paygAdjustments.<key>.amount double
paygAdjustments.<key>.employeeId string
paygAdjustments.<key>.employeeName string
paygAdjustments.<key>.externalId string
paygAdjustments.<key>.locationId string
paygAdjustments.<key>.locationName string
paygAdjustments.<key>.notes string
replaceExisting boolean
suppressCalculations boolean

Response

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

Status code Description Resource
200 OK

OK