Jasmin Developers - Web API Reference

Taxes | Tax Classification

Service to manage entities of type 'FiscalClassification'.

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 (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

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/odata

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

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:

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:

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:

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:

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:

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:

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.