ROSE Developers - Web API Reference

Master Data Business Entities | Chart Of Account

A Chart of Accounts represents a set of accounts used to record the company's financial transactions.

Overview


URL api/{tenantKey}/{orgKey}/businessCore/chartOfAccounts
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET ChartOfAccounts

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See ChartOfAccountResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/chartOfAccounts

GET ChartOfAccounts (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 ChartOfAccountResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /businessCore/chartOfAccounts?page={page}&pageSize={pageSize}

GET ChartOfAccount 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 ChartOfAccountResource.

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 /businessCore/chartOfAccounts/{id}

GET ChartOfAccount by key

Returns the entity record that matches the specified key.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.

Response:

When successful, the response body contains the entity record. See ChartOfAccountResource.

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 /businessCore/chartOfAccounts/{chartOfAccountsKey}

GET Print ChartOfAccount 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:

GET /businessCore/chartOfAccounts/{id}/print?template={template}

GET Print ChartOfAccount by key

Prints the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.

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:

GET /businessCore/chartOfAccounts/{chartOfAccountsKey}/print

GET Original Print ChartOfAccountOriginal 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:

GET /businessCore/chartOfAccounts/{id}/printOriginal?template={template}

GET Original Print ChartOfAccount by key

Prints the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.

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:

GET /businessCore/chartOfAccounts/{chartOfAccountsKey}/printOriginal

POST Operations

POST ChartOfAccounts

Creates a new entity record.

The following elements are required:

chartOfAccountResource (ApiChartOfAccountResource) The request body should contain the entity record that should be created.
See ApiChartOfAccountResource.

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 ApiChartOfAccountResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /businessCore/chartOfAccounts

PUT Operations

PUT Set AccountLength ChartOfAccount

Updates the value of attribute 'AccountLength' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/accountLength

PUT Set ChartOfAccountsKey ChartOfAccount

Updates the value of attribute 'ChartOfAccountsKey' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/chartOfAccountsKey

PUT Set CopyFrom ChartOfAccount

Updates the value of attribute 'CopyFrom' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/copyFrom

PUT Set Description ChartOfAccount

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/description

PUT Set HasPurchasesAccounts ChartOfAccount

Updates the value of attribute 'HasPurchasesAccounts' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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:

PUT /businessCore/chartOfAccounts/{chartOfAccountsKey}/hasPurchasesAccounts

PUT Set IsActive ChartOfAccount

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/isActive

PUT Set IsAlphanumeric ChartOfAccount

Updates the value of attribute 'IsAlphanumeric' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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:

PUT /businessCore/chartOfAccounts/{chartOfAccountsKey}/isAlphanumeric

PUT Set TaxonomyClass ChartOfAccount

Updates the value of attribute 'TaxonomyClass' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/taxonomyClass

PUT Set TaxonomyReference ChartOfAccount

Updates the value of attribute 'TaxonomyReference' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
value (enum TaxonomyReference) The request body should contain the new value for the attribute.
See TaxonomyReference.

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 /businessCore/chartOfAccounts/{chartOfAccountsKey}/taxonomyReference

PUT Set Custom Attribute ChartOfAccount

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
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:

PUT /businessCore/chartOfAccounts/{chartOfAccountsKey}/{customAttributeName}

DELETE Operations

DELETE ChartOfAccount 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:

DELETE /businessCore/chartOfAccounts/{id}

DELETE ChartOfAccount by key

Deletes the entity record that matches the specified key.

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.

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:

DELETE /businessCore/chartOfAccounts/{chartOfAccountsKey}

Resources


ApiChartOfAccountResource

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
accountLength (int) If the accounts have a fixed lengh then set it here, otherwise leave it as 0.
isAlphanumeric (bool) Choose whether the accounts can have alphanumeric accounts or not.
hasPurchasesAccounts (bool) If is true the chart of accounts allows purchases accounts.

The following elements are optional:

description (string) The description of the chart of accounts.
taxonomyClass (string) If the chart of accounts is linked to a taxonomy then choose the class. In such case for movement accounts the taxanomy will be mandatory.
taxonomyReference (enum TaxonomyReference) The taxonomy reference for SAF-T export process (Portugal).
See TaxonomyReference.
copyFrom (string) Copy From.


ChartOfAccountResource

The following elements are required:

chartOfAccountsKey (string) The key of the chart of accounts.
accountLength (int) If the accounts have a fixed lengh then set it here, otherwise leave it as 0.
isAlphanumeric (bool) Choose whether the accounts can have alphanumeric accounts or not.
hasPurchasesAccounts (bool) If is true the chart of accounts allows purchases accounts.

The following elements are optional:

description (string) The description of the chart of accounts.
taxonomyClass (string) If the chart of accounts is linked to a taxonomy then choose the class. In such case for movement accounts the taxanomy will be mandatory.
(fk) Allowed value: the natural key of a record of type TaxonomyClass. These records are accessibly through the TaxonomyClasses service.
taxonomyReference (enum TaxonomyReference) The taxonomy reference for SAF-T export process (Portugal).
See TaxonomyReference.
copyFrom (string) Copy From.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


TaxonomyReference

1 SNCBase
2 InternationalNorms
3 SNCMicroEntities
4 Other