Updates the default chart of accounts configuration for the business.

Request

POST http://keypay.yourpayroll.local/api/v2/business/{businessId}/chartofaccounts

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete ChartOfAccountsGroupModel 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",
        "employeePensionLiabilityAccountId": "int32",
        "employeePensionLiabilitySplitByLocation": "boolean",
        "employerLiabilityExpenseAccountId": "int32",
        "employerLiabilityExpenseSplitByLocation": "boolean",
        "employerLiabilityLiabilityAccountId": "int32",
        "employerLiabilityLiabilitySplitByLocation": "boolean",
        "employerPensionExpenseAccountId": "int32",
        "employerPensionExpenseSplitByLocation": "boolean",
        "employerPensionLiabilityAccountId": "int32",
        "employerPensionLiabilitySplitByLocation": "boolean",
        "nationalInsuranceExpenseAccountId": "int32",
        "nationalInsuranceExpenseSplitByLocation": "boolean",
        "nationalInsuranceLiabilityAccountId": "int32",
        "nationalInsuranceLiabilitySplitByLocation": "boolean",
        "paygExpenseAccountId": "int32",
        "paygExpenseSplitByLocation": "boolean",
        "paygLiabilityAccountId": "int32",
        "paygLiabilityAccountSplitByLocation": "boolean",
        "paymentAccountId": "int32",
        "paymentAccountSplitByLocation": "boolean",
        "superannuationExpenseAccountId": "int32",
        "superannuationExpenseSplitByLocation": "boolean",
        "superannuationLiabilityAccountId": "int32",
        "superannuationLiabilitySplitByLocation": "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 ChartOfAccountsDefaultAccountsModel
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.employeePensionLiabilityAccountId int32 Nullable
defaultAccounts.employeePensionLiabilitySplitByLocation boolean Boolean
defaultAccounts.employerLiabilityExpenseAccountId int32 Nullable
defaultAccounts.employerLiabilityExpenseSplitByLocation boolean Boolean
defaultAccounts.employerLiabilityLiabilityAccountId int32 Nullable
defaultAccounts.employerLiabilityLiabilitySplitByLocation boolean Boolean
defaultAccounts.employerPensionExpenseAccountId int32 Nullable
defaultAccounts.employerPensionExpenseSplitByLocation boolean Boolean
defaultAccounts.employerPensionLiabilityAccountId int32 Nullable
defaultAccounts.employerPensionLiabilitySplitByLocation boolean Boolean
defaultAccounts.nationalInsuranceExpenseAccountId int32 Nullable
defaultAccounts.nationalInsuranceExpenseSplitByLocation boolean Boolean
defaultAccounts.nationalInsuranceLiabilityAccountId int32 Nullable
defaultAccounts.nationalInsuranceLiabilitySplitByLocation boolean Boolean
defaultAccounts.paygExpenseAccountId int32 Nullable
defaultAccounts.paygExpenseSplitByLocation boolean Boolean
defaultAccounts.paygLiabilityAccountId int32 Nullable
defaultAccounts.paygLiabilityAccountSplitByLocation boolean Boolean
defaultAccounts.paymentAccountId int32 Nullable
defaultAccounts.paymentAccountSplitByLocation boolean Boolean
defaultAccounts.superannuationExpenseAccountId int32 Nullable
defaultAccounts.superannuationExpenseSplitByLocation boolean Boolean
defaultAccounts.superannuationLiabilityAccountId int32 Nullable
defaultAccounts.superannuationLiabilitySplitByLocation 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