Create PAYE Adjustments

Adds PAYE adjustments to the specified pay run.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

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

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

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

Response

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

Status code Description Resource
200 OK

OK