Taxes | Tax Classification

Service to manage entities of type 'FiscalClassification'.

Overview

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications

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

All Operations

This service includes the following operations:

GET:
POST:
- POST FiscalClassifications
PUT:
DELETE:
- DELETE FiscalClassification by identifier
- DELETE FiscalClassification by key

All Resources

This service uses the following resources:

ApiFiscalClassificationResource
FiscalClassificationResource

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{id}

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{id}/print?template={template}

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}/print

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{id}/printOriginal?template={template}

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}/printOriginal

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.

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}/description

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}/fiscalClassificationKey

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}/isActive

PUT /taxesCore/fiscalClassifications/{fiscalClassificationKey}/isActive

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:

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{id}

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

api/{tenantKey}/{orgKey}/taxesCore/fiscalClassifications/{fiscalClassificationKey}

DELETE /taxesCore/fiscalClassifications/{fiscalClassificationKey}

Resources

ApiFiscalClassificationResource

The following elements are required:

fiscalClassificationKey

(string) The fiscal classification's 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 key.

The following elements are optional:

description

(string) The fiscal classification's description.