swagger: '2.0'
info:
  description: Bolagsverkets API för inlämning av digitala årsredovisningar
  version: '1.0'
  title: API för inlämning av digitala årsredovisningar
  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'
host: api.bolagsverket.se
basePath: /lamna-in-arsredovisning/v1.0
schemes:
  - https
tags:
  - name: inlamning
    description: Tjänster som tar emot årsredovisning för underskrift
paths:
  '/skapa-inlamningtoken':
    post:
      tags:
        - inlamning
      summary: Skapa token för inlämning
      description: >-
        Tjänsten skapar token för användning vid inlämning av handling.
      operationId: skapa-inlamningtoken
      consumes:
        - application/json;charset=utf-8
      produces:
        - application/json;charset=utf-8
      parameters:
        - name: anropsobjekt
          description: Personnummer och organisationsnummer
          in: body
          required: true
          schema:
            $ref: '#/definitions/SkapaInlamningTokenAnrop'
      responses:
        '200':
          description: Uppgifter mottagna
          schema:
            $ref: '#/definitions/SkapaTokenOK'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel' 
        '404':
          description: Personnummer saknas
          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'
  '/inlamning/{token}':
    post:
      tags:
        - inlamning
      summary: Lämna in årsredovisning för granskning och underskrift
      description: >-
        Tjänsten tar emot en digital årsredovisning och kontrollerar att den har
        rätt format
      operationId: inlamning
      consumes:
        - "application/json;charset=utf-8"
      produces:
        - "application/json;charset=utf-8"
      parameters:
        - name: token
          in: path
          description: Token för inlämning
          required: true
          type: string
          format: uuid
        - name: anropsobjekt
          description: Andra uppgifter och själva årsredovisningen
          in: body
          required: true
          schema:
            $ref: '#/definitions/InlamningAnrop'

      responses:
        '200':
          description: Årsredovisning mottagen
          schema:
            $ref: '#/definitions/InlamningOK'
        '400':
          description: Felaktig request
          schema:
            $ref: '#/definitions/Fel'
        '403':
          description: Obehörig användare av tjänsten
          schema:
            $ref: '#/definitions/Fel' 
        '404':
          description: Organisationsnummer saknas
          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'
parameters:
  orgnrPathParam:
    name: orgnr
    in: path
    required: true
    type: string
    pattern: '[0-9]{10}'
    description: 'Organisationsnummer för aktiebolaget. Tio siffror, inget bindestreck'

definitions:
  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"]
  SkapaTokenOK:
    type: object
    properties:
      token:
        type: string
        format: uuid
        description: Token för inlämning
      avtalstext:
        type: string
        description: Text att visa för slutanvändaren.
      avtalstextAndrad:
        type: string
        format: date
        description: Datum då avtalstexten senast ändrades.
    required: ["token"]
  InlamningOK:
    type: object
    properties:
      orgnr:
        type: string
        pattern: '[0-9]{10}'
        description: 'Organisationsnummer för aktiebolaget. Tio siffror, inget bindestreck'
      avsandare:
        description: Personnummer för avsändare inkl sekel
        type: string
        pattern: '(19|20)[0-9]{10}'
      undertecknare:
        description: Personnummer för undertecknare inkl sekel
        type: string
        pattern: '(19|20)[0-9]{10}'
      dokumentlangd:
        type: integer
        format: int32
        description: Det inskickade dokumentets längd i bytes
      idnummer:
        type: string
        description: >-
          Identifieringsnummer för dokumentet i avsändarens eget utrymme.
          Numret ska inte visas för användare men kan användas till teknisk felsökning.
      sha256checksumma:
        type: string
        format: byte
        description: SHA-256-checksumma på det inskickade dokumentet
    required: ["orgnr", "avsandare", "undertecknare", "dokumentlangd", "idnummer", "sha256checksumma"]
  SkapaInlamningTokenAnrop:
    type: object
    description: Anropsobjekt för personnummer och organisationsnummer
    properties:
      pnr:
        description: Personnummer inkl sekel på person som handlingen ska lagras på.
        type: string
        pattern: '(19|20)[0-9]{10}'
      orgnr:
        type: string
        pattern: '[0-9]{10}'
        description: 'Organisationsnummer för aktiebolaget. Tio siffror, inget bindestreck'
    required: ["pnr", "orgnr"]
  InlamningAnrop:
    type: object
    description: Anropsobjekt för inlämning av årsredovisning
    properties:
      undertecknare:
        description: Personnummer för undertecknare inkl sekel
        type: string
        pattern: '(19|20)[0-9]{10}'
      mobiltbankid:
        type: boolean
        description: Flagga som styr om signering ska startas direkt med mobilt bankid. Default är false
      epostadresser:
        description: >-
            E-postadresser till de personer som ska meddelas att det finns en
            årsredovisning att underteckna. 
        type: array
        items:
          type: string
          minLength: 6
          maxLength: 250
      arsredovisningsfil:
        type: string
        format: byte
        description: Årsredovisning i iXBRL-format. Filen ska ha charset UTF-8.
    required: ["undertecknare", "epostadresser","arsredovisningsfil"]

externalDocs:
  description: Information om digitala årsredovisningar
  url: 'http://diar.bolagsverket.se'