Taxes | WHT Code

Service to manage entities of type 'WithholdingTaxCode'.

Overview

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST WithholdingTaxCodes
- POST Withholding Rate
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiWithholdingTaxCodeResource
ApiWithholdingTaxCodeWithholdingTaxRatesResource
WithholdingTaxCodeResource
WithholdingTaxRateResource

All Enumerations

This service uses the following enumerations:

AmountBase
RoundingType

GET Operations

GET WithholdingTaxCodes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes

GET /taxesCore/withholdingTaxCodes

GET WithholdingTaxCodes (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 WithholdingTaxCodeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes?page={page}&pageSize={pageSize}

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

GET WithholdingTaxCode 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 WithholdingTaxCodeResource.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{id}

GET /taxesCore/withholdingTaxCodes/{id}

GET WithholdingTaxCode by key

Returns the entity record that matches the specified key.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.

Response:

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

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}

GET /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}

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

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{id}/print?template={template}

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

GET Print WithholdingTaxCode by key

Prints the specified entity record.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/print

GET /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/print

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

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{id}/printOriginal?template={template}

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

GET Original Print WithholdingTaxCode by key

Prints the specified entity record.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/printOriginal

GET /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/printOriginal

POST Operations

POST WithholdingTaxCodes

Creates a new entity record.

The following elements are required:

withholdingTaxCodeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes

POST /taxesCore/withholdingTaxCodes

POST Withholding Rate

Inserts a new 'WHT Rate' in the 'Withholding Rate'.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
value	(ApiWithholdingTaxCodeWithholdingTaxRatesResource) The ApiWithholdingTaxCodeWithholdingTaxRatesResource instance. See ApiWithholdingTaxCodeWithholdingTaxRatesResource.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates

POST /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates

PUT Operations

PUT Set AmountBase WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
value	(enum AmountBase) The request body should contain the new value for the attribute. See AmountBase.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/amountBase

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/amountBase

PUT Set Description WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/description

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/description

PUT Set Description WithholdingTaxRate

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/description

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/description

PUT Set IsActive WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/isActive

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/isActive

PUT Set RoundingOff WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
value	(int) 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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/roundingOff

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/roundingOff

PUT Set RoundingType WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
value	(enum RoundingType) The request body should contain the new value for the attribute. See RoundingType.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/roundingType

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/roundingType

PUT Set ValidFrom WithholdingTaxRate

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
lineId	(string) The detail identifier.
value	(DateTime) 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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/validFrom

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/validFrom

PUT Set ValidTo WithholdingTaxRate

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
lineId	(string) The detail identifier.
value	(DateTime) 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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/validTo

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/validTo

PUT Set Value WithholdingTaxRate

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
lineId	(string) The detail identifier.
value	(decimal) 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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/value

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}/value

PUT Set WithholdingTaxCodeKey WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxCodeKey

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxCodeKey

PUT Set WithholdingTaxType WithholdingTaxCode

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

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxType

PUT /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxType

DELETE Operations

DELETE WHT Rate by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}

DELETE /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}/withholdingTaxRates/{lineId}

DELETE WithholdingTaxCode 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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{id}

DELETE /taxesCore/withholdingTaxCodes/{id}

DELETE WithholdingTaxCode by key

Deletes the entity record that matches the specified key.

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.

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:

api/{tenantKey}/{orgKey}/taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}

DELETE /taxesCore/withholdingTaxCodes/{withholdingTaxCodeKey}/{withholdingTaxType}

Resources

ApiWithholdingTaxCodeResource

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type.
amountBase	(enum AmountBase) Indicates if it is total amount or net amount. See AmountBase.
roundingOff	(int) Indicates the number of decimal places.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.

The following elements are optional:

description	(string) The withholding tax's type description. 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.
withholdingTaxRates	(List of ApiWithholdingTaxCodeWithholdingTaxRatesResource) The list of withholding tax rates. See ApiWithholdingTaxCodeWithholdingTaxRatesResource.

ApiWithholdingTaxCodeWithholdingTaxRatesResource

The following elements are required:

validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
value	(decimal) The rate's value. Reference value for the calculation of values. percentage or a fraction value when it concerns rates (VAT, Withholding ...).

The following elements are optional:

description

(string) The rate's description.

WithholdingTaxCodeResource

The following elements are required:

withholdingTaxCodeKey	(string) The withholding tax's code key.
withholdingTaxType	(string) Thw withholding tax's type. (fk) Allowed value: the natural key of a record of type WithholdingTaxType. These records are accessibly through the WithholdingTaxTypes service.
amountBase	(enum AmountBase) Indicates if it is total amount or net amount. See AmountBase.
roundingOff	(int) Indicates the number of decimal places.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.

The following elements are optional:

description	(string) The withholding tax's type description. 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.
withholdingTaxRates	(List of WithholdingTaxRateResource) The list of withholding tax rates. See WithholdingTaxRateResource.

WithholdingTaxRateResource

The following elements are required:

validFrom	(DateTime) The start date for validity period.
validTo	(DateTime) The end date for validity period.
value	(decimal) The rate's value. Reference value for the calculation of values. percentage or a fraction value when it concerns rates (VAT, Withholding ...).

The following elements are optional:

description

(string) The rate's description.

Enumerations

AmountBase

1	TotalAmount
2	NetAmount

RoundingType

2	RoundUp
3	Downwards
1	Normal