Update Employee Tax Adjustment

Updates the employee's recurring tax adjustment with the specified ID.

Request

PUT https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/{employeeId}/taxadjustment/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required
employeeId string Required

Request body

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

{
    "adjustmentType": "string",
    "amount": "double",
    "employeeId": "int32",
    "expiryDate": "date-time",
    "fromDate": "date-time",
    "id": "int32",
    "isActive": "boolean",
    "maximumAmountPaid": "double",
    "notes": "string",
    "totalAmountPaid": "double"
}

Properties

Name Type Description
adjustmentType string TaxAdjustmentTypeEnum

Possible values are:

  • Fixed
  • PercentageGross
  • PercentageTaxableEarnings
amount double Decimal
employeeId int32 Int32
expiryDate date-time Nullable
fromDate date-time DateTime
id int32 Nullable
isActive boolean Boolean
maximumAmountPaid double Nullable
notes string String
totalAmountPaid double Decimal

Response

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

Status code Description Resource
200 OK

OK

 EmployeeRecurringTaxAdjustmentModel