Update Employee Deduction

Updates the employee's recurring deduction with the specified ID.

Request

PUT https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/{employeeId}/deduction/{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 NzEmployeeRecurringDeductionModel resource, containing the following writable properties:

{
    "additionalData": "int32",
    "amount": "double",
    "carryForwardUnpaidDeductions": "boolean",
    "carryForwardUnusedPreservedEarnings": "boolean",
    "deductionCategoryId": "int32",
    "deductionType": "string",
    "deleted": "boolean",
    "employeeId": "int32",
    "expiryDate": "date-time",
    "externalReferenceId": "string",
    "fromDate": "date-time",
    "id": "int32",
    "isActive": "boolean",
    "maximumAmountPaid": "double",
    "name": "string",
    "notes": "string",
    "paidTo": "string",
    "paidToAccountId": "int32",
    "paymentReference": "string",
    "preservedEarnings": "string",
    "preservedEarningsAmount": "double",
    "preservedEarningsAmountNotReachedAction": "string",
    "priority": "int32",
    "studentLoanDeductionOption": "string",
    "totalAmountPaid": "double"
}

Properties

Name Type Description
additionalData int32 Nullable
amount double Decimal
carryForwardUnpaidDeductions boolean Boolean
carryForwardUnusedPreservedEarnings boolean Boolean
deductionCategoryId int32 Int32
deductionType string DeductionTypeEnum

Possible values are:

  • NotSet
  • Fixed
  • PercentageGross
  • PercentageOTE
  • PercentageStudentLoan
  • PercentageNet
  • Tiered
  • Custom
  • PercentageSuperannuation
deleted boolean Boolean
employeeId int32 Int32
expiryDate date-time Nullable
externalReferenceId string String
fromDate date-time DateTime
id int32 Nullable
isActive boolean Boolean
maximumAmountPaid double Nullable
name string String
notes string String
paidTo string NzEmployeeRecurringDeductionPaidToEnum

Possible values are:

  • Manual
  • BankAccount
  • SuperFund
  • Bpay
  • PensionScheme
  • TaxOffice
  • CPFB
paidToAccountId int32 Int32
paymentReference string String
preservedEarnings string PreservedEarningsCalculationTypeEnum

Possible values are:

  • Never
  • Amount
  • Percentage
preservedEarningsAmount double Decimal
preservedEarningsAmountNotReachedAction string DeductionAmountNotReachedEnum

Possible values are:

  • DoNotPay
  • PayToLimit
priority int32 Nullable
studentLoanDeductionOption string Nullable

Possible values are:

  • ApplyStudentLoanFirst
  • ApplyDeductionFirst
  • DoNotApplyStudentLoan
totalAmountPaid double Decimal

Response

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

Status code Description Resource
200 OK

OK

 NzEmployeeRecurringDeductionModel