Create KiwiSaver Adjustments

Adds KiwiSaver adjustments to the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

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

Properties

Name Type Description
employeeIdType string IdType

Possible values are:

  • Standard
  • External
kiwiSaverAdjustments object Dictionary
kiwiSaverAdjustments.<key> map of array List
kiwiSaverAdjustments.<key>.amount double Decimal
kiwiSaverAdjustments.<key>.contributionType string String
kiwiSaverAdjustments.<key>.employeeExternalId string String
kiwiSaverAdjustments.<key>.employeeId string String
kiwiSaverAdjustments.<key>.employeeName string String
kiwiSaverAdjustments.<key>.externalId string String
kiwiSaverAdjustments.<key>.id int32 Int32
kiwiSaverAdjustments.<key>.locationId string String
kiwiSaverAdjustments.<key>.locationName string String
kiwiSaverAdjustments.<key>.notes string String
payRunId int32 Int32
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