Connector API
Search…
Taxations

Get all taxations

Returns all taxations supported in tax environments.

Request

[PlatformAddress]/api/connector/v1/taxations/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0"
5
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.

Response

1
{
2
"Taxations": [
3
{
4
"Code": "AT-2020",
5
"Name": "VAT",
6
"LocalName": "MWST"
7
},
8
{
9
"Code": "AT-2020-Extra",
10
"Name": "Extra tax on top of VAT",
11
"LocalName": "Extra tax on top of MWST"
12
},
13
{
14
"Code": "AT-2016",
15
"Name": "VAT",
16
"LocalName": "MWST"
17
},
18
{
19
"Code": "AT",
20
"Name": "VAT",
21
"LocalName": "MWST"
22
}
23
],
24
"TaxRates": [
25
{
26
"Code": "AT-2020-21%",
27
"TaxationCode": "AT",
28
"Strategy": {
29
"Discriminator": "Relative",
30
"Value": {
31
"Value": 0.21
32
}
33
}
34
},
35
{
36
"Code": "AT-2020-Extra-10%",
37
"TaxationCode": "AT-2020-Extra-10%",
38
"Strategy": {
39
"Discriminator": "Dependent",
40
"Value": {
41
"BaseTaxationCodes": [
42
"AT-2020"
43
],
44
"Value": 0.1
45
}
46
}
47
},
48
{
49
"Code": "AT-5-EUR",
50
"TaxationCode": "AT",
51
"Strategy": {
52
"Discriminator": "Flat",
53
"Value": {
54
"Value": 5.0,
55
"CurrencyCode": "EUR"
56
}
57
}
58
}
59
]
60
}
Copied!
Property
Type
Contract
Description
Taxations
array of Taxation
required
The supported taxations.
TaxRates
array of Tax rate
required
The supported tax rates.

Taxation

Taxation represents set of Tax rates within Tax environment.
Property
Type
Contract
Description
Code
string
required
Code of the taxation.
Name
string
required
Name of the taxation.
LocalName
string
required
Local name of the taxation.

Tax rate

Definition of single tax rate.
Property
Type
Contract
Description
Code
string
required
Code of the tax rate. To be used when posting revenue items which should be accompanied by the tax rate(s) applicable to the nature of the item and the tax environment.
TaxationCode
string
required
Code of the Taxation the rate is part of.
Strategy
required
Tax strategy type, e.g. relative, flat or dependent.

Tax rate strategy

Property
Type
Contract
Description
Discriminator
required
If tax rate is flat, relative or dependent.
Value
object
required
Structure of the object depends on Tax rate strategy discriminator.

Tax rate strategy discriminator

Tax rate strategy data

Flat tax rate strategy data

Property
Type
Contract
Description
Value
number
required
Absolute value of tax.
CurrencyCode
string
required
Code of Currency.

Relative tax rate strategy data

Property
Type
Contract
Description
Value
decimal
required
Tax rate, e.g. 0.21 in case of 21% tax rate.

Dependent tax rate strategy data

Property
Type
Contract
Description
BaseTaxationCodes
array of string
required
Codes of the taxations that are included in the base of calculation.
Value
decimal
required
Tax rate, e.g. 0.1 in case of 10% tax rate.