swagger: '2.0'
info:
  description: Bolagsverkets API för att hämta årsredovisningsstatistik
  version: '1.0'
  title: API för att hämta årsredovisningsstatistik
  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 om digitala årsredovisningar
  url: 'http://diar.bolagsverket.se'

host: api.bolagsverket.se
basePath: /hamta-arsredovisningsstatistik/v1.0
schemes:
  - https
tags:
  - name: statistik
    description: Tjänster för att hämta årsredovisningsstatistik
  - name: stodtjanster
    description: Stödtjänster för årsredovisningsstatistik
paths:
  '/statistik/allman/ankomstdatum':
    post:
      tags:
        - statistik
      summary: Hämtar allmän statistik för årsredovisningar utifrån ankomstdatum.
      description: >-
        Tjänsten levererar allmän statistik för årsredovisningar gällande aktiebolag, som har lämnats in på papper eller digitalt till Bolagsverket.
      operationId: statistikallmanankomstdatum
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - name: anropsobjekt
          description: Start- och stoppdatum för önskat sökintervall.
          in: body
          required: true
          schema:
            $ref: '#/definitions/StatistikAnrop'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StatistikResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/allman/registreringsdatum':
    post:
      tags:
        - statistik
      summary: Hämtar allmän statistik för årsredovisningar utifrån registreringsdatum.
      description: >-
        Tjänsten levererar allmän statistik för årsredovisningar gällande aktiebolag, som har lämnats in på papper eller digitalt
        till Bolagsverket och har ett registreringsdatum.
      operationId: statistikallmanregistreringsdatum
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - name: anropsobjekt
          description: Start- och stoppdatum för önskat sökintervall.
          in: body
          required: true
          schema:
            $ref: '#/definitions/StatistikAnrop'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StatistikResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara':
    post:
      tags:
        - statistik
      summary: Hämtar uppgifter om digitalt inlämnade årsredovisningar per programvara.
      description: >-
        Tjänsten levererar uppgifter om digitalt inlämnade årsredovisningar för aktiebolag per programvara.
        Om ingen specifik programvara anges, returneras uppgifter för alla programvaror som hör till den programvaruleverantör som ställt frågan.
      operationId: statistikprogramvara
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - name: anropsobjekt
          description: >-
            Start- och stoppdatum för önskat sökintervall.
            Om programvara inte anges hämtas statistik för leverantörens samtliga programvaror.
          in: body
          required: true
          schema:
            $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProgramvaraResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara/separatrevisionsberattelse':
    post:
      tags:
        - statistik
      summary: Hämta uppgifter om digitalt inlämnade årsredovisningar med separat revisionsberättelse per programvara.
      description: >-
        Tjänsten levererar uppgifter om digitalt inlämnade årsredovisningar med separat revisionsberättelse för aktiebolag per programvara.
        Om ingen specifik programvara anges, returneras uppgifter för alla programvaror som hör till den programvaruleverantör som ställt frågan.
      operationId: statistikseparatrevisionsberattelse
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - name: anropsobjekt
          description: >-
            Start- och stoppdatum för önskat sökintervall.
            Om programvara inte anges hämtas statistik för leverantörens samtliga programvaror.
          in: body
          required: true
          schema:
            $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ProgramvaraRevberResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/statistik/programvara/kontroller':
    post:
      tags:
        - statistik
      summary: Hämtar utfall per kontrollnummer och programvara.
      description: >-
        Tjänsten levererar utfall för vilka kontrollnummer som fallit ut vid inlämning av digitala årsredovisningar för aktiebolag per programvara.
        Om ingen specifik programvara anges, returneras uppgifter för alla programvaror som hör till den programvaruleverantör som ställt frågan.
      operationId: statistikkontroller
      consumes:
        - "application/json"
      produces:
        - "application/json"
      parameters:
        - name: anropsobjekt
          description: >-
            Start- och stoppdatum för önskat sökintervall.
            Om programvara inte anges hämtas statistik för leverantörens samtliga programvaror.
          in: body
          required: true
          schema:
            $ref: '#/definitions/StatistikAnropProgramvara'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/KontrollerResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
  '/stodtjanster/programvaror':
    get:
      tags:
        - stodtjanster
      summary: Hämtar vilka programvaror programvaruleverantören har.
      description: Tjänsten returnerar vilka programvaror som den anropande programvaruleverantören har.
      operationId: stodtjansterprogramvaror
      consumes:
        - "application/json"
      produces:
        - "application/json"
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/StodtjansterProgramvarorResponse'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel'
        '500':
          description: Ospecificerat tekniskt fel
          schema:
            $ref: '#/definitions/Fel'
        '503':
          description: Tjänsten temporärt otillgänglig
          schema:
            $ref: '#/definitions/Fel'
        '504':
          description: Timeout
          schema:
            $ref: '#/definitions/Fel'
definitions:
  StatistikAnrop:
    type: object
    description: Anropsobjekt för att hämta statistik för årsredovisningar.
    properties:
      startDatum:
        type: string
        format: date
        description: Startdatum för sökintervall.
      stoppDatum:
        type: string
        format: date
        description: Stoppdatum för sökintervall.
    example:
        startDatum: 2024-01-01
        stoppDatum: 2024-02-01
    required: ["startDatum", "stoppDatum"]
  StatistikResponse:
    type: object
    description: Statistikdata
    properties:
      indata:
        $ref: '#/definitions/StatistikAnrop'
      statistik:
        type: array
        items:
          $ref: '#/definitions/StatistikObjekt'
  StatistikObjekt:
    type: object
    description: StatistikObjekt.
    properties:
      datum:
        type: string
        format: date
        description: Datum.
      digitala:
        type: integer
        format: int32
        description: Antal årsredovisningar inlämnade i digitalt format.
      papper:
        type: integer
        format: int32
        description: Antal årsredovisningar inlämnade i pappersformat.
      totalt:
        type: integer
        format: int32
        description: Antal årsredovisningar inlämnade totalt.
      automatavslut:
        type: integer
        format: int32
        description: Antal årsredovisningar som inlämnats digitalt och avslutats automatiskt.
      revisionsberattelse:
        type: integer
        format: int32
        description: Antal årsredovisningar som inlämnats digitalt och har en revisionsberättelse.
      separatrevisionsberattelse:
        type: integer
        format: int32
        description: Antal årsredovisningar som inlämnats digitalt och har en separat revisionsberättelse.
    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: Anropsobjekt för att hämta statistik för årsredovisningar per programvara
    properties:
      startDatum:
        type: string
        format: date
        description: Startdatum för sökintervall.
      stoppDatum:
        type: string
        format: date
        description: Stoppdatum för sökintervall.
      programvara:
        type: string
        description: Vilken programvara statistik ska hämtas för.
    example:
        startDatum: 2024-01-01
        stoppDatum: 2024-02-01
        programvara: "Leverantörens programvara"
    required: ["startDatum", "stoppDatum"]
  ProgramvaraResponse:
    type: object
    description: Statistikdata per programvara.
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/ProgramvaraObjekt'
  ProgramvaraObjekt:
    type: object
    description: Programvaraobjekt.
    properties:
      programvara:
        type: string
        description: Vilken programvara gäller för raden.
      datum:
        type: string
        format: date
        description: Datum.
      version:
        type: string
        description: Vilken version av programvaran gäller för raden.
      regelverk:
        type: string
        description: Vilket regelverk gäller för raden.
      uppstallningsform:
        type: string
        description: Vilken uppställningsform gäller för raden.
      totalt:
        type: integer
        format: int32
        description: Antal årsredovisningar inlämnade i digitalt format.
      automatavslut:
        type: integer
        format: int32
        description: Antal årsredovisningar som inlämnats digitalt och avslutats automatiskt.
      forelaggande:
        type: integer
        format: int32
        description: Antal årsredovisningar som inlämnats digitalt och genererat föreläggande.
    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: Statistikdata per programvara
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/ProgramvaraRevberObjekt'
  ProgramvaraRevberObjekt:
    type: object
    description: ProgramvaraRevberObjekt.
    properties:
      programvara:
        type: string
        description: Vilken programvara gäller för raden.
      datum:
        type: string
        format: date
        description: Datum.
      version:
        type: string
        description: Vilken version av programvaran gäller för raden.
      totalt:
        type: integer
        format: int32
        description: Antal årsredovisningar inlämnade med separat revisionsberättelse.
    example:
      programvara: "Leverantörens programvara"
      datum: 2024-01-01
      version: "1.2"
      totalt: 1234
    required: ["programvara", "datum", "version", "totalt"]

  KontrollerResponse:
    type: object
    description: Statistikdata per programvara.
    properties:
      indata:
        $ref: '#/definitions/StatistikAnropProgramvara'
      statistik:
        type: array
        items:
          $ref: '#/definitions/KontrollerObjekt'
  KontrollerObjekt:
    type: object
    description: KontrollerObjekt.
    properties:
      programvara:
        type: string
        description: Vilken programvara gäller för raden.
      version:
        type: string
        description: Vilken version av programvaran gäller för raden.
      regelverk:
        type: string
        description: Vilket regelverk gäller för raden.
      uppstallningsform:
        type: string
        description: Vilken uppställningsform gäller för raden.
      felkod:
        type: string
        description: Vilken felkod gäller för raden.
      feltext:
        type: string
        description: Textbeskrivning för felkoden för aktuell rad.
      totalt:
        type: integer
        format: int32
        description: Antal årsredovisningar där aktuell kontroll fallit ut.
    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: Svarsobjekt för programvarufrågor.
    properties:
      programvaror:
        type: array
        items:
          type: string
        example: ["Programvara 1", "Programvara 2"]
  Upplysning:
    type: object
    description: Innehåller mer detaljerad information om ett fel el dyl.
    properties:
      kod:
        type: integer
        format: int32
        description: Kod som beskriver upplysningen. Beskrivs i separat dokument.
      text:
        type: string
        description: Förklarande text till upplysningen.
      typ:
        type: string
        description: Upplysningens karaktär - information, varning eller fel.
        enum:
          - info
          - warn
          - error
    required: ["kod", "text", "typ"]
  Fel:
    type: object
    description: Beskriver fel.
    properties:
      kod:
        type: integer
        format: int32
        description: Kod som beskriver felet. Beskrivs i separat dokument.
      text:
        type: string
        description: Förklarande text till felet.
      detaljinformation:
        type: array
        description: Detaljupplysningar om felet
        items:
          $ref: '#/definitions/Upplysning'
    required: ["kod", "text"]