Jasmin Developers - Web API Reference

Taxes | Tax Type Code

Service to manage entities of type 'TaxTypeCode'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

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

Response status codes:

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

Resource URL:

GET /taxesCore/taxTypeCodes/odata

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:

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:

GET /taxesCore/taxTypeCodes/{taxCodeKey}

GET Get Tax Type Info

Custom operation 'GetTaxTypeInfo'.

Response:

When successful, the response body contains a list of resources of type 'TaxTypeInfoResource'. See TaxTypeInfoResource.

Response status codes:

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

Resource URL:

GET /taxesCore/taxTypeCodes/getTaxTypeInfo

GET Get Tax Type Code Info

Custom operation 'GetTaxTypeCodeInfo'.

The following elements are required:

partyTaxSchemaKey (string) PartyTaxSchemaKey.
itemTaxSchemaKey (string) ItemTaxSchemaKey.

Response:

When successful, the response body contains a list of resources of type 'TaxTypeCodeInfo'. See TaxTypeCodeInfo.

Response status codes:

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

Resource URL:

GET /taxesCore/taxTypeCodes/getTaxTypeCodeInfo/{partyTaxSchemaKey}/{itemTaxSchemaKey}

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.

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:

POST /taxesCore/taxTypeCodes

POST Tax Code Rate

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

The following elements are required:

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

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

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:

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:

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:

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:

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:

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:

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:

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:

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:

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isActive

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:

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:

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/isExternallyManaged

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:

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:

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/rateType

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:

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:

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:

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:

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:

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:

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:

PUT /taxesCore/taxTypeCodes/{taxCodeKey}/taxSubClass

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:

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:

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:

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

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:

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:

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:

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) Is Externally Managed.

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.


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.
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) Is Externally Managed.
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.

The following elements are optional:

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


TaxTypeCodeInfo

The following elements are optional:

taxTypeCode (string) Tax Type Code.
taxTypeCodeId (Guid) Tax Type Code Id.
taxTypeCodeDescription (string) Tax Type Code Description.
isExempt (bool) Is Exempt.
exemptionReasonCode (string) Exemption Reason Code.
exemptionReasonCodeId (Guid) Exemption Reason Code Id.
exemptionReasonCodeDescription (string) Exemption Reason Code Description.


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) Is Externally Managed.

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.


TaxTypeInfoResource

The following elements are optional:

taxTypeCode (string) Tax Type Code.
taxTypePercentage (decimal) Tax Type Percentage.
taxTypeDeductible (decimal) Tax Type Deductible.
taxFree (bool) Tax Free.
defaultTaxFree (bool) Default Tax Free.


Enumerations


BaseValue

1 NetAmountPerLine
2 NetAmountDocumentTotal


RateType

1 PercentageOfNetAmount


RoundingType

2 RoundUp
3 Downwards
1 Normal


ScaleMethod

1 WholeAmount