Create Deductions

Add deductions to the specified pay run.

Request

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

Path parameters

Parameter name Value Description Additional
payRunId int32 Required
businessId string Required

Request body

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

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

Properties

Name Type Description
deductionCategoryIdType string IdType

Possible values are:

  • Standard
  • External
deductions object Dictionary
deductions.<key> map of array List
deductions.<key>.additionalData int32 Nullable
deductions.<key>.amount double Decimal
deductions.<key>.associatedEmployeeDeductionCategoryId int32 Nullable
deductions.<key>.deductionCategoryId string String
deductions.<key>.deductionCategoryName string String
deductions.<key>.employeeExternalId string String
deductions.<key>.employeeId string String
deductions.<key>.employeeName string String
deductions.<key>.externalId string String
deductions.<key>.id int32 Int32
deductions.<key>.locationId string String
deductions.<key>.locationName string String
deductions.<key>.note string String
deductions.<key>.notes string String
deductions.<key>.payTo string String
deductions.<key>.payToBankAccountBSB string String
deductions.<key>.payToBankAccountBankCode string String
deductions.<key>.payToBankAccountNumber string String
deductions.<key>.payToBankAccountSwift string String
deductions.<key>.payToSuperFundMemberNumber string String
deductions.<key>.payToSuperFundName string String
deductions.<key>.paymentReference string String
employeeIdType string IdType

Possible values are:

  • Standard
  • External
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