Jasmin Developers - Web API Reference

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:

All Resources

This service uses the following resources:

GET Operations

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:

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:

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:

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:

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:

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:

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:

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:

GET /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/printOriginal

POST Operations

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

POST Service Withholding

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:

POST /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists

PUT Operations

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 /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:

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:

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:

PUT /taxesCore/itemWithholdingTaxSchemas/{itemWithholdingTaxGroupKey}/itemWithholdingTaxSchemaLists/{lineId}/withholdingTaxCode

DELETE Operations

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 /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:

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:

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 withholding tax schema identifies the group of withholding 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 withholding tax schema identifies the group of withholding taxes an item is liable for.