# API-specifikationsmall för programvaruleverantörer att använda för att ta emot pushmeddelanden gällande # statusförändringar på elektroniskt inlämnade årsredovisningar. # # Val av faktisk host, basePath och path görs av programvaruleverantören. # swagger: '2.0' info: description: Bolagsverkets API för pushmeddelanden gällande statusförändringar på elektroniskt inlämnade årsredovisningar. version: '1.2' title: API för pushmeddelanden gällande årsredovisningar # Faktisk host bestäms av den externa parten. host: programvaruleverantor.example.com # Faktisk basePath bestäms av den externa parten. basePath: /api/v1.2 schemes: - http - https paths: # Faktisk path bestäms av den externa parten. '/pushmeddelande': post: summary: Ta emot årsredovisningshändelser från Bolagsverket. operationId: pushmeddelande consumes: - "application/json;charset=utf-8" parameters: - name: Auth in: header type: string required: false description: Innehåller den authKey som angavs in då preumerationen skapades. - name: pushmeddelande in: body required: true schema: $ref: '#/definitions/Pushmeddelande' responses: '200': description: OK '204': description: OK default: description: Alla andra HTTP-statusar (inklusive övriga 2xx och redirects) kommer räknas som fel. Bolagsverket kommer då försöka skicka samma meddelande igen. definitions: Pushmeddelande: type: object description: Pushmeddelande som skickas från Bolagsverket till de som prenumererar på händelser med typ och id. properties: typ: type: string maxLength: 20 description: Typ av händelse. Alltid AR för pushmeddelanden gällande årsredovisningar. id: type: string maxLength: 40 description: Händelsens identitet i form av organisationsnumret för aktiebolaget. nr: type: integer format: int64 description: Händelsens ordningsnummer. Luckor i denna sekvens betyder att det finns händelser som inte nått fram till den externa parten. Om testmeddelande skickas ut får dessa nummer -1 och kan ignoreras. tid: type: string format: date-time description: Tidpunkt då händelsen inträffade. data: $ref: '#/definitions/Arsredovisningshandelse' required: ["typ", "id", "nr", "tid", "data"] Arsredovisningshandelse: type: object description: Information om statusförändringar för elektroniskt inkomna årsredovisningar. properties: version: type: string maxLength: 10 pattern: '[0-9]+\.[0-9]+' description: Version för årsredovisningshändelsen. idnummer: type: string maxLength: 20 description: Unikt identifieringsnummer för dokumentet som lämnades in. idnummerRevisionsberattelse: type: string maxLength: 20 description: Unikt identifieringsnummer för eventuell separat revisionsberättelse som lämnades in. status: type: string description: Aktuell status för årsredovisningen. enum: - arsred_inkommen - arsred_registrerad - arsred_avslutad_ej_registrerad - arsred_forelaggande_skickat - arsred_komplettering_inkommen - test required: ["version", "idnummer", "status"]