Updates the default chart of accounts configuration for the business.
POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/chartofaccounts
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
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",
"defaultExpenseSplitByLocation": "boolean",
"defaultLiabilityAccountId": "int32",
"defaultLiabilitySplitByLocation": "boolean",
"employeeExpenseAccountId": "int32",
"employeeExpenseSplitByLocation": "boolean",
"employerLiabilityExpenseAccountId": "int32",
"employerLiabilityExpenseSplitByLocation": "boolean",
"employerLiabilityLiabilityAccountId": "int32",
"employerLiabilityLiabilitySplitByLocation": "boolean",
"kiwiSaverEmployeeLiabilityAccountId": "int32",
"kiwiSaverEmployeeLiabilitySplitByLocation": "boolean",
"kiwiSaverEmployerExpenseAccountId": "int32",
"kiwiSaverEmployerExpenseSplitByLocation": "boolean",
"kiwiSaverEmployerLiabilityAccountId": "int32",
"kiwiSaverEmployerLiabilitySplitByLocation": "boolean",
"payeExpenseAccountId": "int32",
"payeExpenseSplitByLocation": "boolean",
"payeLiabilityAccountId": "int32",
"payeLiabilityAccountSplitByLocation": "boolean",
"paymentAccountId": "int32",
"paymentAccountSplitByLocation": "boolean",
"studentLoanLiabilityAccountId": "int32",
"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"
}
]
}
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.defaultExpenseSplitByLocation | boolean | Boolean |
defaultAccounts.defaultLiabilityAccountId | int32 |
Nullable |
defaultAccounts.defaultLiabilitySplitByLocation | boolean | Boolean |
defaultAccounts.employeeExpenseAccountId | int32 |
Nullable |
defaultAccounts.employeeExpenseSplitByLocation | boolean | Boolean |
defaultAccounts.employerLiabilityExpenseAccountId | int32 |
Nullable |
defaultAccounts.employerLiabilityExpenseSplitByLocation | boolean | Boolean |
defaultAccounts.employerLiabilityLiabilityAccountId | int32 |
Nullable |
defaultAccounts.employerLiabilityLiabilitySplitByLocation | boolean | Boolean |
defaultAccounts.kiwiSaverEmployeeLiabilityAccountId | int32 |
Nullable |
defaultAccounts.kiwiSaverEmployeeLiabilitySplitByLocation | boolean | Boolean |
defaultAccounts.kiwiSaverEmployerExpenseAccountId | int32 |
Nullable |
defaultAccounts.kiwiSaverEmployerExpenseSplitByLocation | boolean | Boolean |
defaultAccounts.kiwiSaverEmployerLiabilityAccountId | int32 |
Nullable |
defaultAccounts.kiwiSaverEmployerLiabilitySplitByLocation | boolean | Boolean |
defaultAccounts.payeExpenseAccountId | int32 |
Nullable |
defaultAccounts.payeExpenseSplitByLocation | boolean | Boolean |
defaultAccounts.payeLiabilityAccountId | int32 |
Nullable |
defaultAccounts.payeLiabilityAccountSplitByLocation | boolean | Boolean |
defaultAccounts.paymentAccountId | int32 |
Nullable |
defaultAccounts.paymentAccountSplitByLocation | boolean | Boolean |
defaultAccounts.studentLoanLiabilityAccountId | int32 |
Nullable |
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 |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
NzChartOfAccountsModel |