Taxes | WHT Code

The Withholding Tax Code represents the withholding Tax rate.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET WithholdingTaxCodes
  • GET WithholdingTaxCodes (paged)
  • GET WithholdingTaxCode by identifier
  • GET WithholdingTaxCode by key
  • GET Print WithholdingTaxCode by identifier
  • GET Print WithholdingTaxCode by key
  • GET Original Print WithholdingTaxCodeOriginal by identifier
  • GET Original Print WithholdingTaxCode by key
  • GET Get Withholding Tax Code Tax Office
• POST:
  • POST WithholdingTaxCodes
  • POST WHT Code
• PUT:
  • PUT Set Custom Attribute WithholdingTaxCode
  • PUT Set Custom Attribute WithholdingTaxRate
  • PUT Set IsActive WithholdingTaxCode
  • PUT Set WithholdingTaxCodeKey WithholdingTaxCode
  • PUT Set WithholdingTaxType WithholdingTaxCode
  • PUT Set Description WithholdingTaxCode
  • PUT Set AmountBase WithholdingTaxCode
  • PUT Set RoundingOff WithholdingTaxCode
  • PUT Set RoundingType WithholdingTaxCode
  • PUT Set IncomeType WithholdingTaxCode
  • PUT Set IncomeCode WithholdingTaxCode
  • PUT Set TaxRegionalArea WithholdingTaxCode
  • PUT Set ValidFrom WithholdingTaxRate
  • PUT Set ValidTo WithholdingTaxRate
  • PUT Set Value WithholdingTaxRate
  • PUT Set Description WithholdingTaxRate
• DELETE:
  • DELETE WHT Rate by identifier
  • DELETE WithholdingTaxCode by identifier
  • DELETE WithholdingTaxCode by key

All Resources

This service uses the following resources:

• ApiWithholdingTaxCodeResource
• ApiWithholdingTaxCodeWithholdingTaxRatesResource
• WithholdingTaxCodeResource
• WithholdingTaxCodeTaxOfficeResource
• WithholdingTaxRateResource
• ExtensibilityCustomAttributeValueResource

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:

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:

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:

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:

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:

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:

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:

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:

GET Get Withholding Tax Code Tax Office

Gets the Tax Office of Withholding Tax Code.

The following elements are required:

withholdingTaxCodeNaturalKey

(string) The Withholding Tax Code Key.

Response:

When successful, the response body contains a resource of type 'WithholdingTaxCodeTaxOfficeResource'. See WithholdingTaxCodeTaxOfficeResource.

Response status codes:

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

Resource URL:

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.

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

Response status codes:

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

Resource URL:

POST WHT Code

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

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.

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:

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:

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:

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:

PUT Set IncomeCode WithholdingTaxCode

Updates the value of attribute 'IncomeCode' 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:

PUT Set IncomeType WithholdingTaxCode

Updates the value of attribute 'IncomeType' 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:

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:

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:

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:

PUT Set TaxRegionalArea WithholdingTaxCode

Updates the value of attribute 'TaxRegionalArea' 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:

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:

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:

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:

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:

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:

PUT Set Custom Attribute WithholdingTaxCode

Updates the value of 'CustomAttribute' 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.
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 Set Custom Attribute WithholdingTaxRate

Updates the value of 'CustomAttribute' 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.
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:

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:

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:

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:

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.
taxRegionalArea	(string) Tax Regional Area.

The following elements are optional:

description	(string) The withholding tax's type description. Specific subcategory of a tax whose payment is required by the state.
withholdingTaxRates	(List of ApiWithholdingTaxCodeWithholdingTaxRatesResource) The list of withholding tax rates. See ApiWithholdingTaxCodeWithholdingTaxRatesResource.
incomeType	(string) Income Type.
incomeCode	(string) Income.

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.
taxRegionalArea	(string) Tax Regional Area. (fk) Allowed value: the natural key of a record of type TaxRegionalArea. These records are accessibly through the TaxRegionalAreas service.

The following elements are optional:

description	(string) The withholding tax's type description. Specific subcategory of a tax whose payment is required by the state.
withholdingTaxRates	(List of WithholdingTaxRateResource) The list of withholding tax rates. See WithholdingTaxRateResource.
incomeType	(string) Income Type. (fk) Allowed value: the natural key of a record of type IncomeType. These records are accessibly through the IncomeTypes service.
incomeCode	(string) Income. (fk) Allowed value: the natural key of a record of type IncomeCode. These records are accessibly through the IncomeCodes service.

WithholdingTaxCodeTaxOfficeResource

The following elements are optional:

taxOfficePartyId	(Guid) The Tax Office Entity Id.
taxOfficePartyKey	(string) The Tax Office Entity Key.
taxOfficePartyDescription	(string) The Tax Office Entity Description.

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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AmountBase

1	TotalAmount
2	NetAmount

RoundingType

2	RoundUp
3	Downwards
1	Normal