Taxes | Tax Class

A Tax Class represents a type of tax e.g VAT.

Overview

api/{tenantKey}/{orgKey}/taxesCore/taxClasses

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

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxClasses
PUT:
DELETE:
- DELETE TaxClass by identifier
- DELETE TaxClass by key

All Resources

This service uses the following resources:

ApiTaxClassResource
TaxClassResource
ExtensibilityCustomAttributeValueResource

GET Operations

GET TaxClasses

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See TaxClassResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxClasses

GET /taxesCore/taxClasses

GET TaxClasses (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 TaxClassResource.

Response status codes:

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

Resource URL:

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

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

GET TaxClass 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 TaxClassResource.

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

GET /taxesCore/taxClasses/{id}

GET TaxClass by key

Returns the entity record that matches the specified key.

The following elements are required:

taxClassKey

(string) The tax's class key.

Response:

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

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/taxClasses/{taxClassKey}

GET /taxesCore/taxClasses/{taxClassKey}

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

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

GET Print TaxClass by key

Prints the specified entity record.

The following elements are required:

taxClassKey

(string) The tax's class 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/taxClasses/{taxClassKey}/print

GET /taxesCore/taxClasses/{taxClassKey}/print

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

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

GET Original Print TaxClass by key

Prints the specified entity record.

The following elements are required:

taxClassKey

(string) The tax's class 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/taxClasses/{taxClassKey}/printOriginal

GET /taxesCore/taxClasses/{taxClassKey}/printOriginal

POST Operations

POST TaxClasses

Creates a new entity record.

The following elements are required:

taxClassResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxClasses

POST /taxesCore/taxClasses

PUT Operations

PUT Set Description TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/description

PUT /taxesCore/taxClasses/{taxClassKey}/description

PUT Set Edifact5153 TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/edifact5153

PUT /taxesCore/taxClasses/{taxClassKey}/edifact5153

PUT Set ExternalId TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/externalId

PUT /taxesCore/taxClasses/{taxClassKey}/externalId

PUT Set ExternalVersion TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/externalVersion

PUT /taxesCore/taxClasses/{taxClassKey}/externalVersion

PUT Set IsActive TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/isActive

PUT /taxesCore/taxClasses/{taxClassKey}/isActive

PUT Set IsExternallyManaged TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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.

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxClasses/{taxClassKey}/isExternallyManaged

PUT /taxesCore/taxClasses/{taxClassKey}/isExternallyManaged

PUT Set TaxClassKey TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/taxClassKey

PUT /taxesCore/taxClasses/{taxClassKey}/taxClassKey

PUT Set Custom Attribute TaxClass

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

The following elements are required:

taxClassKey	(string) The tax's class 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/taxClasses/{taxClassKey}/{customAttributeName}

PUT /taxesCore/taxClasses/{taxClassKey}/{customAttributeName}

DELETE Operations

DELETE TaxClass 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/taxClasses/{id}

DELETE /taxesCore/taxClasses/{id}

DELETE TaxClass by key

Deletes the entity record that matches the specified key.

The following elements are required:

taxClassKey

(string) The tax's class 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/taxClasses/{taxClassKey}

DELETE /taxesCore/taxClasses/{taxClassKey}

Resources

ApiTaxClassResource

The following elements are required:

taxClassKey	(string) The tax's class key.
isExternallyManaged	(bool) The IsExternally managed flag indicates if the tax class is externally managed.

The following elements are optional:

description	(string) The tax's class key description. Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
edifact5153	(string) EDIFACT 5153.

TaxClassResource

The following elements are required:

taxClassKey	(string) The tax's class key.
isExternallyManaged	(bool) The IsExternally managed flag indicates if the tax class is externally managed.

The following elements are optional:

description	(string) The tax's class key description. Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
edifact5153	(string) EDIFACT 5153.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.