Taxes | Item Tax Schema
Service to manage entities of type 'ItemTaxSchema'.
Overview
URL | api/{tenantKey}/{orgKey}/taxesCore/itemTaxSchemas |
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 ItemTaxSchemas (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 ItemTaxSchemaResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ItemTaxSchema 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 ItemTaxSchemaResource. |
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 ItemTaxSchema by key
Returns the entity record that matches the specified key.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
Response:
When successful, the response body contains the entity record. See ItemTaxSchemaResource. |
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 ItemTaxSchemas
Creates a new entity record.
The following elements are required:
itemTaxSchemaResource | (ApiItemTaxSchemaResource) The request body should contain the entity record that should be created. See ApiItemTaxSchemaResource. |
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 ApiItemTaxSchemaResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Item Tax Schema List
Inserts a new 'Item Tax Schema List' in the 'Tax Type'.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
value | (ApiItemTaxSchemaItemTaxSchemaListsResource) The ApiItemTaxSchemaItemTaxSchemaListsResource instance. See ApiItemTaxSchemaItemTaxSchemaListsResource. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description ItemTaxSchema
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 ItemTaxSchema
Updates the value of attribute 'ExternalId' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 ItemTaxSchema
Updates the value of attribute 'ExternalVersion' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 ItemTaxSchema
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 ItemTaxSchema
Updates the value of attribute 'IsExternallyManaged' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 TaxCodeItemGroupKey ItemTaxSchema
Updates the value of attribute 'TaxCodeItemGroupKey' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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 TaxTypeCode ItemTaxSchemaList
Updates the value of attribute 'TaxTypeCode' in the specified entity record.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
lineId | (string) The detail identifier. |
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 Item Tax Schema List by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE ItemTaxSchema 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 ItemTaxSchema by key
Deletes the entity record that matches the specified key.
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema 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
ApiItemTaxSchemaItemTaxSchemaListsResource
The following elements are required:
taxTypeCode | (string) Tax type code. Code that identifies the type of tax applied. |
ApiItemTaxSchemaResource
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
isExternallyManaged | (bool) Is Externally Managed. |
The following elements are optional:
description | (string) The item tax schema description. The tax schema identifies the group of taxes an item is liable for. |
itemTaxSchemaLists | (List of ApiItemTaxSchemaItemTaxSchemaListsResource) The list of taxes.
See ApiItemTaxSchemaItemTaxSchemaListsResource. |
externalId | (string) External Id. |
externalVersion | (string) External Version. |
ItemTaxSchemaResource
The following elements are required:
taxCodeItemGroupKey | (string) The item tax schema key. |
isExternallyManaged | (bool) Is Externally Managed. |
isDefaultExempt | (bool) Is Default Exempt. |
The following elements are optional:
description | (string) The item tax schema description. The tax schema identifies the group of taxes an item is liable for. |
itemTaxSchemaLists | (List of ItemTaxSchemaListResource) The list of taxes.
See ItemTaxSchemaListResource. |
externalId | (string) External Id. |
externalVersion | (string) External Version. |