ROSE Developers - Web API Reference

Taxes | Item Tax Schema

An ItemTax Schema represents a tax aggregation and is associated with the item.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/itemTaxSchemas
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET ItemTaxSchemas

Returns the list of all the entity records available.

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 /taxesCore/itemTaxSchemas

GET ItemTaxSchemas (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 ItemTaxSchemaResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /taxesCore/itemTaxSchemas?page={page}&pageSize={pageSize}

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 /taxesCore/itemTaxSchemas/{id}

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:

GET /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}

GET Print ItemTaxSchema 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:

GET /taxesCore/itemTaxSchemas/{id}/print?template={template}

GET Print ItemTaxSchema by key

Prints the specified entity record.

The following elements are required:

taxCodeItemGroupKey (string) The item 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:

GET /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/print

GET Original Print ItemTaxSchemaOriginal 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:

GET /taxesCore/itemTaxSchemas/{id}/printOriginal?template={template}

GET Original Print ItemTaxSchema by key

Prints the specified entity record.

The following elements are required:

taxCodeItemGroupKey (string) The item 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:

GET /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/printOriginal

POST Operations

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.

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 ApiItemTaxSchemaResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /taxesCore/itemTaxSchemas

POST Tax

Inserts a new 'Item Tax Schema List' in the 'Tax'.

The following elements are required:

taxCodeItemGroupKey (string) The item tax schema key.
value (ApiItemTaxSchemaItemTaxSchemaListsResource) The ApiItemTaxSchemaItemTaxSchemaListsResource instance.
See ApiItemTaxSchemaItemTaxSchemaListsResource.

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:

POST /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/itemTaxSchemaLists

PUT Operations

PUT Set AllowedIn ItemTaxSchema

Updates the value of attribute 'AllowedIn' in the specified entity record.

The following elements are required:

taxCodeItemGroupKey (string) The item tax schema key.
value (enum AllowedIn) The request body should contain the new value for the attribute.
See AllowedIn.

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/allowedIn

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/description

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/externalId

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/externalVersion

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/isActive

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/isExternallyManaged

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/taxCodeItemGroupKey

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:

PUT /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/itemTaxSchemaLists/{lineId}/taxTypeCode

PUT Set Custom Attribute ItemTaxSchema

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

taxCodeItemGroupKey (string) The item 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:

PUT /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/{customAttributeName}

PUT Set Custom Attribute ItemTaxSchemaList

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

taxCodeItemGroupKey (string) The item 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:

PUT /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/itemTaxSchemaLists/{lineId}/{customAttributeName}

DELETE Operations

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 /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}/itemTaxSchemaLists/{lineId}

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 /taxesCore/itemTaxSchemas/{id}

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:

DELETE /taxesCore/itemTaxSchemas/{taxCodeItemGroupKey}

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) The is externally managed flag indicates if the tax code rate is externally managed.
allowedIn (enum AllowedIn) The allowed in flag indicates if the tax schema is to be used in sales or purchases.
See AllowedIn.

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) The external identifier.
externalVersion (string) The external version for the item tax schema.


ItemTaxSchemaListResource

The following elements are required:

taxTypeCode (string) Tax type code. Code that identifies the type of tax applied.


ItemTaxSchemaResource

The following elements are required:

taxCodeItemGroupKey (string) The item tax schema key.
isExternallyManaged (bool) The is externally managed flag indicates if the tax code rate is externally managed.
allowedIn (enum AllowedIn) The allowed in flag indicates if the tax schema is to be used in sales or purchases.
See AllowedIn.

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) The external identifier.
externalVersion (string) The external version for the item tax schema.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AllowedIn

1 Sales
2 Purchases