Taxes | Tax Class
Service to manage entities of type 'TaxClass'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/taxClasses |
| 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 TaxClasses (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 TaxClassResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
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:
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:
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. |
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
Resources
ApiTaxClassResource
The following elements are required:
| taxClassKey | (string) The tax's class key. |
| isExternallyManaged | (bool) 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) 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. |