Jasmin Developers - Web API Reference

Taxes | Exemption Reason Code

Service to manage entities of type 'ExemptionReasonCode'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET ExemptionReasonCodes (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 ExemptionReasonCodeResource.

Response status codes:

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

Resource URL:

GET /taxesCore/exemptionReasonCodes/odata

GET ExemptionReasonCode 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 ExemptionReasonCodeResource.

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

GET ExemptionReasonCode by key

Returns the entity record that matches the specified key.

The following elements are required:

exemptReasonKey (string) The exemption reason's key.

Response:

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

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/exemptionReasonCodes/{exemptReasonKey}

PUT Operations

PUT Set Description ExemptionReasonCode

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

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}/description

PUT Set ExemptReasonKey ExemptionReasonCode

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

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}/exemptReasonKey

PUT Set IsActive ExemptionReasonCode

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

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}/isActive

PUT Set Remarks ExemptionReasonCode

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

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}/remarks

PUT Set TaxClass ExemptionReasonCode

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

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}/taxClass

DELETE Operations

DELETE ExemptionReasonCode 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/exemptionReasonCodes/{id}

DELETE ExemptionReasonCode by key

Deletes the entity record that matches the specified key.

The following elements are required:

exemptReasonKey (string) The exemption reason'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/exemptionReasonCodes/{exemptReasonKey}

Resources


ExemptionReasonCodeResource

The following elements are required:

exemptReasonKey (string) The exemption reason's key.
taxClass (string) Tax Class.
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service.

The following elements are optional:

description (string) The exemption reason's description. It represents the reason why a specific operation does not pay taxes.
remarks (string) Defines the country law rule (or rules) that allow the use of this exception reason.