Update Employing Entity

Updates the employing entity with the specified ID.

Request

PUT https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employingentity/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

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

{
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "charitableOrganisation": "boolean",
    "city": "string",
    "contactEmailAddress": "string",
    "contactFaxNumber": "string",
    "contactName": "string",
    "contactPhoneNumber": "string",
    "employerDeductionFilingFrequency": "string",
    "externalReferenceId": "string",
    "id": "int32",
    "irdNumber": "string",
    "name": "string",
    "nzbn": "string",
    "paySlipFromEmailAddress": "string",
    "postcode": "string",
    "region": "string",
    "signatoryName": "string"
}

Properties

Name Type Description
addressLine1 string String
addressLine2 string String
addressLine3 string String
charitableOrganisation boolean Boolean
city string String
contactEmailAddress string String
contactFaxNumber string String
contactName string String
contactPhoneNumber string String
employerDeductionFilingFrequency string Nullable

Possible values are:

  • BiMonthly
  • Monthly
externalReferenceId string String
id int32 Int32
irdNumber string String
name string String
nzbn string String
paySlipFromEmailAddress string String
postcode string String
region string String
signatoryName string String

Response

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

Status code Description Resource
200 OK

OK

 NzEmployingEntityModel