Entur Vat Register API

openapi: 3.2.0
info:
  title: Entur Vat Register API
  version: 2026.10.0
  description: 'Operations tagged vat-register across 2 of this provider''s published API definitions: entur-products-openapi.json, entur-products-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.entur.io/products
  description: Production environment
- url: https://api.staging.entur.io/products
  description: Staging environment
- url: https://api.dev.entur.io/products
  description: Development environment
security:
- jwt: []
tags:
- name: vat-register
paths:
  /vat-register:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - vat-register
      summary: Retrieves all vat registers
      operationId: vat-register_getAllVatRegisters
      parameters:
      - name: If-None-Match
        in: header
        description: 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.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the resource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VatRegister'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
  /vat-register/{vatGroup}:
    parameters:
    - $ref: '#/components/parameters/ET-Client-Name'
    - $ref: '#/components/parameters/X-Correlation-Id'
    get:
      tags:
      - vat-register
      summary: Retrieves vat register for group
      operationId: vat-register_getVatRegisters
      parameters:
      - name: vatGroup
        in: path
        description: The identifier for a VAT
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: If-None-Match
        in: header
        description: 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.
        required: false
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Returns the resource.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VatRegister'
        '304':
          description: Not Modified
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                type: string
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                type: string
        '404':
          description: Resource not found.
          content:
            application/problem+json:
              schema:
                type: string
        '500':
          description: Internal server error.
          content:
            application/problem+json:
              schema:
                type: string
      security:
      - basic_auth: []
      x-entur-permissions:
        value: product-api-access:les
    servers:
    - url: https://api.entur.io/products
      description: Production environment
    - url: https://api.staging.entur.io/products
      description: Staging environment
    - url: https://api.dev.entur.io/products
      description: Development environment
components:
  parameters:
    X-Correlation-Id:
      name: X-Correlation-Id
      in: header
      description: Correlation id
      required: false
      style: simple
      explode: false
      schema:
        type: string
    ET-Client-Name:
      name: ET-Client-Name
      in: header
      description: '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>`.'
      required: false
      style: simple
      explode: false
      schema:
        type: string
  schemas:
    VatRegister:
      required:
      - description
      - id
      - validFrom
      - vatGroup
      - vatRate
      type: object
      properties:
        arrivalCountryCode:
          type: string
          description: Specification of the country where the arrival should be for the VAT to be valid, based on ISO 3166-1 alfa-3
          examples:
          - NOR
        countryCode:
          type: string
          description: Country for which the VAT is valid, based on ISO 3166-1 alfa-3
          examples:
          - NOR
        departureCountryCode:
          type: string
          description: Specification of the country where the departure should be for the VAT to be valid, based on ISO 3166-1 alfa-3
          examples:
          - NOR
        description:
          minLength: 1
          type: string
          description: The VAT description
          examples:
          - Person transport and tickets in Norway
        id:
          minLength: 1
          type: string
          description: Id.
          examples:
          - ENT:VatRegister:SomeId
        organisationId:
          type: integer
          description: OrganisationId for the organisation who uses this VAT-specification.
          format: int64
        validFrom:
          minLength: 1
          type: string
          description: The time and date from which the VAT is valid
        validTo:
          type: string
          description: The time and date to which the VAT is valid
        vatCode:
          type: string
          description: Code for the VAT, used for accounting
          examples:
          - '33'
        vatGroup:
          type: string
          description: VAT group
          enum:
          - EXCEPTION_FROM_VAT
          - GENERAL_VAT
          - FOOD_VAT
          - TRANSPORT_AND_TICKETS_VAT
          examples:
          - TRANSPORT_AND_TICKETS_VAT
        vatRate:
          minLength: 1
          type: string
          description: The percentage rate for the VAT
          examples:
          - '12.0'
      description: A case class for vat register.
  securitySchemes:
    jwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- entur-products-openapi.json
- entur-products-openapi.yml