Taxes | Tax Type Code

A Tax Type Code represents one or more Tax Rules to transactions based on various criteria.

Overview

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes

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

All Operations

This service includes the following operations:

GET:
POST:
- POST TaxTypeCodes
- POST Tax Type Code
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiTaxTypeCodeResource
ApiTaxTypeCodeTaxCodeRatesResource
TaxCodeRateResource
TaxTypeCodeResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

BaseValue
RateType
RoundingType
ScaleMethod
TaxType

GET Operations

GET TaxTypeCodes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes

GET /taxesCore/taxTypeCodes

GET TaxTypeCodes (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 TaxTypeCodeResource.

Response status codes:

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

Resource URL:

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

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

GET TaxTypeCode 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 TaxTypeCodeResource.

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

GET /taxesCore/taxTypeCodes/{id}

GET TaxTypeCode by key

Returns the entity record that matches the specified key.

The following elements are required:

taxCodeKey

(string) The tax's code key.

Response:

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

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/taxTypeCodes/{taxCodeKey}

GET /taxesCore/taxTypeCodes/{taxCodeKey}

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

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

GET Print TaxTypeCode by key

Prints the specified entity record.

The following elements are required:

taxCodeKey

(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/print

GET /taxesCore/taxTypeCodes/{taxCodeKey}/print

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

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

GET Original Print TaxTypeCode by key

Prints the specified entity record.

The following elements are required:

taxCodeKey

(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/printOriginal

GET /taxesCore/taxTypeCodes/{taxCodeKey}/printOriginal

POST Operations

POST TaxTypeCodes

Creates a new entity record.

The following elements are required:

taxTypeCodeResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes

POST /taxesCore/taxTypeCodes

POST Tax Type Code

Inserts a new 'Tax Code Rate' in the 'Tax Type Code'.

The following elements are required:

taxCodeKey	(string) The tax's code key.
value	(ApiTaxTypeCodeTaxCodeRatesResource) The ApiTaxTypeCodeTaxCodeRatesResource instance. See ApiTaxTypeCodeTaxCodeRatesResource.

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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates

POST /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates

PUT Operations

PUT Set BaseValue TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
value	(enum BaseValue) The request body should contain the new value for the attribute. See BaseValue.

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/taxTypeCodes/{taxCodeKey}/baseValue

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/baseValue

PUT Set Deductible TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/deductible

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/deductible

PUT Set Description TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/description

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/description

PUT Set Description TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/description

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/description

PUT Set EUSalesList TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/eUSalesList

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/eUSalesList

PUT Set ExternalId TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/externalId

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/externalId

PUT Set ExternalId TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/externalId

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/externalId

PUT Set ExternalVersion TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/externalVersion

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/externalVersion

PUT Set ExternalVersion TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/externalVersion

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/externalVersion

PUT Set IsActive TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/isActive

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isActive

PUT Set IsDeductible TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/isDeductible

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isDeductible

PUT Set IsExternallyManaged TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/isExternallyManaged

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/isExternallyManaged

PUT Set IsExternallyManaged TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/isExternallyManaged

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isExternallyManaged

PUT Set IsPartyRequired TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/isPartyRequired

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isPartyRequired

PUT Set PrintCodeText TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/printCodeText

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/printCodeText

PUT Set RateType TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
value	(enum RateType) The request body should contain the new value for the attribute. See RateType.

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/taxTypeCodes/{taxCodeKey}/rateType

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/rateType

PUT Set ReverseCharge TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/reverseCharge

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/reverseCharge

PUT Set RoundingOff TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/roundingOff

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/roundingOff

PUT Set RoundingType TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/roundingType

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/roundingType

PUT Set ScaleMethod TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
value	(enum ScaleMethod) The request body should contain the new value for the attribute. See ScaleMethod.

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/taxTypeCodes/{taxCodeKey}/scaleMethod

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/scaleMethod

PUT Set TaxClass TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxClass

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxClass

PUT Set TaxCodeKey TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeKey

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeKey

PUT Set TaxRegionalArea TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxRegionalArea

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxRegionalArea

PUT Set TaxSubClass TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxSubClass

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxSubClass

PUT Set TaxType TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
value	(enum TaxType) The request body should contain the new value for the attribute. See TaxType.

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/taxTypeCodes/{taxCodeKey}/taxType

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxType

PUT Set ValidFrom TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/validFrom

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/validFrom

PUT Set ValidTo TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/validTo

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/validTo

PUT Set Value TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code key.
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/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/value

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/value

PUT Set Custom Attribute TaxTypeCode

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/{customAttributeName}

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/{customAttributeName}

PUT Set Custom Attribute TaxCodeRate

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

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/{customAttributeName}

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}/{customAttributeName}

DELETE Operations

DELETE Tax Code Rate by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

taxCodeKey	(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}

DELETE /taxesCore/taxTypeCodes/{taxCodeKey}/taxCodeRates/{lineId}

DELETE TaxTypeCode 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/taxTypeCodes/{id}

DELETE /taxesCore/taxTypeCodes/{id}

DELETE TaxTypeCode by key

Deletes the entity record that matches the specified key.

The following elements are required:

taxCodeKey

(string) The tax's code 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:

api/{tenantKey}/{orgKey}/taxesCore/taxTypeCodes/{taxCodeKey}

DELETE /taxesCore/taxTypeCodes/{taxCodeKey}

Resources

ApiTaxTypeCodeResource

The following elements are required:

taxCodeKey	(string) The tax's code key.
eUSalesList	(bool) Indicates if is a tax for EU.
roundingOff	(int) Indicates the number of decimal places.
scaleMethod	(enum ScaleMethod) Indicates the scale method. See ScaleMethod.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.
rateType	(enum RateType) Indicates the rate type. See RateType.
baseValue	(enum BaseValue) Indicates if the value is calculated based on net amount of document or per line. See BaseValue.
taxClass	(string) Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax.
taxSubClass	(string) The specific subcategory of a tax whose payment is required by the state.
taxRegionalArea	(string) The geographical area where certain tax rules and requirements are applied.
isExternallyManaged	(bool) A flag indicating if the tax type code is externally managed.
reverseCharge	(bool) When the reverse charge is applied the recipent of the goods or services makes the declartion of both their purchases (Input tax) and the supplier's sale (output VAT) in their VAT return.
taxType	(enum TaxType) Choose whether the tax is input (purchases) or output (sales). See TaxType.
isPartyRequired	(bool) Specify if it necessary to have a party.

The following elements are optional:

taxCodeRates	(List of ApiTaxTypeCodeTaxCodeRatesResource) The list of tax rates. See ApiTaxTypeCodeTaxCodeRatesResource.
description	(string) The tax's type description.
printCodeText	(string) The code that will be used in printing.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
isDeductible	(bool) Internal flag set if the tax type code is deductible.

ApiTaxTypeCodeTaxCodeRatesResource

The following elements are required:

validFrom	(DateTime) The date from which the rate is valid.
validTo	(DateTime) The date until which the rate is valid.
deductible	(decimal) The deductible's percentage. The insurance deductible is the amount of money you will pay in an insurance claim before the insurance coverage starts paying you.
value	(decimal) The rate's value. Reference value for the calculation of values. percentage or a fraction value when it concerns rates (VAT, Withholding ...).
isExternallyManaged	(bool) The is externally managed flag indicates if the tax code rate is externally managed.

The following elements are optional:

description	(string) The rate's description.
externalId	(string) The external identifier.
externalVersion	(string) The external version.

TaxCodeRateResource

The following elements are required:

validFrom	(DateTime) The date from which the rate is valid.
validTo	(DateTime) The date until which the rate is valid.
deductible	(decimal) The deductible's percentage. The insurance deductible is the amount of money you will pay in an insurance claim before the insurance coverage starts paying you.
value	(decimal) The rate's value. Reference value for the calculation of values. percentage or a fraction value when it concerns rates (VAT, Withholding ...).
isExternallyManaged	(bool) The is externally managed flag indicates if the tax code rate is externally managed.

The following elements are optional:

description	(string) The rate's description.
externalId	(string) The external identifier.
externalVersion	(string) The external version.

TaxTypeCodeResource

The following elements are required:

taxCodeKey	(string) The tax's code key.
eUSalesList	(bool) Indicates if is a tax for EU.
roundingOff	(int) Indicates the number of decimal places.
scaleMethod	(enum ScaleMethod) Indicates the scale method. See ScaleMethod.
roundingType	(enum RoundingType) The type of rounding applicable on withholding tax. See RoundingType.
rateType	(enum RateType) Indicates the rate type. See RateType.
baseValue	(enum BaseValue) Indicates if the value is calculated based on net amount of document or per line. See BaseValue.
taxClass	(string) Identification of the type of tax, for example, Value Added Tax (VAT) or Stamp Tax. (fk) Allowed value: the natural key of a record of type TaxClass. These records are accessibly through the TaxClasses service.
taxSubClass	(string) The specific subcategory of a tax whose payment is required by the state. (fk) Allowed value: the natural key of a record of type TaxSubClass. These records are accessibly through the TaxSubClasses service.
taxRegionalArea	(string) The geographical area where certain tax rules and requirements are applied. (fk) Allowed value: the natural key of a record of type TaxRegionalArea. These records are accessibly through the TaxRegionalAreas service.
isExternallyManaged	(bool) A flag indicating if the tax type code is externally managed.
reverseCharge	(bool) When the reverse charge is applied the recipent of the goods or services makes the declartion of both their purchases (Input tax) and the supplier's sale (output VAT) in their VAT return.
taxType	(enum TaxType) Choose whether the tax is input (purchases) or output (sales). See TaxType.
isPartyRequired	(bool) Specify if it necessary to have a party.

The following elements are optional:

taxCodeRates	(List of TaxCodeRateResource) The list of tax rates. See TaxCodeRateResource.
description	(string) The tax's type description.
printCodeText	(string) The code that will be used in printing.
externalId	(string) The external identifier.
externalVersion	(string) The external version.
isDeductible	(bool) Internal flag set if the tax type code is deductible.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

BaseValue

1	NetAmountPerLine
2	NetAmountDocumentTotal

RateType

1

PercentageOfNetAmount

RoundingType

2	RoundUp
3	Downwards
1	Normal

ScaleMethod

1

WholeAmount

TaxType

1	InputTax
2	OutputTax