ROSE Developers - Web API Reference

Taxes | Exemption Reason Code

An Exemption Reason Code represents the reasons for exemption when the item is exempt from Tax.

Overview


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

Returns the list of all the entity records available.

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

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

Response status codes:

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

Resource URL:

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

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}

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

GET Print ExemptionReasonCode by key

Prints the specified entity record.

The following elements are required:

exemptReasonKey (string) The exemption reason'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:

GET /taxesCore/exemptionReasonCodes/{exemptReasonKey}/print

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

GET Original Print ExemptionReasonCode by key

Prints the specified entity record.

The following elements are required:

exemptReasonKey (string) The exemption reason'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:

GET /taxesCore/exemptionReasonCodes/{exemptReasonKey}/printOriginal

POST Operations

POST ExemptionReasonCodes

Creates a new entity record.

The following elements are required:

exemptionReasonCodeResource (ApiExemptionReasonCodeResource) The request body should contain the entity record that should be created.
See ApiExemptionReasonCodeResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/exemptionReasonCodes

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

PUT Set TaxExemptionCode ExemptionReasonCode

Updates the value of attribute 'TaxExemptionCode' 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}/taxExemptionCode

PUT Set Custom Attribute ExemptionReasonCode

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

The following elements are required:

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

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


ApiExemptionReasonCodeResource

The following elements are required:

exemptReasonKey (string) The exemption reason's key.
taxClass (string) Tax Class that has to be reported(ex:IVA).
taxExemptionCode (string) The AT Tax Exemption Code.

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) The Renmarks indicates the country law rule (or rules) that allow the use of this exception reason.


ExemptionReasonCodeResource

The following elements are required:

exemptReasonKey (string) The exemption reason's key.
taxClass (string) Tax Class that has to be reported(ex:IVA).
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service.
taxExemptionCode (string) The AT Tax Exemption Code.

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) The Renmarks indicates the country law rule (or rules) that allow the use of this exception reason.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.