ROSE Developers - Web API Reference

Taxes | Tax Classification

The Fiscal Classification represents an item Fiscal Type.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications
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 FiscalClassifications

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/fiscalClassifications

GET FiscalClassifications (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 FiscalClassificationResource.

Response status codes:

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

Resource URL:

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

GET FiscalClassification 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 FiscalClassificationResource.

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

GET FiscalClassification by key

Returns the entity record that matches the specified key.

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique key.

Response:

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

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/fiscalClassifications/{fiscalClassificationKey}

GET Print FiscalClassification 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/fiscalClassifications/{id}/print?template={template}

GET Print FiscalClassification by key

Prints the specified entity record.

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}/print

GET Original Print FiscalClassificationOriginal 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/fiscalClassifications/{id}/printOriginal?template={template}

GET Original Print FiscalClassification by key

Prints the specified entity record.

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}/printOriginal

POST Operations

POST FiscalClassifications

Creates a new entity record.

The following elements are required:

fiscalClassificationResource (ApiFiscalClassificationResource) The request body should contain the entity record that should be created.
See ApiFiscalClassificationResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/fiscalClassifications

PUT Operations

PUT Set Description FiscalClassification

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

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}/description

PUT Set FiscalClassificationKey FiscalClassification

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

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}/fiscalClassificationKey

PUT Set IsActive FiscalClassification

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

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}/isActive

PUT Set Custom Attribute FiscalClassification

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

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique key.
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/fiscalClassifications/{fiscalClassificationKey}/{customAttributeName}

DELETE Operations

DELETE FiscalClassification 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/fiscalClassifications/{id}

DELETE FiscalClassification by key

Deletes the entity record that matches the specified key.

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique 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/fiscalClassifications/{fiscalClassificationKey}

Resources


ApiFiscalClassificationResource

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique key.

The following elements are optional:

description (string) The fiscal classification's description.


FiscalClassificationResource

The following elements are required:

fiscalClassificationKey (string) The fiscal classification's unique key.

The following elements are optional:

description (string) The fiscal classification's description.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.