ROSE Developers - Web API Reference

Taxes | Economic Activity Classification

The Economic Activity Classification represents the company's activity sector.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/economicActivityClassifications
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET EconomicActivityClassifications

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/economicActivityClassifications

GET EconomicActivityClassifications (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 EconomicActivityClassificationResource.

Response status codes:

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

Resource URL:

GET /taxesCore/economicActivityClassifications?page={page}&pageSize={pageSize}

GET EconomicActivityClassification 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 EconomicActivityClassificationResource.

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 /taxesCore/economicActivityClassifications/{id}

GET EconomicActivityClassification by key

Returns the entity record that matches the specified key.

The following elements are required:

economicActivityKey (string) The economic activity code key.

Response:

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

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 /taxesCore/economicActivityClassifications/{economicActivityKey}

GET Print EconomicActivityClassification 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 /taxesCore/economicActivityClassifications/{id}/print?template={template}

GET Print EconomicActivityClassification by key

Prints the specified entity record.

The following elements are required:

economicActivityKey (string) The economic activity code key.

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 /taxesCore/economicActivityClassifications/{economicActivityKey}/print

GET Original Print EconomicActivityClassificationOriginal 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 /taxesCore/economicActivityClassifications/{id}/printOriginal?template={template}

GET Original Print EconomicActivityClassification by key

Prints the specified entity record.

The following elements are required:

economicActivityKey (string) The economic activity code key.

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 /taxesCore/economicActivityClassifications/{economicActivityKey}/printOriginal

POST Operations

POST EconomicActivityClassifications

Creates a new entity record.

The following elements are required:

economicActivityClassificationResource (ApiEconomicActivityClassificationResource) The request body should contain the entity record that should be created.
See ApiEconomicActivityClassificationResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/economicActivityClassifications

POST Economic Activity Class

Inserts a new 'EAC Dimension' in the 'Economic Activity Class'.

The following elements are required:

economicActivityKey (string) The economic activity code key.
value (ApiEconomicActivityClassificationEACDimensionsResource) The ApiEconomicActivityClassificationEACDimensionsResource instance.
See ApiEconomicActivityClassificationEACDimensionsResource.

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:

POST /taxesCore/economicActivityClassifications/{economicActivityKey}/eACDimensions

PUT Operations

PUT Set Description EconomicActivityClassification

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
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 /taxesCore/economicActivityClassifications/{economicActivityKey}/description

PUT Set Dimension EACDimension

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
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:

PUT /taxesCore/economicActivityClassifications/{economicActivityKey}/eACDimensions/{lineId}/dimension

PUT Set DimensionValue EACDimension

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
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:

PUT /taxesCore/economicActivityClassifications/{economicActivityKey}/eACDimensions/{lineId}/dimensionValue

PUT Set EconomicActivityKey EconomicActivityClassification

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
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 /taxesCore/economicActivityClassifications/{economicActivityKey}/economicActivityKey

PUT Set IsActive EconomicActivityClassification

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
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 /taxesCore/economicActivityClassifications/{economicActivityKey}/isActive

PUT Set Custom Attribute EACDimension

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

The following elements are required:

economicActivityKey (string) The economic activity code key.
lineId (string) The detail identifier.
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 /taxesCore/economicActivityClassifications/{economicActivityKey}/eACDimensions/{lineId}/{customAttributeName}

DELETE Operations

DELETE EAC Dimension by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

economicActivityKey (string) The economic activity code key.
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:

DELETE /taxesCore/economicActivityClassifications/{economicActivityKey}/eACDimensions/{lineId}

DELETE EconomicActivityClassification 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 /taxesCore/economicActivityClassifications/{id}

DELETE EconomicActivityClassification by key

Deletes the entity record that matches the specified key.

The following elements are required:

economicActivityKey (string) The economic activity code key.

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 /taxesCore/economicActivityClassifications/{economicActivityKey}

Resources


ApiEconomicActivityClassificationEACDimensionsResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


ApiEconomicActivityClassificationResource

The following elements are required:

economicActivityKey (string) The economic activity code key.

The following elements are optional:

description (string) The EAC's description. EAC is a portuguese legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
eACDimensions (List of ApiEconomicActivityClassificationEACDimensionsResource) The economic activity codes dimensions.
See ApiEconomicActivityClassificationEACDimensionsResource.


EACDimensionResource

The following elements are required:

dimension (string) The dimension.
dimensionValue (string) The dimension value.


EconomicActivityClassificationResource

The following elements are required:

economicActivityKey (string) The economic activity code key.

The following elements are optional:

description (string) The EAC's description. EAC is a portuguese legal standard that attributes a 5-digit value to identify a company's specific category of professional activity.
eACDimensions (List of EACDimensionResource) The economic activity codes dimensions.
See EACDimensionResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.