ROSE Developers - Web API Reference

Taxes | Party Tax Schema

A Party Tax Schema represents a tax aggregation and is associated with the party.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/partyTaxSchemas
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 PartyTaxSchemas

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See PartyTaxSchemaResource.

Response status codes:

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

Resource URL:

GET /taxesCore/partyTaxSchemas

GET PartyTaxSchemas (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 PartyTaxSchemaResource.

Response status codes:

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

Resource URL:

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

GET PartyTaxSchema 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 PartyTaxSchemaResource.

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

GET PartyTaxSchema by key

Returns the entity record that matches the specified key.

The following elements are required:

taxCodeGroupKey (string) The party's tax schema key.

Response:

When successful, the response body contains the entity record. See PartyTaxSchemaResource.

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/partyTaxSchemas/{taxCodeGroupKey}

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

GET Print PartyTaxSchema by key

Prints the specified entity record.

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/print

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

GET Original Print PartyTaxSchema by key

Prints the specified entity record.

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/printOriginal

POST Operations

POST PartyTaxSchemas

Creates a new entity record.

The following elements are required:

partyTaxSchemaResource (ApiPartyTaxSchemaResource) The request body should contain the entity record that should be created.
See ApiPartyTaxSchemaResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/partyTaxSchemas

POST Tax Regime

Inserts a new 'Party Tax Schema List' in the 'Tax Regime'.

The following elements are required:

taxCodeGroupKey (string) The party's tax schema key.
value (ApiPartyTaxSchemaPartyTaxSchemaListsResource) The ApiPartyTaxSchemaPartyTaxSchemaListsResource instance.
See ApiPartyTaxSchemaPartyTaxSchemaListsResource.

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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists

PUT Operations

PUT Set AllowedIn PartyTaxSchema

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/allowedIn

PUT Set Description PartyTaxSchema

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/description

PUT Set ExemptionReasonCode PartyTaxSchemaList

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists/{lineId}/exemptionReasonCode

PUT Set IsActive PartyTaxSchema

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/isActive

PUT Set IsExempt PartyTaxSchemaList

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

The following elements are required:

taxCodeGroupKey (string) The party's tax schema key.
lineId (string) The detail identifier.
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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists/{lineId}/isExempt

PUT Set TaxCodeGroupKey PartyTaxSchema

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/taxCodeGroupKey

PUT Set TaxTypeCode PartyTaxSchemaList

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists/{lineId}/taxTypeCode

PUT Set Custom Attribute PartyTaxSchema

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/{customAttributeName}

PUT Set Custom Attribute PartyTaxSchemaList

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

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists/{lineId}/{customAttributeName}

DELETE Operations

DELETE Party Tax Schema List by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}/partyTaxSchemaLists/{lineId}

DELETE PartyTaxSchema 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/partyTaxSchemas/{id}

DELETE PartyTaxSchema by key

Deletes the entity record that matches the specified key.

The following elements are required:

taxCodeGroupKey (string) The party's 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/partyTaxSchemas/{taxCodeGroupKey}

Resources


ApiPartyTaxSchemaPartyTaxSchemaListsResource

The following elements are required:

taxTypeCode (string) The tax's type code. Code that identifies the type of tax applied.
isExempt (bool) Indicates if is exempt or not. Discharge from payment of certain fees based on the fulfillment of certain attributes.

The following elements are optional:

exemptionReasonCode (string) The exemption reason's code. It represents the reason why a specific operation does not pay taxes.


ApiPartyTaxSchemaResource

The following elements are required:

taxCodeGroupKey (string) The party's tax schema key.
allowedIn (enum AllowedIn) The allowed in flag idicates if the tax schema is to be used in sales or purchases.
See AllowedIn.

The following elements are optional:

description (string) The party's tax schema description. The tax schema identifies the group of taxes a party is liable for. This group usually depends on the company situation or the head office location.
partyTaxSchemaLists (List of ApiPartyTaxSchemaPartyTaxSchemaListsResource) The list of taxes.
See ApiPartyTaxSchemaPartyTaxSchemaListsResource.


PartyTaxSchemaListResource

The following elements are required:

taxTypeCode (string) The tax's type code. Code that identifies the type of tax applied.
isExempt (bool) Indicates if is exempt or not. Discharge from payment of certain fees based on the fulfillment of certain attributes.

The following elements are optional:

exemptionReasonCode (string) The exemption reason's code. It represents the reason why a specific operation does not pay taxes.


PartyTaxSchemaResource

The following elements are required:

taxCodeGroupKey (string) The party's tax schema key.
allowedIn (enum AllowedIn) The allowed in flag idicates if the tax schema is to be used in sales or purchases.
See AllowedIn.

The following elements are optional:

description (string) The party's tax schema description. The tax schema identifies the group of taxes a party is liable for. This group usually depends on the company situation or the head office location.
partyTaxSchemaLists (List of PartyTaxSchemaListResource) The list of taxes.
See PartyTaxSchemaListResource.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


AllowedIn

1 Sales
2 Purchases