Master Data Business Entities | Taxonomy
A Taxonomy represents a metadata classification for GLAccounts used in Accounting reporting (e.g. SAF-T).
Overview
| URL | api/{tenantKey}/{orgKey}/businessCore/taxonomies |
| Methods Supported | GET, PUT |
All Operations
This service includes the following operations:
- GET:
- PUT:
All Resources
This service uses the following resources:
All Enumerations
This service uses the following enumerations:
GET Taxonomies
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See TaxonomyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Taxonomies (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 TaxonomyResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Taxonomy 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 TaxonomyResource. |
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:
GET Taxonomy by key
Returns the entity record that matches the specified key.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
Response:
| When successful, the response body contains the entity record. See TaxonomyResource. |
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:
PUT Set Description Taxonomy
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
| 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:
PUT Set IsActive Taxonomy
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
| 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:
PUT Set TaxonomyClass Taxonomy
Updates the value of attribute 'TaxonomyClass' in the specified entity record.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
| 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:
PUT Set TaxonomyKey Taxonomy
Updates the value of attribute 'TaxonomyKey' in the specified entity record.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
| value | (int) 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:
PUT Set Custom Attribute Taxonomy
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy. |
| 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:
Resources
TaxonomyResource
The following elements are required:
| taxonomyKey | (int) The taxonomy key. |
| taxonomyClass | (string) The class of the taxonomy.
(fk) Allowed value: the natural key of a record of type TaxonomyClass. These records are accessibly through the TaxonomyClasses service. |
| 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. |
| allowsManualPostings | (bool) Choose if the account can be used directly in the journal editor. |
The following elements are optional:
| description | (string) The description of the taxonomy. |
| 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. |
| 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. |
| dynamicValueList | (string) Dynamic Value List.
(fk) Allowed value: the natural key of a record of type DynamicValueList. These records are accessibly through the DynamicValueLists service. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |