Updates the default chart of accounts configuration for the business.
POST http:///api/v2/business/{businessId}/chartofaccounts
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| businessId | string | Required |
The request body takes a complete SgChartOfAccountsGroupModel resource, containing the following writable properties:
{
"deductionCategories": [
{
"expenseAccountId": "int32",
"id": "int32",
"liabilityAccountId": "int32",
"name": "string",
"splitByEmployingEntity": "boolean",
"splitByLocation": "boolean"
}
],
"defaultAccounts": {
"cpfEmployeeLiabilityAccountId": "int32",
"cpfEmployeeLiabilitySplitByEmployingEntity": "boolean",
"cpfEmployeeLiabilitySplitByLocation": "boolean",
"cpfEmployerExpenseAccountId": "int32",
"cpfEmployerExpenseSplitByEmployingEntity": "boolean",
"cpfEmployerExpenseSplitByLocation": "boolean",
"cpfEmployerLiabilityAccountId": "int32",
"cpfEmployerLiabilitySplitByEmployingEntity": "boolean",
"cpfEmployerLiabilitySplitByLocation": "boolean",
"defaultExpenseAccountId": "int32",
"defaultExpenseSplitByEmployingEntity": "boolean",
"defaultExpenseSplitByLocation": "boolean",
"defaultLiabilityAccountId": "int32",
"defaultLiabilitySplitByEmployingEntity": "boolean",
"defaultLiabilitySplitByLocation": "boolean",
"employeeExpenseAccountId": "int32",
"employeeExpenseSplitByEmployingEntity": "boolean",
"employeeExpenseSplitByLocation": "boolean",
"employerLiabilityExpenseAccountId": "int32",
"employerLiabilityExpenseSplitByEmployingEntity": "boolean",
"employerLiabilityExpenseSplitByLocation": "boolean",
"employerLiabilityLiabilityAccountId": "int32",
"employerLiabilityLiabilitySplitByEmployingEntity": "boolean",
"employerLiabilityLiabilitySplitByLocation": "boolean",
"paymentAccountId": "int32",
"paymentAccountSplitByEmployingEntity": "boolean",
"paymentAccountSplitByLocation": "boolean",
"sdlEmployerExpenseAccountId": "int32",
"sdlEmployerExpenseSplitByEmployingEntity": "boolean",
"sdlEmployerExpenseSplitByLocation": "boolean",
"sdlEmployerLiabilityAccountId": "int32",
"sdlEmployerLiabilitySplitByEmployingEntity": "boolean",
"sdlEmployerLiabilitySplitByLocation": "boolean",
"taxLiabilityAccountId": "int32",
"taxLiabilitySplitByEmployingEntity": "boolean",
"taxLiabilitySplitByLocation": "boolean"
},
"employeeExpenseCategories": [
{
"expenseAccountId": "int32",
"id": "int32",
"name": "string",
"splitByEmployingEntity": "boolean",
"splitByLocation": "boolean"
}
],
"employerLiabilityCategories": [
{
"expenseAccountId": "int32",
"id": "int32",
"liabilityAccountId": "int32",
"name": "string",
"splitByEmployingEntity": "boolean",
"splitByLocation": "boolean"
}
],
"payCategories": [
{
"expenseAccountId": "int32",
"id": "int32",
"name": "string",
"splitByEmployingEntity": "boolean",
"splitByLocation": "boolean"
}
]
}
| Name | Type | Description |
|---|---|---|
| deductionCategories[] | array | |
| deductionCategories[].expenseAccountId | int32 |
Nullable |
| deductionCategories[].id | int32 | Int32 |
| deductionCategories[].liabilityAccountId | int32 |
Nullable |
| deductionCategories[].name | string | String |
| deductionCategories[].splitByEmployingEntity | boolean |
Nullable |
| deductionCategories[].splitByLocation | boolean | Boolean |
| defaultAccounts | object | SgChartOfAccountsDefaultAccountsModel |
| defaultAccounts.cpfEmployeeLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.cpfEmployeeLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.cpfEmployeeLiabilitySplitByLocation | boolean | Boolean |
| defaultAccounts.cpfEmployerExpenseAccountId | int32 |
Nullable |
| defaultAccounts.cpfEmployerExpenseSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.cpfEmployerExpenseSplitByLocation | boolean | Boolean |
| defaultAccounts.cpfEmployerLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.cpfEmployerLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.cpfEmployerLiabilitySplitByLocation | boolean | Boolean |
| defaultAccounts.defaultExpenseAccountId | int32 |
Nullable |
| defaultAccounts.defaultExpenseSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.defaultExpenseSplitByLocation | boolean | Boolean |
| defaultAccounts.defaultLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.defaultLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.defaultLiabilitySplitByLocation | boolean | Boolean |
| defaultAccounts.employeeExpenseAccountId | int32 |
Nullable |
| defaultAccounts.employeeExpenseSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.employeeExpenseSplitByLocation | boolean | Boolean |
| defaultAccounts.employerLiabilityExpenseAccountId | int32 |
Nullable |
| defaultAccounts.employerLiabilityExpenseSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.employerLiabilityExpenseSplitByLocation | boolean | Boolean |
| defaultAccounts.employerLiabilityLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.employerLiabilityLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.employerLiabilityLiabilitySplitByLocation | boolean | Boolean |
| defaultAccounts.paymentAccountId | int32 |
Nullable |
| defaultAccounts.paymentAccountSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.paymentAccountSplitByLocation | boolean | Boolean |
| defaultAccounts.sdlEmployerExpenseAccountId | int32 |
Nullable |
| defaultAccounts.sdlEmployerExpenseSplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.sdlEmployerExpenseSplitByLocation | boolean | Boolean |
| defaultAccounts.sdlEmployerLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.sdlEmployerLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.sdlEmployerLiabilitySplitByLocation | boolean | Boolean |
| defaultAccounts.taxLiabilityAccountId | int32 |
Nullable |
| defaultAccounts.taxLiabilitySplitByEmployingEntity | boolean |
Nullable |
| defaultAccounts.taxLiabilitySplitByLocation | boolean | Boolean |
| employeeExpenseCategories[] | array | |
| employeeExpenseCategories[].expenseAccountId | int32 |
Nullable |
| employeeExpenseCategories[].id | int32 | Int32 |
| employeeExpenseCategories[].name | string | String |
| employeeExpenseCategories[].splitByEmployingEntity | boolean |
Nullable |
| employeeExpenseCategories[].splitByLocation | boolean | Boolean |
| employerLiabilityCategories[] | array | |
| employerLiabilityCategories[].expenseAccountId | int32 |
Nullable |
| employerLiabilityCategories[].id | int32 | Int32 |
| employerLiabilityCategories[].liabilityAccountId | int32 |
Nullable |
| employerLiabilityCategories[].name | string | String |
| employerLiabilityCategories[].splitByEmployingEntity | boolean |
Nullable |
| employerLiabilityCategories[].splitByLocation | boolean | Boolean |
| payCategories[] | array | |
| payCategories[].expenseAccountId | int32 |
Nullable |
| payCategories[].id | int32 | Int32 |
| payCategories[].name | string | String |
| payCategories[].splitByEmployingEntity | boolean |
Nullable |
| payCategories[].splitByLocation | boolean | Boolean |
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK OK |
SgChartOfAccountsModel |
| 400 | Bad Request Bad Request |
ProblemDetails |