Jasmin Developers - Web API Reference

Taxes | WHT Type

Service to manage entities of type 'WithholdingTaxType'.

Overview


URL api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxTypes
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 WithholdingTaxTypes (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

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

Response status codes:

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

Resource URL:

GET /taxesCore/withholdingTaxTypes/odata

GET WithholdingTaxType 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 WithholdingTaxTypeResource.

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

GET WithholdingTaxType by key

Returns the entity record that matches the specified key.

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type key.

Response:

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

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/withholdingTaxTypes/{withholdingTaxTypeKey}

POST Operations

POST WithholdingTaxTypes

Creates a new entity record.

The following elements are required:

withholdingTaxTypeResource (ApiWithholdingTaxTypeResource) The request body should contain the entity record that should be created.
See ApiWithholdingTaxTypeResource.

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

Response status codes:

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

Resource URL:

POST /taxesCore/withholdingTaxTypes

PUT Operations

PUT Set BaseIncludesDiscount WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/baseIncludesDiscount

PUT Set BeneficiaryEntity WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/beneficiaryEntity

PUT Set Country WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/country

PUT Set Description WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/description

PUT Set FiscalWitholdingTaxType WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/fiscalWitholdingTaxType

PUT Set IsActive WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/isActive

PUT Set WithholdingTaxTypeKey WithholdingTaxType

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

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}/withholdingTaxTypeKey

DELETE Operations

DELETE WithholdingTaxType 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/withholdingTaxTypes/{id}

DELETE WithholdingTaxType by key

Deletes the entity record that matches the specified key.

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type 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/withholdingTaxTypes/{withholdingTaxTypeKey}

Resources


ApiWithholdingTaxTypeResource

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type key.
baseIncludesDiscount (bool) Indicates if the tax include discount.
beneficiaryEntity (string) Indicates the beneficiary of the withholding tax.
country (string) Indicates the country where the withholding tax is applied.

The following elements are optional:

description (string) The tax deducted at the beginning of the payment flow in some countries, and paid to the tax authorities on behalf of the person / company subject to that tax.
fiscalWitholdingTaxType (string) Indicates the fiscal withholding tax type.


WithholdingTaxTypeResource

The following elements are required:

withholdingTaxTypeKey (string) The withholding tax's type key.
baseIncludesDiscount (bool) Indicates if the tax include discount.
beneficiaryEntity (string) Indicates the beneficiary of the withholding tax.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service.
country (string) Indicates the country where the withholding tax is applied.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service.

The following elements are optional:

description (string) The tax deducted at the beginning of the payment flow in some countries, and paid to the tax authorities on behalf of the person / company subject to that tax.
fiscalWitholdingTaxType (string) Indicates the fiscal withholding tax type.
(fk) Allowed value: the natural key of a record of type FiscalWitholdingTaxType. These records are accessibly through the FiscalWitholdingTaxTypes service.