Skip to content

Get all tax environments

POST
/api/connector/v1/taxEnvironments/getAll

Returns all tax environments supported by the API.

Parameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0"
}

OK

TaxEnvironmentResult
object
TaxEnvironments

The supported tax environments.

Array<object>
nullable
Tax environment
object
Code

Code of the tax environment.

string
nullable
CountryCode

ISO 3166-1 alpha-3 code of associated country, e.g. USA or GBR.

string
nullable
ValidityStartUtc

If specified, marks the start of the validity interval in UTC timezone in ISO 8601 format.

string
nullable
ValidityEndUtc

If specified, marks the end of the validity interval in UTC timezone in ISO 8601 format.

string
nullable
TaxationCodes

Codes of the Taxations that are used by this environment.

Array<string>
nullable
Taxations
Array<object>
nullable
OldTaxation
object
Code
string
nullable
TaxEnvironmentCode
string
nullable
Name
string
nullable
LocalName
string
nullable
TaxRates
Array<object>
nullable
Tax rate
object
Code

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.

string
nullable
TaxationCode

Code of the Taxation the rate is part of.

string
nullable
Value
number format: double
ValidityInvervalsUtc
Array<object>
nullable
DateTimeIntervalUtc
object
StartUtc
string
nullable
EndUtc
string
nullable
Strategy
Strategy

Tax strategy type, e.g. relative, flat or dependent.

object
Discriminator
string
Allowed values: Relative Flat Dependent
Value
One of:
RelativeTaxRateStrategy
object
Value
number format: double
Example
{
"TaxEnvironments": [
{
"Code": "AT-2020",
"CountryCode": "AUT",
"TaxationCodes": [
"AT-2020",
"AT-2020-Extra"
],
"ValidityStartUtc": "2020-06-30T22:00:00Z",
"ValidityEndUtc": null
},
{
"Code": "AT-2016",
"CountryCode": "AUT",
"TaxationCodes": [
"AT-2016"
],
"ValidityStartUtc": "2016-05-01T00:00:00Z",
"ValidityEndUtc": "2020-06-30T22:00:00Z"
},
{
"Code": "AT",
"CountryCode": "AUT",
"TaxationCodes": [
"AT"
],
"ValidityStartUtc": null,
"ValidityEndUtc": "2016-05-01T00:00:00Z"
}
]
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable