Taxes | Tax Sub Class
Service to manage entities of type 'TaxSubClass'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/taxSubClasses |
| 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 TaxSubClasses (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 TaxSubClassResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET TaxSubClass 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 TaxSubClassResource. |
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 TaxSubClass by key
Returns the entity record that matches the specified key.
The following elements are required:
| taxSubClassKey | (string) The tax's sub class key. |
Response:
| When successful, the response body contains the entity record. See TaxSubClassResource. |
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 TaxSubClasses
Creates a new entity record.
The following elements are required:
| taxSubClassResource | (ApiTaxSubClassResource) The request body should contain the entity record that should be created. See ApiTaxSubClassResource. |
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 ApiTaxSubClassResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description TaxSubClass
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 Edifact5305 TaxSubClass
Updates the value of attribute 'Edifact5305' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClass
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClass
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClass
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClass
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxClass TaxSubClass
Updates the value of attribute 'TaxClass' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClassKey TaxSubClass
Updates the value of attribute 'TaxSubClassKey' in the specified entity record.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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 TaxSubClass 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 TaxSubClass by key
Deletes the entity record that matches the specified key.
The following elements are required:
| taxSubClassKey | (string) The tax's sub 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
ApiTaxSubClassResource
The following elements are required:
| taxSubClassKey | (string) The tax's sub class key. |
| taxClass | (string) Tax Class. |
| isExternallyManaged | (bool) Is Externally Managed. |
The following elements are optional:
| description | (string) The tax's sub class description. Specific subcategory of a tax whose payment is required by the state. |
| externalId | (string) The external identifier. |
| externalVersion | (string) The external version. |
| edifact5305 | (string) EDIFACT 5305. |
TaxSubClassResource
The following elements are required:
| taxSubClassKey | (string) The tax's sub class key. |
| taxClass | (string) Tax Class.
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service. |
| isExternallyManaged | (bool) Is Externally Managed. |
The following elements are optional:
| description | (string) The tax's sub class description. Specific subcategory of a tax whose payment is required by the state. |
| externalId | (string) The external identifier. |
| externalVersion | (string) The external version. |
| edifact5305 | (string) EDIFACT 5305. |