Skip to content

API Account

Introduction

CCH Tagetik allows you to manage the Account dimension also via OPEN RESTful APIs.

API title: Account Dimension openapi 3.0.3
Description: API for Account dimension management
Version: V1
Authentication: OAuth2, API Key, JWT, Basic Auth

Prerequisites

In order to use these APIs, the user must authenticate through the authentication mode chosen for [CCH Tagetik].

Moreover, APIs must also be enabled in the Repository. For reverse proxies, further settings are necessary. They can be used with both http and https protocols.

For more details on authentication and enabling, see Enabling the REST API and API Authentication.

Request format: JSON

Response format: JSON

URL

/dimensions/v1/{dbID}/account/elements

Http Method Endpoint Body of the request Query string parameters Body of the answer HTTP response body Response Status (Exception)
GET /dimensions/v1/{dbID}/account/elements filter sort skip take (optional parameters) List of accounts 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
POST /dimensions/v1/{dbID}/account/elements Accounts Accounts 201 (Created) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
GET /dimensions/v1/{dbID}/account/elements-count filter Quantity of accounts 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
POST /dimensions/v1/{dbID}/account/elements-bulk Accounts Success 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
POST /dimensions/v1/{dbID}/account/elements-bulk-delete-asynch dataProcessingId 202 (Accepted) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
GET /dimensions/v1/{dbID}/account/elements/{id} Accounts 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
PUT /dimensions/v1/{dbID}/account/elements/{id} Accounts Accounts 200 (OK) 201 (Created) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
PATCH /dimensions/v1/{dbID}/account/elements/{id} Accounts Accounts 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
GET /dimensions/v1/{dbID}/account/elements-bulk-delete-async/{dataProcessingId} RUNNING FAILED COMPLETED 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)
DELETE /dimensions/v1/{dbID}/account/elements-bulk-delete-async/{dataProcessingId} stop on dataprocessingOid dataprocessingId 200 (OK) 404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised) 400 (Bad Request)

"filter' accepts fields:

  • id
  • descriptions
  • type
  • nature
  • conversion-conversionType
  • consolidation.rules.excludeFromProportionalCalculation
  • conversion.referenceAccountForInitialBalance
  • dataEntryAndReporting.validity.startDate
  • restrictions.customDimension1.restriction
  • restrictions.customDimension2.restriction
  • restrictions.customDimension3.restriction
  • restrictions.customDimension4.restriction
  • restrictions.customDimension5.restriction

E.g GET /dimensions/v1/{DBID}/account/elements?filter=id=like="value"

in this case, the API call returns all accounts that have an id containing the value 'value'

GET /dimensions/v1/{DBID}/account/elements?filter=id=="10010";descriptions.en=like="Filter";nature=="BALANCE_SHEET"

in this case, the API call returns all accounts that have an id equal to "10010", a description in English containing "Filter" and nature equal to "BALANCE_SHEET"

Supported Fields in Request

Account field Supported cardinality Supported Values
id - string (mandatory)
descriptions.[lingua] - string (one mandatory)
alternativesDescriptions.[language] - string
customAttributes - string
nature - BALANCE_SHEET, PROFIT_AND_LOSS, GUARANTIES_AND_COMMITMENTS, OTHER_VARIATIONS, OTHER_STOCKS (mandatory)
type - NORMAL, DETAIL, VARIATION (mandatory)
conversion-conversionType - PROFIT_AND_LOSS, AVERAGE, PERIOD_AVERAGE, FINAL, HISTORICAL, PREVIOUS_PROFIT_AND_LOSS, PREVIOUS_FINAL, INITIAL_BALANCE, YEAR_TO_YEAR, NONE (mandatory)
conversion.referenceAccountForInitialBalance - string
documentationLink - string
restrictions.customDimension1.dimensionName - string
restrictions.customDimension1.restricted - NONE, RESTRICTED, RESTRICTED_ON_ENTITY_DEFAULT_CUSTOM_DIMENSION, RESTRICTED_BASED_ON_ACCOUNT_CLASSIFIERS_RELATIONSHIPS
restrictions.customDimension2.dimensionName - string
restrictions.customDimension2.restricted - NONE, RESTRICTED, RESTRICTED_ON_ENTITY_DEFAULT_CUSTOM_DIMENSION, RESTRICTED_BASED_ON_ACCOUNT_CLASSIFIERS_RELATIONSHIPS
restrictions.customDimension3.dimensionName - string
restrictions.customDimension3.restricted - NONE, RESTRICTED, RESTRICTED_ON_ENTITY_DEFAULT_CUSTOM_DIMENSION, RESTRICTED_BASED_ON_ACCOUNT_CLASSIFIERS_RELATIONSHIPS
restrictions.customDimension4.dimensionName - string
restrictions.customDimension4.restricted - NONE, RESTRICTED, RESTRICTED_ON_ENTITY_DEFAULT_CUSTOM_DIMENSION, RESTRICTED_BASED_ON_ACCOUNT_CLASSIFIERS_RELATIONSHIPS
restrictions.customDimension5.dimensionName - string
restrictions.customDimension5.restricted - NONE, RESTRICTED, RESTRICTED_ON_ENTITY_DEFAULT_CUSTOM_DIMENSION, RESTRICTED_BASED_ON_ACCOUNT_CLASSIFIERS_RELATIONSHIPS
cashFlowPlanning.variation.debit.id - string
cashFlowPlanning.variation.debit.description - string
cashFlowPlanning.variation.credit.id - string
cashFlowPlanning.variation.credit.description - string
cashFlowPlanning.receivablePayble.debit.id - string
cashFlowPlanning.receivablePayble.debit.description - string
cashFlowPlanning.receivablePayble.credit.id - string
cashFlowPlanning.receivablePayble.credit.description - string
cashFlowPlanning.liquidity.debit.id - string
cashFlowPlanning.liquidity.debit.description - string
cashFlowPlanning.liquidity.credit.id - string
cashFlowPlanning.liquidity.credit.description - string
cashFlowPlanning.other.debit.id - string
cashFlowPlanning.other.debit.description - string
cashFlowPlanning.other.credit.id - string
cashFlowPlanning.other.credit.description - string
cashFlowPlanning.other.additionalCreditAccrualAccount.id - string
cashFlowPlanning.other.additionalCreditAccrualAccount.description - string
cashFlowPlanning.other.additionalDebitAccrualAccount.id - string
cashFlowPlanning.other.additionalDebitAccrualAccount.description - string
cashFlowPlanning.revaluationDevaluation.enable - boolean: true/ false
cashFlowPlanning.revaluationDevaluation.debit.id - string
cashFlowPlanningrevaluationDevaluation.debit.description - string
cashFlowPlanning.revaluationDevaluation.credit.id - string
cashFlowPlanningrevaluationDevaluation.credit.description - string
dataEntryAndReporting.validity.startDate - date
dataEntryAndReporting.validity.endDate - date
dataEntryAndReporting.class - NONE (default value), ASSET, COST, DECREASE_IN_ASSETS, DECREASE_IN_LIABILITIES, INCREASE_IN_ASSETS, INCREASE IN LIABILITIES, LIABILITY, REVENUE
dataEntryAndReporting.manageTransactionCurrency - boolean: true/ false
dataEntryAndReporting.icManagement - boolean: true/ false
dataEntryAndReporting.manageMaximumNumberDecimals - boolean: true/ false
rules.grossAmountEqualICSum - boolean - Yes in this case the system automatically generates upon saving an "IC on Gross amount" calculation logic that calculates the gross amount from the IC declaration - No (default value)
rules.accrual.debit.id - string
rules.accrual.debit.description - string
rules.accrual.credit.id - string
rules.accrual.credit.description - string
rules.consolidaton.useAccountForSetup - NO, FINANCIAL_INVESTMENTS, NET_EQUITY
rules.consolidaton.excludeFromProportionalCalculation - boolean: true/ false
bankingData.consolidation.bankitReportingMItem.id - string
bankingData.consolidation.bankitReportingMItem.description - string
bankingData.consolidation.bankitReportingMItem.changeSign - boolean: true/false
bankingData.consolidation.bankitReportingMItemICGroup.id - string
bankingData.consolidation.bankitReportingMItemICGroup.description - string
bankingData.consolidation.bankitReportingMItemICGroup.changeSign - boolean: true/false
bankingData.consolidation.bankitReporting1Item.id - string
bankingData.consolidation.bankitReporting1Item.description - string
bankingData.consolidation.bankitReporting1Item.changeSign - boolean: true/false
bankingData.consolidation.bankitReportingEPItem.id - string
bankingData.consolidation.bankitReportingEPItem.description - string
bankingData.consolidation.bankitReportingEPItem.changeSign - boolean: true/false
bankingData.consolidation.ebaSignalingSubAccount.id - string
bankingData.consolidation.ebaSignalingSubAccount.description - string
bankingData.consolidation.ebaSignalingSubAccount.changeSign - boolean: true/false
bankingData.consolidation.bankitReportingMItemOld.id - string
bankingData.consolidation.bankitReportingMOld.description - string
bankingData.consolidation.bankitReportingMItemOld.changeSign - boolean: true/false
bankingData.consolidation.icItemOld.id - string
bankingData.consolidation.icItemOld.description - string
bankingData.consolidationicItemOld.changeSign - boolean: true/false
debitAccrual.Accrual.id - string
debitAccrual.Accrual.description - string
creditAccrual.Accrual.id - string
creditAccrual.Accrual.description - string
CtpElement.id - string
CtpElement.description - string
rules.validationChecks.standardSignCheck - ANY, DEBIT, CREDIT
rules.validationChecks.icCapacityCheck - DO_NOT_CHECK, CHECK_MINUS_EQUALS_TO, CHECK_EQUALS_TO
rules.validationChecks.fxRatesCheck - DO_NOT_CHECK, CHECK_ONLY_IC_AMOUNTS, CHECK_GROSS_AND_IC_AMOUNTS
rules.validationChecks.icSignCheck - DO_NOT_CHECK, AS_GROSS_AMOUNT, DEBIT, CREDIT
rules.validationChecks.notesCheck - DO_NOT_CHECK, CHECK_ONLY_IC_AMOUNTS, CHECK_GROSS_AND_IC_AMOUNTS
monthlySplittingRules.monthlySplittingType - NO, FLAT, COEFFICIENT_445, COEFFICIENT_454, COEFFICIENT_544, ADVANCED_MANAGEMENT
monthlySplittingRules.reference.referenceAccount.id - string
monthlySplittingRules.reference.referenceAccount.description - string
monthlySplittingRules.reference.referenceAccountHierarchy.hierarchyId - string
monthlySplittingRules.reference.referenceAccountHierarchy.nodeId - string
monthlySplittingRules.reference.referenceAccountHierarchy.descriptionId - string
monthlySplittingRules.reference.referenceScenario - string
monthlySplittingRules.reference.customDimension1Filter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.customDimension2Filter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.customDimension3Filter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.customDimension4Filter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.customDimension5Filter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.categoryFilter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.entityCtpFilter - NONE, LOWEST_LEVEL
monthlySplittingRules.reference.customDimension2CtpFilter - NONE, LOWEST_LEVEL
updateInfo.origin - string
updateInfo.user - string
updateInfo.date - date

The 'descriptions' field consists of a key-value array where the key is the abbreviated wording of a language and the value is a string

Method GET
Endpoint /dimensions/v1/{dbID}/account/elements
Body -
Example of response [ { "id": "100", "descriptions": { "en": "CashEN", "it": "CashIT", "es": "CashES", "fr": "CashFR" }, "alternativeDescriptions": { "en": "TestAlternativeDescriptionEN", "it": "TestAlternativeDescriptionIT", "es": null, "fr": null }, "customAttributes": { "test": "Custome Attribute" }, "nature": "BALANCE_SHEET", "type": "VARIATION", "conversion": { "conversionType": "PROFIT_AND_LOSS", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": "2025-09-02T00:00:00.000+0000", "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": false, "manageMaximumNumberDecimals": false }, "documentationLink": "documentationLink", "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "ADVANCED_MANAGEMENT", "reference": { "referenceAccount": null, "referenceAccountHierarchy": null, "customDimension1Filter": "NONE", "customDimension2Filter": "NONE", "customDimension3Filter": "NONE", "customDimension4Filter": "NONE", "customDimension5Filter": "NONE", "categoryFilter": "NONE", "entityCtpFilter": "0013", "customDimension2CtpFilter": "NONE", "referenceSenario": null } }, "updateInfo": { "user": "USER_BS", "date": "2026-01-22T15:12:41.062+0000", "origin": "INPUT_WEB" } }, ... ]
Method POST
Endpoint /dimensions/v1/{dbID}/account/elements
Body { "id": "10010", "descriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "customAttributes": { "test": null }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": null, "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "SUE", "date": "2017-04-23T23:00:58.496+0000", "origin": "INPUT_WEB" } }
Example of response { "id": "10010", "descriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "customAttributes": { "test": null }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": null, "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "SUE", "date": "2017-04-23T23:00:58.496+0000", "origin": "INPUT_WEB" } }
Method GET
Endpoint /dimensions/v1/{dbID}/account/elements-count
Body -
Example of response 100 (quantity of accounts)
Method POST
Endpoint /dimensions/v1/{dbID}/account/elements-bulk
Body { "saveMode": "LOOSE", "post": [ { "id": "10010", "descriptions": { "en": "Cash", "it": "CUS test", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash", "it": "Cash in Bank Accounts", "es": null, "fr": null }, "customAttributes": { "test": "Prova" }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "LIABILITY", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": "test doc", "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": "10046-0040", "description": "Property & Equipment - Acc. Depreciation-Changes due to Mergers/Incorporations " }, "creditAccrual": { "id": "10018", "description": "Cus test 8" } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "CHECK_MINUS_EQUALS_TO", "fxRatesCheck": "DO_NOT_CHECK", "icSignCheck": "AS_GROSS_AMOUNT", "notesCheck": "CHECK_GROSS_AND_IC_AMOUNTS" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": { "variation": { "debit": { "id": "10010-1000", "description": "Cash in Bank Accounts - Generic Movement" }, "credit": { "id": "10010-0010", "description": "Cash in Bank Accounts- Initial Balance" } }, "receivablePayable": { "debit": { "id": "10035-0100", "description": "Land - FX rate difference " }, "credit": { "id": "10041-0040", "description": "Buildings - Acc. Depreciation-Changes due to Mergers/Incorporations " } }, "liquidity": { "debit": { "id": "10035-0035", "description": "Land - Disposal" }, "credit": { "id": "10025-0010", "description": "Inventory - Initial Balance" } }, "other": { "debit": { "id": "100-0100", "description": "CUS test -FX rate difference " }, "credit": { "id": "100-TESTSC4", "description": "Test Scenario Planning4" }, "additionalCreditAccrualAccount": { "id": "10020", "description": "Accounts Receivable" }, "additionalDebitAccrualAccount": { "id": "10027", "description": "Accruals and Prepaid Expenses" } }, "revaluationDevaluation": { "enable": false, "debit": { "id": "50021", "description": "Sales Intercompany" }, "credit": { "id": "65045", "description": "Uniforms" } } }, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "USER_BS", "date": "2025-10-01T14:49:53.302+0000", "origin": "INPUT_WEB" } } ], "put": [ { "id": "10011", "descriptions": { "en": "desc enPUT", "it": "desc itPUT", "es": null, "fr": null }, "alternativeDescriptions": { "en": "alternative DescriptionPUT", "it": null, "es": null, "fr": null }, "customAttributes": { "test": "prova PUT" }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": false, "manageMaximumNumberDecimals": false }, "documentationLink": "documentationLink", "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": "DO_NOT_CHECK", "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": { "variation": { "debit": { "id": "10010", "description": "Cash in Bank Accounts" }, "credit": { "id": "10015", "description": "Petty Cash" } }, "receivablePayable": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } }, "liquidity": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } }, "other": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null }, "additionalCreditAccrualAccount": { "id": null, "description": null }, "additionalDebitAccrualAccount": { "id": null, "description": null } }, "revaluationDevaluation": { "enable": false, "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } } }, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "USER_BS", "date": "2025-09-25T12:48:33.181+0000", "origin": "INPUT_WEB" } } ] }
Example of response 200 - Created and/or updated record
Method POST
Endpoint /dimensions/v1/{dbID}/account/elements-bulk-delete-asynch
Body [ { "id": "10010" }, { "id": "10011" } ]
Example of response { "dataProcessingId": "2C982FB59C0844E5019C0A2246A42514" }
Method GET
Endpoint /dimensions/v1/{dbID}/account/elements/{id}
Body -
Example of response { "id": "10010", "descriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "customAttributes": { "test": null }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": null, "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "SUE", "date": "2017-04-23T23:00:58.496+0000", "origin": "INPUT_WEB" } }
Method PUT
Endpoint /dimensions/v1/{dbID}/account/elements/{id}
Body { "id": "10010", "descriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "customAttributes": { "test": null }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": null, "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "SUE", "date": "2017-04-23T23:00:58.496+0000", "origin": "INPUT_WEB" } }
Example of response { { "id": "10010", "descriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash", "es": null, "fr": null }, "customAttributes": { "test": null }, "nature": "BALANCE_SHEET", "type": "NORMAL", "conversion": { "conversionType": "FINAL", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": null, "endDate": null }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": true, "manageMaximumNumberDecimals": false }, "documentationLink": null, "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": null, "description": null }, "creditAccrual": { "id": null, "description": null } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "DO_NOT_CHECK" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "NONE" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": null, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "SUE", "date": "2017-04-23T23:00:58.496+0000", "origin": "INPUT_WEB" } }
Method PATCH
Endpoint /dimensions/v1/{dbID}/account/elements/{id}
Body { "id": "100", "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash in Bank Accounts", "es": "Cash in Bank Accounts", "fr": "Cash in Bank Accounts" }, "customAttributes": { "test": "Prova" }, "nature": "PROFIT_AND_LOSS", "type": "NORMAL", "conversion": { "conversionType": "PROFIT_AND_LOSS", "referenceAccountForInitialBalance": null }, "dataEntryAndReporting": { "validity": { "startDate": "2025-09-10T00:00:00.000+0000", "endDate": "2025-09-12T00:00:00.000+0000" }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": false, "manageMaximumNumberDecimals": false }, "documentationLink": "doc" }
Example of response { "id": "100", "descriptions": { "en": "Cash1", "it": "CUS test1", "es": null, "fr": null }, "alternativeDescriptions": { "en": "Cash in Bank Accounts", "it": "Cash in Bank Accounts", "es": "Cash in Bank Accounts", "fr": "Cash in Bank Accounts" }, "customAttributes": { "test": "Prova" }, "nature": "PROFIT_AND_LOSS", "type": "NORMAL", "conversion": { "conversionType": "PROFIT_AND_LOSS", "referenceAccountForInitialBalance": null }, "consolidation": { "rules": { "useAccountForSetup": "FALSE", "excludeFromProportionalCalculation": false }, "bankingData": { "bankitReportingMItem": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemICGroup": { "id": null, "description": null, "changeSign": false }, "bankitReporting1Item": { "id": null, "description": null, "changeSign": false }, "bankitReportingEPItem": { "id": null, "description": null, "changeSign": false }, "ebaSignalingSubAccount": { "id": null, "description": null, "changeSign": false }, "bankitReportingMItemOld": { "id": null, "description": null, "changeSign": false }, "icIitemOld": { "id": null, "description": null, "changeSign": false } } }, "dataEntryAndReporting": { "validity": { "startDate": "2025-09-10T00:00:00.000+0000", "endDate": "2025-09-12T00:00:00.000+0000" }, "class": "NONE", "manageTransactionCurrency": true, "icManagement": false, "manageMaximumNumberDecimals": false }, "documentationLink": "doc", "rules": { "grossAmountEqualICSum": false, "accrual": { "debitAccrual": { "id": "10046-0040", "description": "Property & Equipment - Acc. Depreciation-Changes due to Mergers/Incorporations " }, "creditAccrual": { "id": "10018", "description": "Cus test 8" } }, "validationChecks": { "standardSignCheck": "ANY", "icCapacityCheck": "DO_NOT_CHECK", "fxRatesCheck": null, "icSignCheck": "DO_NOT_CHECK", "notesCheck": "CHECK_GROSS_AND_IC_AMOUNTS" } }, "restrictions": { "customDimension1": { "dimensionName": "Cost Centers", "restriction": "RESTRICTED" }, "customDimension2": { "dimensionName": "Products", "restriction": "NONE" }, "customDimension3": { "dimensionName": "Customers en", "restriction": "NONE" }, "customDimension4": { "dimensionName": "Employees", "restriction": "NONE" }, "customDimension5": { "dimensionName": "Miscellaneous", "restriction": "NONE" }, "ctpRestriction": { "id": null, "description": null } }, "cashFlowPlanning": { "variation": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } }, "receivablePayable": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } }, "liquidity": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null } }, "other": { "debit": { "id": null, "description": null }, "credit": { "id": null, "description": null }, "additionalCreditAccrualAccount": { "id": null, "description": null }, "additionalDebitAccrualAccount": { "id": null, "description": null } }, "revaluationDevaluation": { "enable": false, "debit": null, "credit": null } }, "monthlySplittingRules": { "monthlySplittingType": "NO", "reference": null }, "updateInfo": { "user": "USER_BS", "date": "2026-03-12T11:31:55.536+0000", "origin": "INPUT_WEB" } }
Method GET
Endpoint /dimensions/v1/{dbID}/account/elements-bulk-delete-async/{dataProcessingId}
Body -
Example of response [ { "requestDateTime": "2025-07-21T17:32:28.000Z", "status": "RUNNING", "parameters": [] } ]
Method DELETE
Endpoint /dimensions/v1/{dbID}/account/elements-bulk-delete-async/{dataProcessingId}
Body -
Example of response { "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB" }