swagger: '2.0'
info:
  description: Bolagsverket's API for retrieving annual report statistics
  version: '1.0'
  title: API to retrieve annual report statistics
  termsOfService: 'http://diar.bolagsverket.se/api/terms/'
  contact:
    name: Bolagsverkets grupp för digitala årsredovisningar
    email: emsdiar@bolagsverket.se
  license:
    name: Offentlig handling enligt Tryckfrihetsförordningen 2 Kap 3 §
    url: 'http://www.notisum.se/rnp/sls/lag/19490105.htm#K2P3'
externalDocs:
  description: Information aboud electronic annual reports
  url: 'http://diar.bolagsverket.se'
host: api.bolagsverket.se
basePath: /hamta-arsredovisningsstatistik/v1.0
schemes:
- https
tags:
- name: statistik
  description: Services for retrieving annual report statistics
- name: stodtjanster
  description: Support services for annual report statistics
paths:
  '/statistik/allman/ankomstdatum':
    post:
      tags:
      - statistik
      summary: Retrieves general statistics for annual reports based on arrival date.
      description: >-
        The service delivers general statistics for annual reports regarding limited
        companies, which have been submitted on paper or digitally to the Swedish
        Companies Registration Office.
      operationId: statistikallmanankomstdatum
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: anropsobjekt
        description: Start and stop dates for the search interval.
        in: body
        required: true
        schema:
          $ref: '#/definitions/StatistikAnrop'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StatistikResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/allman/registreringsdatum':
    post:
      tags:
      - statistik
      summary: Retrieves general statistics for annual reports based on registration
        date.
      description: >-
        The service delivers general statistics for annual reports regarding limited
        companies, which have been submitted on paper or digitally to the Swedish
        Companies Registration Office and have a registration date.
      operationId: statistikallmanregistreringsdatum
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: anropsobjekt
        description: Start and stop dates for the search interval.
        in: body
        required: true
        schema:
          $ref: '#/definitions/StatistikAnrop'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StatistikResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara':
    post:
      tags:
      - statistik
      summary: Retrieves information about digitally submitted annual reports per
        software.
      description: >-
        The service delivers information about digitally submitted annual reports
        for limited companies per software. If no specific software is specified,
        information is returned for all software belonging to the software vendor
        that sent the query.
      operationId: statistikprogramvara
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: anropsobjekt
        description: >-
          Start and stop dates for the search interval. If software is not specified,
          statistics are retrieved for all of the supplier's software.
        in: body
        required: true
        schema:
          $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProgramvaraResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara/separatrevisionsberattelse':
    post:
      tags:
      - statistik
      summary: Retrieve data on digitally submitted annual reports with a separate
        audit report per software.
      description: >-
        The service delivers information on digitally submitted annual reports with
        a separate audit report for limited companies per software. If no specific
        software is specified, information is returned for all software belonging
        to the software vendor that sent the query.
      operationId: statistikseparatrevisionsberattelse
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: anropsobjekt
        description: >-
          Start and stop dates for the search interval. If software is not specified,
          statistics are retrieved for all of the supplier's software.
        in: body
        required: true
        schema:
          $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProgramvaraRevberResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara/kontroller':
    post:
      tags:
      - statistik
      summary: Retrieves results by control number and software.
      description: >-
        The service delivers results for which controls have negative results when
        submitting digital annual reports for limited companies per software. If no
        specific software is specified, information is returned for all software belonging
        to the software vendor that sent the query.
      operationId: statistikkontroller
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: anropsobjekt
        description: >-
          Start and stop dates for the search interval. If software is not specified,
          statistics are retrieved for all of the supplier's software.
        in: body
        required: true
        schema:
          $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/KontrollerResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/stodtjanster/programvaror':
    get:
      tags:
      - stodtjanster
      summary: Retrieves what software the software provider has.
      description: The service returns which softwares are linked to the calling software
        provider.
      operationId: stodtjansterprogramvaror
      consumes:
      - "application/json"
      produces:
      - "application/json"
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StodtjansterProgramvarorResponse'
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Unauthorized user of service
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Unspecified technical problem
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: The service is temporarily unavailable
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
definitions:
  StatistikAnrop:
    type: object
    description: Call object to retrieve statistics for annual reports.
    properties:
      startDatum:
        type: string
        format: date
        description: Search interval start date.
      stoppDatum:
        type: string
        format: date
        description: Stop date for search range.
    example:
      startDatum: 2024-01-01
      stoppDatum: 2024-02-01
    required: ["startDatum", "stoppDatum"]
  StatistikResponse:
    type: object
    description: Statistics data
    properties:
      indata:
        $ref: '#/definitions/StatistikAnrop'
      statistik:
        type: array
        items:
          $ref: '#/definitions/StatistikObjekt'
  StatistikObjekt:
    type: object
    description: RelevantStatistics.
    properties:
      datum:
        type: string
        format: date
        description: Date.
      digitala:
        type: integer
        format: int32
        description: Number of annual reports submitted in digital format.
      papper:
        type: integer
        format: int32
        description: Number of annual reports submitted in paper format.
      totalt:
        type: integer
        format: int32
        description: Number of annual reports submitted in total.
      automatavslut:
        type: integer
        format: int32
        description: Number of annual reports submitted digitally and completed automatically.
      revisionsberattelse:
        type: integer
        format: int32
        description: Number of annual reports that have been submitted digitally and
          have an audit report.
      separatrevisionsberattelse:
        type: integer
        format: int32
        description: Number of annual reports that were submitted digitally and have
          a separate audit report.
    example:
      datum: 2024-01-01
      digitala: 1234
      papper: 4321
      totalt: 5555
      automatavslut: 1201
      revisionsberattelse: 1102
      separatrevisionsberattelse: 356
    required: ["datum", "digitala", "papper", "totalt", "automatavslut", "revisionsberattelse"]
  StatistikAnropProgramvara:
    type: object
    description: Call object to retrieve statistics for annual reports per software
    properties:
      startDatum:
        type: string
        format: date
        description: Search interval start date.
      stoppDatum:
        type: string
        format: date
        description: Stop date for search range.
      programvara:
        type: string
        description: Which software statistics should be retrieved for.
    example:
      startDatum: 2024-01-01
      stoppDatum: 2024-02-01
      programvara: "Leverantörens programvara"
    required: ["startDatum", "stoppDatum"]
  ProgramvaraResponse:
    type: object
    description: Statistics data per programvara.
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/ProgramvaraObjekt'
  ProgramvaraObjekt:
    type: object
    description: RelevantStatistics.
    properties:
      programvara:
        type: string
        description: Which software applies to the line.
      datum:
        type: string
        format: date
        description: Date.
      version:
        type: string
        description: Which version of the software applies to the line.
      regelverk:
        type: string
        description: Which regulatory framework apply to the line.
      uppstallningsform:
        type: string
        description: Which report format applies to the line.
      totalt:
        type: integer
        format: int32
        description: Number of annual reports submitted in digital format.
      automatavslut:
        type: integer
        format: int32
        description: Number of annual reports submitted digitally and completed automatically.
      forelaggande:
        type: integer
        format: int32
        description: Number of annual reports submitted digitally and generated injunction.
    example:
      programvara: "Leverantörens programvara"
      datum: 2024-01-01
      version: "1.2"
      regelverk: "K2"
      uppstallningsform: "raiab"
      totalt: 1234
      automatavslut: 1201
      forelaggande: 25
    required: ["programvara", "datum", "version", "regelverk", "uppstallningsform",
      "totalt", "automatavslut", "forelaggande"]
  ProgramvaraRevberResponse:
    type: object
    description: Statistics per software
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/ProgramvaraRevberObjekt'
  ProgramvaraRevberObjekt:
    type: object
    description: RelevantStatistics.
    properties:
      programvara:
        type: string
        description: Which software applies to the line.
      datum:
        type: string
        format: date
        description: Date.
      version:
        type: string
        description: Which version of the software applies to the line.
      totalt:
        type: integer
        format: int32
        description: Number of annual reports submitted with a separate auditor's
          report.
    example:
      programvara: "Leverantörens programvara"
      datum: 2024-01-01
      version: "1.2"
      totalt: 1234
    required: ["programvara", "datum", "version", "totalt"]
  KontrollerResponse:
    type: object
    description: Statistics data per programvara.
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/KontrollerObjekt'
  KontrollerObjekt:
    type: object
    description: RelevantStatistics.
    properties:
      programvara:
        type: string
        description: Which software applies to the line.
      version:
        type: string
        description: Which version of the software applies to the line.
      regelverk:
        type: string
        description: Which regulatory framework apply to the line.
      uppstallningsform:
        type: string
        description: Which report format applies to the line.
      felkod:
        type: string
        description: Which error code applies to the line.
      feltext:
        type: string
        description: Text description of the error code.
      totalt:
        type: integer
        format: int32
        description: Number of annual reports where the current control failed.
    example:
      programvara: "Leverantörens programvara"
      version: "1.2"
      regelverk: "K2"
      uppstallningsform: "raiab"
      felkod: "1044"
      feltext: "Det finns redan en årsredovisning för det här räkenskapsåret som ä\
        r registrerad."
      totalt: 1234
    required: ["programvara", "version", "regelverk", "uppstallningsform", "felkod",
      "feltext", "totalt"]
  StodtjansterProgramvarorResponse:
    type: object
    description: Response object for software queries.
    properties:
      programvaror:
        type: array
        items:
          type: string
        example: ["Programvara 1", "Programvara 2"]
  Upplysning:
    type: object
    description: Contains further details on errors etc.
    properties:
      kod:
        type: integer
        format: int32
        description: Code that describes the kind of information. Described in a separate
          document.
      text:
        type: string
        description: Text that leaves further information.
      typ:
        type: string
        description: Classification of the information - info, warning or error.
        enum:
        - info
        - warn
        - error
    required: ["kod", "text", "typ"]
  Fel:
    type: object
    description: Provides detailed error information.
    properties:
      kod:
        type: integer
        format: int32
        description: Code that describes the error. Described in a separate document.
      text:
        type: string
        description: Text that leaves further information about the error.
      detaljinformation:
        type: array
        description: Detailed information about the error
        items:
          $ref: '#/definitions/Upplysning'
    required: ["kod", "text"]