Master Data Business Entities | GL Account
A General Ledger (GL) Account represents a numerical or alphanumerical account with specific characteristics such as nature (debit or credit), account type or taxonomy and its purpose is to record the company's financial transactions.
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/gLAccounts |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute GLAccount
- PUT Set IsActive GLAccount
- PUT Set ChartOfAccount GLAccount
- PUT Set GLAccountKey GLAccount
- PUT Set Description GLAccount
- PUT Set AllowsManualPostings GLAccount
- PUT Set Currency GLAccount
- PUT Set AllowsOtherCurrencies GLAccount
- PUT Set AllowsTaxes GLAccount
- PUT Set AllowsPostingWithoutTaxes GLAccount
- PUT Set AccountingNature GLAccount
- PUT Set AllowsOtherNature GLAccount
- PUT Set AllowsBalOtherNature GLAccount
- PUT Set SubAccountType GLAccount
- PUT Set TaxonomyClass GLAccount
- PUT Set Taxonomy GLAccount
- PUT Set SearchTerm GLAccount
- PUT Set IsTaxonomyRequired GLAccount
- PUT Set ReversalGLAccount GLAccount
- PUT Set ClassType GLAccount
- PUT Set SubclassType GLAccount
- PUT Set DynamicValueList GLAccount
- PUT Set IsExternal GLAccount
- PUT Set AllowsWithholdingTax GLAccount
- PUT Set ObligationsType GLAccount
- PUT Set Party GLAccount
- PUT Set DimensionValue GLAccountDimension
- DELETE:
All Resources
This service uses the following resources:
- ApiGLAccountEntityDimensionDetailsResource
- ApiGLAccountResource
- GLAccountDimensionResource
- GLAccountResource
- StandardGLAccountEntityDimensionDetailsResource
- StandardGLAccountResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET GLAccounts
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See GLAccountResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts
GET /businessCore/gLAccounts
GET GLAccounts (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See GLAccountResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts?page={page}&pageSize={pageSize}
GET /businessCore/gLAccounts?page={page}&pageSize={pageSize}
GET GLAccount by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See GLAccountResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{id}
GET /businessCore/gLAccounts/{id}
GET GLAccount by key
Returns the entity record that matches the specified key.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
Response:
| When successful, the response body contains the entity record. See GLAccountResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}
GET /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}
GET Print GLAccount by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{id}/print?template={template}
GET /businessCore/gLAccounts/{id}/print?template={template}
GET Print GLAccount by key
Prints the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/print
GET /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/print
GET Original Print GLAccountOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{id}/printOriginal?template={template}
GET /businessCore/gLAccounts/{id}/printOriginal?template={template}
GET Original Print GLAccount by key
Prints the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/printOriginal
GET /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/printOriginal
GET Get Reversal GL Account
This operation is used to get the alternative (reversal) account of a given GL Account.
The following elements are required:
| chartOfAccountKey | (string) The chart of accounts associated with the GL account. |
| gLAccountKey | (string) The GL account key to search for. |
Response:
| When successful, the response body contains a resource of type 'StandardGLAccountResource'. See StandardGLAccountResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/getReversalGLAccount/{chartOfAccountKey}/{gLAccountKey}
GET /businessCore/gLAccounts/getReversalGLAccount/{chartOfAccountKey}/{gLAccountKey}
POST GLAccounts
Creates a new entity record.
The following elements are required:
| gLAccountResource | (ApiGLAccountResource) The request body should contain the entity record that should be created. See ApiGLAccountResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiGLAccountResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts
POST /businessCore/gLAccounts
POST GL Account
Inserts a new 'GL Account Dimension' in the 'GL Account'.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (ApiGLAccountEntityDimensionDetailsResource) The ApiGLAccountEntityDimensionDetailsResource instance. See ApiGLAccountEntityDimensionDetailsResource. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails
POST /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails
POST Bulk Copy GL Accounts
The service copies all GL accounts from a determined chart of accounts source to a target. The source chart of accounts is determined by the taxonomy reference (e.g. SNCBase) of the given chart of accounts target.
The following elements are required:
| chartOfAccountTarget | (string) The target chart of accounts to copy the GL Accounts to and from which the source chart of accounts will be determined through its taxonomy reference. |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/bulkCopyGLAccounts/{chartOfAccountTarget}
POST /businessCore/gLAccounts/bulkCopyGLAccounts/{chartOfAccountTarget}
POST Bulk Create GL Accounts
Creates the gl account in bulk.
The following elements are required:
| bulkGLAccounts | (List |
The following elements are optional:
| customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
| When successful, the response body is empty. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/bulkCreateGLAccounts
POST /businessCore/gLAccounts/bulkCreateGLAccounts
PUT Set AccountingNature GLAccount
Updates the value of attribute 'AccountingNature' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (enum AccountingNature) The request body should contain the new value for the attribute. See AccountingNature. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/accountingNature
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/accountingNature
PUT Set AllowsBalOtherNature GLAccount
Updates the value of attribute 'AllowsBalOtherNature' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsBalOtherNature
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsBalOtherNature
PUT Set AllowsManualPostings GLAccount
Updates the value of attribute 'AllowsManualPostings' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsManualPostings
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsManualPostings
PUT Set AllowsOtherCurrencies GLAccount
Updates the value of attribute 'AllowsOtherCurrencies' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsOtherCurrencies
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsOtherCurrencies
PUT Set AllowsOtherNature GLAccount
Updates the value of attribute 'AllowsOtherNature' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsOtherNature
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsOtherNature
PUT Set AllowsPostingWithoutTaxes GLAccount
Updates the value of attribute 'AllowsPostingWithoutTaxes' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsPostingWithoutTaxes
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsPostingWithoutTaxes
PUT Set AllowsTaxes GLAccount
Updates the value of attribute 'AllowsTaxes' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsTaxes
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsTaxes
PUT Set AllowsWithholdingTax GLAccount
Updates the value of attribute 'AllowsWithholdingTax' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsWithholdingTax
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/allowsWithholdingTax
PUT Set ChartOfAccount GLAccount
Updates the value of attribute 'ChartOfAccount' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/chartOfAccount
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/chartOfAccount
PUT Set ClassType GLAccount
Updates the value of attribute 'ClassType' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/classType
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/classType
PUT Set Currency GLAccount
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/currency
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/currency
PUT Set Description GLAccount
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/description
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/description
PUT Set DimensionValue GLAccountDimension
Updates the value of attribute 'DimensionValue' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| lineId | (string) The detail identifier. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails/{lineId}/dimensionValue
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails/{lineId}/dimensionValue
PUT Set DynamicValueList GLAccount
Updates the value of attribute 'DynamicValueList' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/dynamicValueList
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/dynamicValueList
PUT Set GLAccountKey GLAccount
Updates the value of attribute 'GLAccountKey' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/gLAccountKey
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/gLAccountKey
PUT Set IsActive GLAccount
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isActive
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isActive
PUT Set IsExternal GLAccount
Updates the value of attribute 'IsExternal' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isExternal
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isExternal
PUT Set IsTaxonomyRequired GLAccount
Updates the value of attribute 'IsTaxonomyRequired' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (bool) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isTaxonomyRequired
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/isTaxonomyRequired
PUT Set ObligationsType GLAccount
Updates the value of attribute 'ObligationsType' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (enum ObligationsType) The request body should contain the new value for the attribute. See ObligationsType. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/obligationsType
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/obligationsType
PUT Set Party GLAccount
Updates the value of attribute 'Party' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/party
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/party
PUT Set ReversalGLAccount GLAccount
Updates the value of attribute 'ReversalGLAccount' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/reversalGLAccount
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/reversalGLAccount
PUT Set SearchTerm GLAccount
Updates the value of attribute 'SearchTerm' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/searchTerm
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/searchTerm
PUT Set SubAccountType GLAccount
Updates the value of attribute 'SubAccountType' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (enum SubAccountType) The request body should contain the new value for the attribute. See SubAccountType. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/subAccountType
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/subAccountType
PUT Set SubclassType GLAccount
Updates the value of attribute 'SubclassType' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/subclassType
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/subclassType
PUT Set Taxonomy GLAccount
Updates the value of attribute 'Taxonomy' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/taxonomy
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/taxonomy
PUT Set TaxonomyClass GLAccount
Updates the value of attribute 'TaxonomyClass' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| value | (string) The request body should contain the new value for the attribute. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/taxonomyClass
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/taxonomyClass
PUT Set Custom Attribute GLAccount
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account |
| gLAccountKey | (string) The key of the GL account |
| customAttributeName | (string) The custom attribute name. |
| value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/{customAttributeName}
PUT /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/{customAttributeName}
DELETE GL Account Dimension by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| lineId | (string) The line identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails/{lineId}
DELETE /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}/entityDimensionDetails/{lineId}
DELETE GLAccount by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{id}
DELETE /businessCore/gLAccounts/{id}
DELETE GLAccount by key
Deletes the entity record that matches the specified key.
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
Response:
| When successful, the response body is empty. |
Response status codes:
| 204 | Deleted. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}
DELETE /businessCore/gLAccounts/{chartOfAccount}/{gLAccountKey}
Resources
ApiGLAccountEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The value of the dimension. |
ApiGLAccountResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
| allowsOtherCurrencies | (bool) Defines if the account allows postings in other currencies than the defined in the currency field. |
| allowsTaxes | (bool) Defines if the user can select a tax code key when using the journal editor. |
| allowsPostingWithoutTaxes | (bool) Defines if the user can record a transaction without a tax code key associated with the account. |
| allowsOtherNature | (bool) Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition. |
| allowsBalOtherNature | (bool) Defines if the account allows balances in other nature than the default. |
| classType | (string) Defines the position of the account in the balance sheet of profit and loss statement. |
The following elements are optional:
| description | (string) The description of the GL account. |
| currency | (string) Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account. |
| accountingNature | (enum AccountingNature) Defines the default nature of the account (debit or credit).
See AccountingNature. |
| subAccountType | (enum SubAccountType) If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
See SubAccountType. |
| taxonomyClass | (string) The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts. |
| taxonomy | (string) The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class. |
| searchTerm | (string) Defines a nick name for the account for easy search. |
| entityDimensionDetails | (List of ApiGLAccountEntityDimensionDetailsResource) The set of dimensions used by default for this account.
See ApiGLAccountEntityDimensionDetailsResource. |
| isTaxonomyRequired | (bool) Used on UIRules. |
| reversalGLAccount | (string) An alternative GL account that will be used when journal reversal. |
| subclassType | (string) The subclass type is a complementary classification of the account type. This is used on dashboards. |
| dynamicValueList | (string) Dynamic Value. |
| isExternal | (bool) A non-persisted flag indicating if the GL Account is created by an external tool (e.g. SAF-T importer). |
| allowsWithholdingTax | (bool) Allows Withholding Tax. |
| obligationsType | (enum ObligationsType) Obligations Type.
See ObligationsType. |
| party | (string) Party. |
GLAccountDimensionResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The value of the dimension. |
GLAccountResource
The following elements are required:
| chartOfAccount | (string) The chart of accounts of the GL account.
(fk) Allowed value: the natural key of a record of type ChartOfAccount. These records are accessibly through the ChartOfAccounts service. |
| gLAccountKey | (string) The key of the GL account. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
| allowsOtherCurrencies | (bool) Defines if the account allows postings in other currencies than the defined in the currency field. |
| allowsTaxes | (bool) Defines if the user can select a tax code key when using the journal editor. |
| allowsPostingWithoutTaxes | (bool) Defines if the user can record a transaction without a tax code key associated with the account. |
| allowsOtherNature | (bool) Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition. |
| allowsBalOtherNature | (bool) Defines if the account allows balances in other nature than the default. |
| isMovement | (bool) For hierarchical accounts the system manages the flag automatically. For fixed length chart of accounts all the accounts are movement accounts. |
| classType | (string) Defines the position of the account in the balance sheet of profit and loss statement.
(fk) Allowed value: the natural key of a record of type DynamicValueList. These records are accessibly through the DynamicValueLists service. |
The following elements are optional:
| description | (string) The description of the GL account. |
| currency | (string) Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| accountingNature | (enum AccountingNature) Defines the default nature of the account (debit or credit).
See AccountingNature. |
| subAccountType | (enum SubAccountType) If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
See SubAccountType. |
| taxonomyClass | (string) The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts.
(fk) Allowed value: the natural key of a record of type TaxonomyClass. These records are accessibly through the TaxonomyClasses service. |
| taxonomy | (string) The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class.
(fk) Allowed value: the natural key of a record of type Taxonomy. These records are accessibly through the Taxonomies service. |
| searchTerm | (string) Defines a nick name for the account for easy search. |
| entityDimensionDetails | (List of GLAccountDimensionResource) The set of dimensions used by default for this account.
See GLAccountDimensionResource. |
| isTaxonomyRequired | (bool) Used on UIRules. |
| reversalGLAccount | (string) An alternative GL account that will be used when journal reversal.
(fk) Allowed value: the natural key of a record of type GLAccount. These records are accessibly through the GLAccounts service. |
| subclassType | (string) The subclass type is a complementary classification of the account type. This is used on dashboards.
(fk) Allowed value: the natural key of a record of type DynamicValueListDetail. |
| dynamicValueList | (string) Dynamic Value.
(fk) Allowed value: the natural key of a record of type DynamicValueList. These records are accessibly through the DynamicValueLists service. |
| isExternal | (bool) A non-persisted flag indicating if the GL Account is created by an external tool (e.g. SAF-T importer). |
| allowsWithholdingTax | (bool) Allows Withholding Tax. |
| obligationsType | (enum ObligationsType) Obligations Type.
See ObligationsType. |
| party | (string) Party.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
StandardGLAccountEntityDimensionDetailsResource
The following elements are required:
| dimension | (string) The dimension. |
| dimensionValue | (string) The value of the dimension. |
StandardGLAccountResource
The following elements are required:
| allowsBalOtherNature | (bool) Defines if the account allows balances in other nature than the default. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
| allowsOtherCurrencies | (bool) Defines if the account allows postings in other currencies than the defined in the currency field. |
| allowsOtherNature | (bool) Defines whether the GL Account allows postings with other nature than the default. Internally determined by the GL account definition. |
| allowsPostingWithoutTaxes | (bool) Defines if the user can record a transaction without a tax code key associated with the account. |
| allowsTaxes | (bool) Defines if the user can select a tax code key when using the journal editor. |
| chartOfAccount | (string) The chart of accounts of the GL account. |
| gLAccountKey | (string) The key of the GL account. |
| isMovement | (bool) For hierarchical accounts the system manages the flag automatically. For fixed length chart of accounts all the accounts are movement accounts. |
| classType | (string) Defines the position of the account in the balance sheet of profit and loss statement. |
The following elements are optional:
| accountingNature | (enum AccountingNature) Defines the default nature of the account (debit or credit).
See AccountingNature. |
| currency | (string) Some accounts (like bank accounts) have a fixed currency. In this case select the default currency of the account. |
| description | (string) The description of the GL account. |
| entityDimensionDetails | (List of StandardGLAccountEntityDimensionDetailsResource) The set of dimensions used by default for this account.
See StandardGLAccountEntityDimensionDetailsResource. |
| searchTerm | (string) Defines a nick name for the account for easy search. |
| subAccountType | (enum SubAccountType) If the account is a reconciliation account of a subledger (eg. customer) select the sub ledger. In this case the subledger account is required.
See SubAccountType. |
| taxonomy | (string) The taxonomy of the GL account. The taxonomy is required for movement accounts if the chart of accounts is assigned to a taxonomy class. |
| isTaxonomyRequired | (bool) Used on UIRules. |
| taxonomyClass | (string) The class of taxonomy to filter the taxonomy key. Defaulted from the chart of accounts. |
| reversalGLAccount | (string) An alternative GL account that will be used when journal reversal. |
| subclassType | (string) The subclass type is a complementary classification of the account type. This is used on dashboards. |
| allowsWithholdingTax | (bool) Allows Withholding Tax. |
| obligationsType | (enum ObligationsType) Obligations Type.
See ObligationsType. |
| party | (string) Party. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |