Taxes | Item WHT Schema
The Item Withholding Tax Schema represents a withholding tax aggregation, associated with the Item.
Overview
| URL | api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
-
GET:
- GET ItemWithholdingTaxSchemas
- GET ItemWithholdingTaxSchemas (paged)
- GET ItemWithholdingTaxSchema by identifier
- GET ItemWithholdingTaxSchema by key
- GET Print ItemWithholdingTaxSchema by identifier
- GET Print ItemWithholdingTaxSchema by key
- GET Original Print ItemWithholdingTaxSchemaOriginal by identifier
- GET Original Print ItemWithholdingTaxSchema by key
- POST:
-
PUT:
- PUT Set Custom Attribute ItemWithholdingTaxSchema
- PUT Set Custom Attribute ItemWithholdingTaxSchemaList
- PUT Set IsActive ItemWithholdingTaxSchema
- PUT Set ItemWithholdingTaxGroupKey ItemWithholdingTaxSchema
- PUT Set Description ItemWithholdingTaxSchema
- PUT Set WithholdingTaxCode ItemWithholdingTaxSchemaList
- DELETE:
All Resources
This service uses the following resources:
GET ItemWithholdingTaxSchemas
Returns the list of all the entity records available.
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas
GET /taxesCore/itemWithholdingTaxSchemas
GET ItemWithholdingTaxSchemas (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 ItemWithholdingTaxSchemaResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas?page={page}&pageSize={pageSize}
GET /taxesCore/itemWithholdingTaxSchemas?page={page}&pageSize={pageSize}
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{id}
GET /taxesCore/itemWithholdingTaxSchemas/{id}
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}
GET /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}
GET Print ItemWithholdingTaxSchema 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/itemWithholdingTaxSchemas/{id}/print?template={template}
GET /taxesCore/itemWithholdingTaxSchemas/{id}/print?template={template}
GET Print ItemWithholdingTaxSchema by key
Prints the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema 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/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/print
GET /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/print
GET Original Print ItemWithholdingTaxSchemaOriginal 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/itemWithholdingTaxSchemas/{id}/printOriginal?template={template}
GET /taxesCore/itemWithholdingTaxSchemas/{id}/printOriginal?template={template}
GET Original Print ItemWithholdingTaxSchema by key
Prints the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema 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/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/printOriginal
GET /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/printOriginal
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. |
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 ApiItemWithholdingTaxSchemaResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas
POST /taxesCore/itemWithholdingTaxSchemas
POST Withholding Tax
Inserts a new 'Item WTax Schema List' in the 'Withholding Tax'.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
| value | (ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource) The ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource instance. See ApiItemWithholdingTaxSchemaItemWithholdingTaxSchemaListsResource. |
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 is empty. |
Response status codes:
| 204 | NoContent. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists
POST /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/description
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/description
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/isActive
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/isActive
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxGroupKey
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxGroupKey
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}/withholdingTaxCode
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}/withholdingTaxCode
PUT Set Custom Attribute ItemWithholdingTaxSchema
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema 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/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/{customAttributeName}
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/{customAttributeName}
PUT Set Custom Attribute ItemWithholdingTaxSchemaList
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| itemWithholdingTaxGroupKey | (string) The item's withholding tax schema key. |
| lineId | (string) The detail identifier. |
| 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/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}/{customAttributeName}
PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}/{customAttributeName}
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}
DELETE /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{id}
DELETE /taxesCore/itemWithholdingTaxSchemas/{id}
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:
api/{tenantKey}/{orgKey}/taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}
DELETE /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}
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 item's withholding tax schema description. The withholding tax schema identifies the group of withholgin taxes an item is liable for. |
ItemWithholdingTaxSchemaListResource
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. |
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 item's withholding tax schema description. The withholding tax schema identifies the group of withholgin taxes an item is liable for. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |