Sets the opening balances for this employee.



Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

    "accLevyAmount": "double",
    "deductions": [
            "amount": "double",
            "deductionCategoryId": "int32",
            "name": "string",
            "taxExempt": "boolean"
    "earningsLines": [
            "amount": "double",
            "isStandardPayCategory": "boolean",
            "name": "string",
            "payCategoryId": "int32",
            "payCategoryType": "string"
    "employeeId": "int32",
    "employerLiabilities": [
            "amount": "double",
            "employerLiabilityCategoryId": "int32",
            "name": "string"
    "financialYearStartingYear": "int32",
    "grossEarnings": "double",
    "kiwiSaver": {
        "employeeContributionAmount": "double",
        "employerContributionAmount": "double",
        "esctAmount": "double"
    "leaveBalances": [
            "amount": "double",
            "leaveCategoryId": "int32",
            "name": "string",
            "unitType": "string"
    "locationName": "string",
    "payeWithholdingAmount": "double",
    "studentLoanAmount": "double",
    "totalHours": "double"


Name Type Description
accLevyAmount double Nullable
deductions[] array
deductions[].amount double Decimal
deductions[].deductionCategoryId int32 Int32
deductions[].name string String
deductions[].taxExempt boolean Boolean
earningsLines[] array
earningsLines[].amount double Decimal
earningsLines[].isStandardPayCategory boolean Boolean
earningsLines[].name string String
earningsLines[].payCategoryId int32 Int32
earningsLines[].payCategoryType string NzPayCategoryType

Possible values are:

  • Standard
  • OpeningBalanceAllowances
  • ExtraPay
  • RedundancyPayRetirementAllowance
  • AnnualHolidaysCashOut
  • HolidayPay
  • AccLevy
  • AverageEarnings
  • TerminationHolidayPay
  • TerminationAverageEarnings
  • TerminationRelevantDailyPay
  • RelevantDailyPay
  • TerminationPublicHolidayPay
  • GST
  • PublicHolidayWorked
  • PublicHolidayNotWorked
employeeId int32 Nullable
employerLiabilities[] array
employerLiabilities[].amount double Decimal
employerLiabilities[].employerLiabilityCategoryId int32 Int32
employerLiabilities[].name string String
financialYearStartingYear int32 Nullable
grossEarnings double Nullable
kiwiSaver object OpeningKiwiSaverModel
kiwiSaver.employeeContributionAmount double Decimal
kiwiSaver.employerContributionAmount double Decimal
kiwiSaver.esctAmount double Decimal
leaveBalances[] array
leaveBalances[].amount double Decimal
leaveBalances[].leaveCategoryId int32 Int32
leaveBalances[].name string String
leaveBalances[].unitType string LeaveUnitTypeEnum

Possible values are:

  • Hours
  • Days
  • Weeks
locationName string String
payeWithholdingAmount double Nullable
studentLoanAmount double Nullable
totalHours double Nullable


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

Status code Description Resource
200 OK