Taxes
Was this helpful?
Was this helpful?
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Location's country code, defined when the tax configuration is created.
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7GET /tax/{tenant}/taxes/{locationCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"location": {
"countryCode": "DE"
},
"taxClasses": [
{
"code": "STANDARD",
"name": {
"en": "Standard"
},
"order": 0,
"rate": 19,
"isDefault": true
},
{
"code": "REDUCED",
"name": {
"en": "Reduced"
},
"order": 1,
"rate": 7
},
{
"code": "ZERO",
"name": {
"en": "Zero"
},
"order": 2,
"rate": 0
}
],
"metadata": {
"version": 2,
"createdAt": "2022-03-31T09:52:15.423Z",
"modifiedAt": "2022-03-31T09:53:25.464Z"
}
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Location's country code, defined when the tax configuration is created.
DELETE /tax/{tenant}/taxes/{locationCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.
1Number of items to be retrieved per page.
60List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName:asc{fieldName}:descNote: If you want to sort the results by localized properties, the possible values are:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
Possible {fieldName} values are:
namedescriptioncountryCodetaxClassCoderatename,taxClassCode:descTax class names. When specified, only tax configurations containing the specified tax class names will be returned.
Important: See how the Accept-Language header influences this parameter:
If The Accept-Language header is set to *, you need to specify a language in this parameter.
For example, if the Accept-Language header is set to * and you want to find English names containing the word "Reduced", this parameter should be set to "name.en=Reduced"
If the Accept-Language header is set to a particular language or not specified, you do not need to specify a language in this parameter.
For example, if the Accept-Language header is set to en and you want to find names containing the word "Reduced", this parameter should be set to "name=Reduced"
Note: When filtering the results with this field, the contains operator is used. The operator is case-sensitive.
Tax class rates, expressed as numbers. When specified, only tax configurations containing the specified tax class rates will be returned.
Note: When filtering the results with this field, the equals operator is used.
Three-letter country codes, as defined in the Country Service. When specified, only tax configurations defined for the specified countries will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-sensitive.
Tax class codes. When specified, only tax configurations containing the specified tax class codes will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-sensitive.
Tax class descriptions. When specified, only tax configurations containing the specified tax class descriptions will be returned.
Important: See how the Accept-Language header influences this parameter:
If The Accept-Language header is set to *, you need to specify a language in this parameter.
For example, if the Accept-Language header is set to * and you want to find English descriptions containing the word "Fruit", this parameter should be set to "description.en=Fruit"
If the Accept-Language header is set to a particular language or not specified, you do not need to specify a language in this parameter.
For example, if the Accept-Language header is set to en and you want to find descriptions containing the word "Fruit", this parameter should be set to "description=Fruit"
Note: When filtering the results with this field, the contains operator is used. The operator is case-sensitive.
List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7Flag indicating whether the total number of retrieved items should be returned.
falseGET /tax/{tenant}/taxes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"location": {
"countryCode": "DE"
},
"taxClasses": [
{
"code": "STANDARD",
"name": {
"en": "Standard"
},
"order": 0,
"rate": 19,
"isDefault": true
},
{
"code": "REDUCED",
"name": {
"en": "Reduced"
},
"order": 1,
"rate": 7
},
{
"code": "ZERO",
"name": {
"en": "Zero"
},
"order": 2,
"rate": 0
}
],
"metadata": {
"version": 1,
"createdAt": "2022-03-31T09:52:15.423Z",
"modifiedAt": "2022-03-31T09:53:25.464Z"
}
},
{
"location": {
"countryCode": "PL"
},
"taxClasses": [
{
"code": "STANDARD",
"name": {
"en": "Standard"
},
"order": 0,
"rate": 23
},
{
"code": "REDUCED_8",
"name": {
"en": "Reduced"
},
"order": 1,
"rate": 8,
"isDefault": true
},
{
"code": "REDUCED_5",
"name": {
"en": "Reduced (Food)"
},
"order": 2,
"rate": 5
},
{
"code": "ZERO",
"name": {
"en": "Zero"
},
"order": 3,
"rate": 0
}
],
"metadata": {
"version": 2,
"createdAt": "2022-03-31T09:52:15.423Z",
"modifiedAt": "2022-03-31T09:53:25.464Z"
}
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Language in which localized fields in the request body are provided.
Content-Language header is set to *, the localized fields should be provided as maps of translations, where the keys are language codes and values are the fields in their respective languages.Content-Language header is set to a specific language, the localized fields should be provided as strings.Content-Language header is empty, the endpoint will asume that the localized fields are provided in the default language defined in the Configuration Service.Note: You can provide the localized fields only in languages defined in the Configuration Service. In case the fields are provided in languages that are not defined in the Configuration Service, the request will be rejected.
Tax configuration for a specified location. It consists of a country code and a list of tax classes applicable in that country.
POST /tax/{tenant}/taxes HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: text
Content-Type: application/json
Accept: */*
Content-Length: 248
{
"location": {
"countryCode": "DE"
},
"taxClasses": [
{
"code": "STANDARD",
"name": {
"en": "Standard"
},
"order": 0,
"rate": 19,
"isDefault": true
},
{
"code": "REDUCED",
"name": {
"en": "Reduced"
},
"order": 1,
"rate": 7
},
{
"code": "ZERO",
"name": {
"en": "Zero"
},
"order": 2,
"rate": 0
}
]
}{
"locationCode": "text"
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Location's country code, defined when the tax configuration is created.
Language in which localized fields in the request body are provided.
Content-Language header is set to *, the localized fields should be provided as maps of translations, where the keys are language codes and values are the fields in their respective languages.Content-Language header is set to a specific language, the localized fields should be provided as strings.Content-Language header is empty, the endpoint will asume that the localized fields are provided in the default language defined in the Configuration Service.Note: You can provide the localized fields only in languages defined in the Configuration Service. In case the fields are provided in languages that are not defined in the Configuration Service, the request will be rejected.
PUT /tax/{tenant}/taxes/{locationCode} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Language: text
Content-Type: application/json
Accept: */*
Content-Length: 273
{
"location": {
"countryCode": "DE"
},
"taxClasses": [
{
"code": "STANDARD",
"name": {
"en": "Standard"
},
"order": 0,
"rate": 19,
"isDefault": true
},
{
"code": "REDUCED",
"name": {
"en": "Reduced"
},
"order": 1,
"rate": 7
},
{
"code": "ZERO",
"name": {
"en": "Zero"
},
"order": 2,
"rate": 0
}
],
"metadata": {
"version": 1
}
}No content