Adds super adjustments to the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

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

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
payRunId int32 Int32
replaceExisting boolean Boolean
superAdjustments object Dictionary
superAdjustments.<key> map of array List
superAdjustments.<key>.amount double Decimal
superAdjustments.<key>.contributionType string String
superAdjustments.<key>.employeeExternalId string String
superAdjustments.<key>.employeeId string String
superAdjustments.<key>.employeeName string String
superAdjustments.<key>.externalId string String
superAdjustments.<key>.id int32 Int32
superAdjustments.<key>.locationId string String
superAdjustments.<key>.locationName string String
superAdjustments.<key>.notes string String
suppressCalculations boolean Boolean

Response

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

Status code Description Resource
200 OK

OK