Taxes | Item WHT Schema
Service to manage entities of type 'ItemWithholdingTaxSchema'.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas |
| 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 ItemWithholdingTaxSchemas (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 ItemWithholdingTaxSchemaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET ItemWithholdingTaxSchema 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 ItemWithholdingTaxSchemaResource. |
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 ItemWithholdingTaxSchema by key
Returns the entity record that matches the specified key.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
Response:
| When successful, the response body contains the entity record. See ItemWithholdingTaxSchemaResource. |
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 ItemWithholdingTaxSchemas
Creates a new entity record.
The following elements are required:
| itemWithholdingTaxSchemaResource | (ApiItemWithholdingTaxSchemaResource) The request body should contain the entity record that should be created. See ApiItemWithholdingTaxSchemaResource. |
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 ApiItemWithholdingTaxSchemaResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Item WTax Schema List
Inserts a new 'Item WTax Schema List' in the 'Service Withholding'.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
| value | (ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource) The ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource instance. See ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource. |
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 ItemWithholdingTaxSchema
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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 ItemWithholdingTaxSchema
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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 ItemWithholdingTaxGroupKey ItemWithholdingTaxSchema
Updates the value of attribute 'ItemWithholdingTaxGroupKey' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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 WithholdingTaxCode ItemWithholdingTaxSchemaList
Updates the value of attribute 'WithholdingTaxCode' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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 WTax Schema List by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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 ItemWithholdingTaxSchema 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 ItemWithholdingTaxSchema by key
Deletes the entity record that matches the specified key.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding 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
ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource
The following elements are required:
| withholdingTaxCode | (string) The withholding Tax Type Code. The calculation base and the net value are set in the withheld tax code. You can set any number of withheld tax codes required for each type of withheld tax. |
ApiItemWithholdingTaxSchemaResource
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
The following elements are optional:
| itemWithholdingTaxSchemaLists | (List of ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource) The list of withholding taxes.
See ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource. |
| description | (string) The withholding tax schema identifies the group of withholding taxes an item is liable for. |
ItemWithholdingTaxSchemaResource
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
The following elements are optional:
| itemWithholdingTaxSchemaLists | (List of ItemWithholdingTaxSchemaListResource) The list of withholding taxes.
See ItemWithholdingTaxSchemaListResource. |
| description | (string) The withholding tax schema identifies the group of withholding taxes an item is liable for. |