NZ API Release Notes

Announcements
1

API Updated - 16/09/2019

Changes

  • definitions/EssEmployeeDetailsModel - Optional property hasConnectedDevices added: Optional property added

API Updated - 12/09/2019

Changes

  • definitions/AttachmentModel - Optional property dateScanned added: Optional property added
  • definitions/AttachmentModel - Optional property isInfected added: Optional property added

API Updated - 09/09/2019

Breaking changes

API Updated - 09/09/2019

Breaking changes

Changes

API Updated - 02/09/2019

Changes

  • definitions/NzPayCategoryModel - Optional property payCategoryType added: Optional property added

API Updated - 02/09/2019

Changes

API Updated - 01/09/2019

Changes

  • definitions/BankAccountEditModel - Optional property swift added: Optional property added
  • definitions/NzLeaveCategoryModel - Optional property useGrossPaymentRate added: Optional property added

API Updated - 26/08/2019

Changes

  • definitions/ActiveEmployeesModel - Optional property abn added: Optional property added

API Updated - 18/08/2019

Breaking changes

Changes

  • /api/v2/business/{businessId}/manager/rostershift/manage: Endpoint added
  • /api/v2/business/{businessId}/rostershift/create: Endpoint added
  • definitions/ExpenseRequestResponseModel - Optional property dateCreated added: Optional property added
  • definitions/EssExpenseRequestResponseModel - Optional property dateCreated added: Optional property added
  • definitions/ManagerExpenseRequestModel - Optional property dateCreated added: Optional property added

API Updated - 05/08/2019

Breaking changes

Changes

API Updated - 23/07/2019

Changes

  • definitions/NzUnstructuredEmployeeModel - Optional property employingEntityId added: Optional property added

API Updated - 09/07/2019

Changes

  • definitions/NzBankAccountModel - Optional property fullAccountNumber added: Optional property added

API Updated - 27/06/2019

Changes

  • definitions/NzUnstructuredEmployeeModel - Property isOverseasResidentialAddress deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Property isOverseasPostalAddress deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Optional property residentialAddressIsOverseas added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property postalAddressIsOverseas added: Optional property added

API Updated - 27/06/2019

Changes

  • definitions/NzUnstructuredEmployeeModel - Property residentialAddressIsOverseas deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Property postalAddressIsOverseas deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property isOverseasPostalAddress added: Optional property added

API Updated - 26/06/2019

Changes

  • definitions/NzUnstructuredEmployeeModel - Property isOverseasResidentialAddress deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Property isOverseasPostalAddress deleted: Property deleted
  • definitions/NzUnstructuredEmployeeModel - Optional property residentialAddressIsOverseas added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property postalAddressIsOverseas added: Optional property added

API Updated - 24/06/2019

Changes

  • definitions/NzBusinessExportModel - Optional property autoEnrolmentStagingDate added: Optional property added
  • definitions/EmployeeUpdateResponseModel - Optional property detailedStatus added: Optional property added
  • definitions/AvailableBusinessModel - Optional property autoEnrolmentStagingDate added: Optional property added

API Updated - 19/06/2019

Changes

  • definitions/NzUnstructuredEmployeeModel - Optional property residentialCountry added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property postalCountry added: Optional property added
  • definitions/NzUnstructuredEmployeeModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property residentialCountryId added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property postalCountryId added: Optional property added
  • definitions/EssEmployeeDetailsModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property residentialCountryId added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property postalCountryId added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property isOverseasResidentialAddress added: Optional property added
  • definitions/EmployeePartialEditModel - Optional property isOverseasPostalAddress added: Optional property added
  • definitions/PaygPaymentSummaryModel - Optional property payeeCountry added: Optional property added
  • definitions/NzApiPaySlipModel - Optional property employeePostalAddressCountry added: Optional property added

API Updated - 17/06/2019

Breaking changes

  • POST /api/v2/business: Response type changed
  • GET /api/v2/business/{businessId}: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source}: Response type changed
  • POST /api/v2/business/{businessId}/employingentity: Response type changed
  • GET /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leaveallowances: Response type changed
  • POST /api/v2/business/{businessId}/leavecategory: Response type changed
  • GET /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • GET /api/v2/business/{businessId}/location/{id}: Response type changed
  • GET /api/v2/business/{businessId}/paycategory/{id}: Response type changed
  • POST /api/v2/business/{businessId}/payratetemplate: Response type changed
  • GET /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/details: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payments: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payschedule/{id}: Response type changed
  • GET /api/v2/business/externalid: Response type changed
  • GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}: Response type changed

Changes

  • GET /api/v2/business/{businessId}/employee/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/employee: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/file/bankpayment/{paymentFileId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/report/kiwisaver: Endpoint added
  • /api/v2/business/{businessId}/report/paye: Endpoint added

API Updated - 17/06/2019

Breaking changes

  • POST /api/v2/business: Response type changed
  • GET /api/v2/business/{businessId}: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}: Endpoint deleted
  • GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source}: Response type changed
  • POST /api/v2/business/{businessId}/employingentity: Response type changed
  • GET /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leaveallowances: Response type changed
  • POST /api/v2/business/{businessId}/leavecategory: Response type changed
  • GET /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • GET /api/v2/business/{businessId}/location/{id}: Response type changed
  • GET /api/v2/business/{businessId}/paycategory/{id}: Response type changed
  • POST /api/v2/business/{businessId}/payratetemplate: Response type changed
  • GET /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/details: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payments: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payschedule/{id}: Response type changed
  • GET /api/v2/business/externalid: Response type changed
  • GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}: Response type changed

Changes

  • /api/v2/business/{businessId}/deductioncategory: Endpoint added
  • /api/v2/business/{businessId}/deductioncategory/{id}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/file/aba/{abaId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/report/leavehistory: Endpoint added
  • /api/v2/business/{businessId}/report/leaveliability: Endpoint added
  • /api/v2/business/{businessId}/report/payg: Endpoint added
  • /api/v2/business/{businessId}/report/payrolltax: Endpoint added
  • /api/v2/business/{businessId}/report/payrunactivity: Endpoint added
  • /api/v2/business/{businessId}/report/supercontributions/byemployee: Endpoint added
  • /api/v2/business/{businessId}/report/supercontributions/bysuperfund: Endpoint added
  • /api/v2/business/{businessId}/stpregister: Endpoint added

API Updated - 13/06/2019

Breaking changes

  • POST /api/v2/business: Response type changed
  • GET /api/v2/business/{businessId}: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source}: Response type changed
  • POST /api/v2/business/{businessId}/employingentity: Response type changed
  • GET /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leaveallowances: Response type changed
  • POST /api/v2/business/{businessId}/leavecategory: Response type changed
  • GET /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • GET /api/v2/business/{businessId}/location/{id}: Response type changed
  • GET /api/v2/business/{businessId}/paycategory/{id}: Response type changed
  • POST /api/v2/business/{businessId}/payratetemplate: Response type changed
  • GET /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/details: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payments: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payschedule/{id}: Response type changed
  • GET /api/v2/business/externalid: Response type changed
  • GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}: Response type changed

Changes

  • GET /api/v2/business/{businessId}/employee/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/employee: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/file/bankpayment/{paymentFileId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/kiwisaveradjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/payeadjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/report/kiwisaver: Endpoint added
  • /api/v2/business/{businessId}/report/paye: Endpoint added

API Updated - 13/06/2019

Breaking changes

  • POST /api/v2/business: Response type changed
  • GET /api/v2/business/{businessId}: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts: Response type changed
  • GET /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • POST /api/v2/business/{businessId}/chartofaccounts/location/{locationId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}: Endpoint deleted
  • GET /api/v2/business/{businessId}/employee/{employeeId}/bankaccount/{bankAccountId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalid/{externalId}: Response type changed
  • GET /api/v2/business/{businessId}/employee/unstructured/externalreferenceid/{externalReferenceId}/{source}: Response type changed
  • POST /api/v2/business/{businessId}/employingentity: Response type changed
  • GET /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/employingentity/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leaveallowances: Response type changed
  • POST /api/v2/business/{businessId}/leavecategory: Response type changed
  • GET /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/leavecategory/{id}: Response type changed
  • GET /api/v2/business/{businessId}/location/{id}: Response type changed
  • GET /api/v2/business/{businessId}/paycategory/{id}: Response type changed
  • POST /api/v2/business/{businessId}/payratetemplate: Response type changed
  • GET /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • PUT /api/v2/business/{businessId}/payratetemplate/{id}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/details: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/earningslines/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payments: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/payslips/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals: Response type changed
  • GET /api/v2/business/{businessId}/payrun/{payRunId}/totals/{employeeId}: Response type changed
  • GET /api/v2/business/{businessId}/payschedule/{id}: Response type changed
  • GET /api/v2/business/externalid: Response type changed
  • GET /api/v2/ess/{employeeId}/bankaccounts/{bankAccountId}: Response type changed

Changes

  • /api/v2/business/{businessId}/deductioncategory: Endpoint added
  • /api/v2/business/{businessId}/deductioncategory/{id}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/file/aba/{abaId}: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments: Endpoint added
  • /api/v2/business/{businessId}/payrun/{payRunId}/paygadjustments/{employeeId}: Endpoint added
  • /api/v2/business/{businessId}/report/leavehistory: Endpoint added
  • /api/v2/business/{businessId}/report/leaveliability: Endpoint added
  • /api/v2/business/{businessId}/report/payg: Endpoint added
  • /api/v2/business/{businessId}/report/payrolltax: Endpoint added
  • /api/v2/business/{businessId}/report/payrunactivity: Endpoint added
  • /api/v2/business/{businessId}/report/supercontributions/byemployee: Endpoint added
  • /api/v2/business/{businessId}/report/supercontributions/bysuperfund: Endpoint added
  • /api/v2/business/{businessId}/stpregister: Endpoint added

Release notes placeholder