Taxes | Tax Regional Area
Service to manage entities of type 'TaxRegionalArea'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET TaxRegionalAreas (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 TaxRegionalAreaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxRegionalArea 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 TaxRegionalAreaResource. |
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 TaxRegionalArea by key
Returns the entity record that matches the specified key.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area key. |
Response:
| When successful, the response body contains the entity record. See TaxRegionalAreaResource. |
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:
POST TaxRegionalAreas
Creates a new entity record.
The following elements are required:
| taxRegionalAreaResource | (ApiTaxRegionalAreaResource) The request body should contain the entity record that should be created. See ApiTaxRegionalAreaResource. |
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 ApiTaxRegionalAreaResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Country TaxRegionalArea
Updates the value of attribute 'Country' in the specified entity record.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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 Set Description TaxRegionalArea
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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 Set IsActive TaxRegionalArea
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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 Set Region TaxRegionalArea
Updates the value of attribute 'Region' in the specified entity record.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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 Set TaxRegionalAreaKey TaxRegionalArea
Updates the value of attribute 'TaxRegionalAreaKey' in the specified entity record.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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:
DELETE TaxRegionalArea 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 TaxRegionalArea by key
Deletes the entity record that matches the specified key.
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area 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:
Resources
ApiTaxRegionalAreaResource
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area key. |
| region | (string) The region of the taxes. |
| country | (string) The country of the taxes. |
The following elements are optional:
| description | (string) The tax's regional area description. Geographical area where certain tax rules and requirements are applied. |
TaxRegionalAreaResource
The following elements are required:
| taxRegionalAreaKey | (string) The tax's regional area key. |
| region | (string) The region of the taxes.
(fk) Allowed value: the natural key of a record of type Region. These records are accessibly through the Regions service. |
| country | (string) The country of the taxes.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
The following elements are optional:
| description | (string) The tax's regional area description. Geographical area where certain tax rules and requirements are applied. |