Taxes | Tax Regional Area

A Tax Regional Area represents which region the tax type code applies to.

Overview

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas

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

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxRegionalAreas
PUT:
DELETE:
- DELETE TaxRegionalArea by identifier
- DELETE TaxRegionalArea by key

All Resources

This service uses the following resources:

ApiTaxRegionalAreaResource
TaxRegionalAreaResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET TaxRegionalAreas

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas

GET /taxesCore/taxRegionalAreas

GET TaxRegionalAreas (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 TaxRegionalAreaResource.

Response status codes:

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

Resource URL:

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

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

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:

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

GET /taxesCore/taxRegionalAreas/{id}

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}

GET /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}

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

GET /taxesCore/taxRegionalAreas/{id}/print?template={template}

GET Print TaxRegionalArea by key

Prints the specified entity record.

The following elements are required:

taxRegionalAreaKey

(string) The tax's regional area 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/taxRegionalAreas/{taxRegionalAreaKey}/print

GET /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/print

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

GET /taxesCore/taxRegionalAreas/{id}/printOriginal?template={template}

GET Original Print TaxRegionalArea by key

Prints the specified entity record.

The following elements are required:

taxRegionalAreaKey

(string) The tax's regional area 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/taxRegionalAreas/{taxRegionalAreaKey}/printOriginal

GET /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/printOriginal

POST Operations

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.

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas

POST /taxesCore/taxRegionalAreas

PUT Operations

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/country

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/country

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/description

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/description

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/isActive

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/isActive

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/region

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/region

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/taxRegionalAreaKey

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/taxRegionalAreaKey

PUT Set Custom Attribute TaxRegionalArea

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

The following elements are required:

taxRegionalAreaKey	(string) The tax's regional area 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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/{customAttributeName}

PUT /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}/{customAttributeName}

DELETE Operations

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:

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

DELETE /taxesCore/taxRegionalAreas/{id}

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:

api/{tenantKey}/{orgKey}/taxesCore/taxRegionalAreas/{taxRegionalAreaKey}

DELETE /taxesCore/taxRegionalAreas/{taxRegionalAreaKey}

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.