Update Chart of Accounts

Updates the default chart of accounts configuration for the business.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/chartofaccounts

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "deductionCategories": [
        {
            "expenseAccountId": "int32",
            "id": "int32",
            "liabilityAccountId": "int32",
            "name": "string",
            "splitByLocation": "boolean"
        }
    ],
    "defaultAccounts": {
        "defaultExpenseAccountId": "int32",
        "defaultExpenseSplit": "string",
        "defaultExpenseSplitByLocation": "boolean",
        "defaultLiabilityAccountId": "int32",
        "defaultLiabilitySplit": "string",
        "defaultLiabilitySplitByLocation": "boolean",
        "employeeExpenseAccountId": "int32",
        "employeeExpenseSplit": "string",
        "employeeExpenseSplitByLocation": "boolean",
        "employerLiabilityExpenseAccountId": "int32",
        "employerLiabilityExpenseSplit": "string",
        "employerLiabilityExpenseSplitByLocation": "boolean",
        "employerLiabilityLiabilityAccountId": "int32",
        "employerLiabilityLiabilitySplit": "string",
        "employerLiabilityLiabilitySplitByLocation": "boolean",
        "kiwiSaverEmployeeLiabilityAccountId": "int32",
        "kiwiSaverEmployeeLiabilitySplit": "string",
        "kiwiSaverEmployeeLiabilitySplitByLocation": "boolean",
        "kiwiSaverEmployerExpenseAccountId": "int32",
        "kiwiSaverEmployerExpenseSplit": "string",
        "kiwiSaverEmployerExpenseSplitByLocation": "boolean",
        "kiwiSaverEmployerLiabilityAccountId": "int32",
        "kiwiSaverEmployerLiabilitySplit": "string",
        "kiwiSaverEmployerLiabilitySplitByLocation": "boolean",
        "payeExpenseAccountId": "int32",
        "payeExpenseSplit": "string",
        "payeExpenseSplitByLocation": "boolean",
        "payeLiabilityAccountId": "int32",
        "payeLiabilityAccountSplit": "string",
        "payeLiabilityAccountSplitByLocation": "boolean",
        "paymentAccountId": "int32",
        "paymentAccountSplit": "string",
        "paymentAccountSplitByLocation": "boolean",
        "studentLoanLiabilityAccountId": "int32",
        "studentLoanLiabilitySplit": "string",
        "studentLoanLiabilitySplitByLocation": "boolean"
    },
    "employeeExpenseCategories": [
        {
            "expenseAccountId": "int32",
            "id": "int32",
            "name": "string",
            "splitByLocation": "boolean"
        }
    ],
    "employerLiabilityCategories": [
        {
            "expenseAccountId": "int32",
            "id": "int32",
            "liabilityAccountId": "int32",
            "name": "string",
            "splitByLocation": "boolean"
        }
    ],
    "payCategories": [
        {
            "expenseAccountId": "int32",
            "id": "int32",
            "name": "string",
            "splitByLocation": "boolean"
        }
    ]
}

Properties

Name Type Description
deductionCategories[] array
deductionCategories[].expenseAccountId int32 Nullable
deductionCategories[].id int32 Int32
deductionCategories[].liabilityAccountId int32 Nullable
deductionCategories[].name string String
deductionCategories[].splitByLocation boolean Boolean
defaultAccounts object NzChartOfAccountsDefaultAccountsModel
defaultAccounts.defaultExpenseAccountId int32 Nullable
defaultAccounts.defaultExpenseSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.defaultExpenseSplitByLocation boolean Boolean
defaultAccounts.defaultLiabilityAccountId int32 Nullable
defaultAccounts.defaultLiabilitySplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.defaultLiabilitySplitByLocation boolean Boolean
defaultAccounts.employeeExpenseAccountId int32 Nullable
defaultAccounts.employeeExpenseSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.employeeExpenseSplitByLocation boolean Boolean
defaultAccounts.employerLiabilityExpenseAccountId int32 Nullable
defaultAccounts.employerLiabilityExpenseSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.employerLiabilityExpenseSplitByLocation boolean Boolean
defaultAccounts.employerLiabilityLiabilityAccountId int32 Nullable
defaultAccounts.employerLiabilityLiabilitySplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.employerLiabilityLiabilitySplitByLocation boolean Boolean
defaultAccounts.kiwiSaverEmployeeLiabilityAccountId int32 Nullable
defaultAccounts.kiwiSaverEmployeeLiabilitySplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.kiwiSaverEmployeeLiabilitySplitByLocation boolean Boolean
defaultAccounts.kiwiSaverEmployerExpenseAccountId int32 Nullable
defaultAccounts.kiwiSaverEmployerExpenseSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.kiwiSaverEmployerExpenseSplitByLocation boolean Boolean
defaultAccounts.kiwiSaverEmployerLiabilityAccountId int32 Nullable
defaultAccounts.kiwiSaverEmployerLiabilitySplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.kiwiSaverEmployerLiabilitySplitByLocation boolean Boolean
defaultAccounts.payeExpenseAccountId int32 Nullable
defaultAccounts.payeExpenseSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.payeExpenseSplitByLocation boolean Boolean
defaultAccounts.payeLiabilityAccountId int32 Nullable
defaultAccounts.payeLiabilityAccountSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.payeLiabilityAccountSplitByLocation boolean Boolean
defaultAccounts.paymentAccountId int32 Nullable
defaultAccounts.paymentAccountSplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.paymentAccountSplitByLocation boolean Boolean
defaultAccounts.studentLoanLiabilityAccountId int32 Nullable
defaultAccounts.studentLoanLiabilitySplit string AccountSplit

Possible values are:

  • None
  • Location
  • EmployingEntity
defaultAccounts.studentLoanLiabilitySplitByLocation boolean Boolean
employeeExpenseCategories[] array
employeeExpenseCategories[].expenseAccountId int32 Nullable
employeeExpenseCategories[].id int32 Int32
employeeExpenseCategories[].name string String
employeeExpenseCategories[].splitByLocation boolean Boolean
employerLiabilityCategories[] array
employerLiabilityCategories[].expenseAccountId int32 Nullable
employerLiabilityCategories[].id int32 Int32
employerLiabilityCategories[].liabilityAccountId int32 Nullable
employerLiabilityCategories[].name string String
employerLiabilityCategories[].splitByLocation boolean Boolean
payCategories[] array
payCategories[].expenseAccountId int32 Nullable
payCategories[].id int32 Int32
payCategories[].name string String
payCategories[].splitByLocation boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

 NzChartOfAccountsModel