vat-register

Server

Download schema

Retrieves all vat registers

GET

https://api.entur.io/products

/vat-register

Retrieves all vat registers › Headers

ET-Client-Name

string

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves all vat registers › Responses

Returns the resource.

VatRegister[]

A case class for vat register.

VatRegister

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

countryCode

string

Country for which the VAT is valid, based on ISO 3166-1 alfa-3

Example: NOR

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

arrivalCountryCode

string

Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

departureCountryCode

string

Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

Retrieves vat register for group

GET

https://api.entur.io/products

/vat-register/{vatGroup}

Retrieves vat register for group › path Parameters

vatGroup

string · required · style: simple

The identifier for a VAT

Retrieves vat register for group › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves vat register for group › Responses

Returns the resource.

VatRegister[]

A case class for vat register.

VatRegister

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

countryCode

string

Country for which the VAT is valid, based on ISO 3166-1 alfa-3

Example: NOR

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

arrivalCountryCode

string

Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

departureCountryCode

string

Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

round-trips fare-products

Products

vat-register

Server

Download schema

Retrieves all vat registers

GET

https://api.entur.io/products

/vat-register

Retrieves all vat registers › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves all vat registers › Responses

Returns the resource.

VatRegister[]

A case class for vat register.

VatRegister

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

countryCode

string

Country for which the VAT is valid, based on ISO 3166-1 alfa-3

Example: NOR

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

arrivalCountryCode

string

Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

departureCountryCode

string

Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

Retrieves vat register for group

GET

https://api.entur.io/products

/vat-register/{vatGroup}

Retrieves vat register for group › path Parameters

vatGroup

string · required · style: simple

The identifier for a VAT

Retrieves vat register for group › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

If-None-Match

string · style: simple

Used to make conditional requests. It allows the client to provide an ETag value, and the server will process the request only if the ETag does not match the current version of the resource.

Retrieves vat register for group › Responses

Returns the resource.

VatRegister[]

A case class for vat register.

VatRegister

id

string · minLength: 1 · required

Id.

Example: ENT:VatRegister:SomeId

vatRate

string · minLength: 1 · required

The percentage rate for the VAT

Example: 12.0

vatGroup

string · enum · required

VAT group

Enum values:

EXCEPTION_FROM_VAT

GENERAL_VAT

FOOD_VAT

TRANSPORT_AND_TICKETS_VAT

Example: TRANSPORT_AND_TICKETS_VAT

validFrom

string · minLength: 1 · required

The time and date from which the VAT is valid

description

string · minLength: 1 · required

The VAT description

Example: Person transport and tickets in Norway

validTo

string

The time and date to which the VAT is valid

vatCode

string

Code for the VAT, used for accounting

Example: 33

countryCode

string

Country for which the VAT is valid, based on ISO 3166-1 alfa-3

Example: NOR

organisationId

integer · int64

OrganisationId for the organisation who uses this VAT-specification.

arrivalCountryCode

string

Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

departureCountryCode

string

Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3

Example: NOR

round-trips fare-products

vat-register

Retrieves all vat registers

Retrieves all vat registers › Headers

Retrieves all vat registers › Responses

Retrieves vat register for group

Retrieves vat register for group › path Parameters

Retrieves vat register for group › Headers

Retrieves vat register for group › Responses

Build with Entur

Contribute

Terms & Policies

vat-register

Retrieves all vat registers

Retrieves all vat registers › Headers

Retrieves all vat registers › Responses

Retrieves vat register for group

Retrieves vat register for group › path Parameters

Retrieves vat register for group › Headers

Retrieves vat register for group › Responses