ROSE Developers - Web API Reference

Taxes | Tax Sub Class

A Tax Sub Class represents a sub type category for theTax Class, such as exempt or normal .

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET TaxSubClasses

Returns the list of all the entity records available.

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

GET TaxSubClasses (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 TaxSubClassResource.

Response status codes:

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

Resource URL:

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

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

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:

GET /taxesCore/taxSubClasses/{taxSubClassKey}

GET Print TaxSubClass 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/taxSubClasses/{id}/print?template={template}

GET Print TaxSubClass by key

Prints the specified entity record.

The following elements are required:

taxSubClassKey (string) The tax's sub class 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/taxSubClasses/{taxSubClassKey}/print

GET Original Print TaxSubClassOriginal 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/taxSubClasses/{id}/printOriginal?template={template}

GET Original Print TaxSubClass by key

Prints the specified entity record.

The following elements are required:

taxSubClassKey (string) The tax's sub class 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/taxSubClasses/{taxSubClassKey}/printOriginal

POST Operations

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.

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

Response status codes:

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

Resource URL:

POST /taxesCore/taxSubClasses

PUT Operations

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 /taxesCore/taxSubClasses/{taxSubClassKey}/description

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 /taxesCore/taxSubClasses/{taxSubClassKey}/edifact5305

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 /taxesCore/taxSubClasses/{taxSubClassKey}/externalId

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 /taxesCore/taxSubClasses/{taxSubClassKey}/externalVersion

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 /taxesCore/taxSubClasses/{taxSubClassKey}/isActive

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 /taxesCore/taxSubClasses/{taxSubClassKey}/isExternallyManaged

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 /taxesCore/taxSubClasses/{taxSubClassKey}/taxClass

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:

PUT /taxesCore/taxSubClasses/{taxSubClassKey}/taxSubClassKey

PUT Set Custom Attribute TaxSubClass

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

The following elements are required:

taxSubClassKey (string) The tax's sub class 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/taxSubClasses/{taxSubClassKey}/{customAttributeName}

DELETE Operations

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

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:

DELETE /taxesCore/taxSubClasses/{taxSubClassKey}

Resources


ApiTaxSubClassResource

The following elements are required:

taxSubClassKey (string) The tax's sub class key.
taxClass (string) The tax class will be processed.
isExternallyManaged (bool) The is externally managed flag indicates if the tax code rate 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) The tax class will be processed.
(fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service.
isExternallyManaged (bool) The is externally managed flag indicates if the tax code rate 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.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.