swagger: '2.0' info: description: Bolagsverket's API for basic data and case status for organizations version: '1.3' title: API for information and status about public companies contact: name: The Swedish Companies Registration Office Group for electronic annual reports email: emsdiar@bolagsverket.se license: name: Public document according to the Swedish Press Act url: 'http://www.notisum.se/rnp/sls/lag/19490105.htm#K2P3' externalDocs: description: Information aboud electronic annual reports url: 'http://bolagsverket.se/om/oss/utveckling-av-digitala-tjanster/digital-ingivning' host: api.bolagsverket.se basePath: /hamta-arsredovisningsinformation/v1.3 schemes: - https tags: - name: information description: Services that supply information paths: '/grunduppgifter/{orgnr}': get: tags: - information summary: Get basic information about organization description: >- The service delivers information about organizations. The information is suitable for preparing annual reports. operationId: grunduppgifter consumes: - "application/json" produces: - "application/json" parameters: - $ref: '#/parameters/orgnrPathParam' responses: '200': description: OK schema: $ref: '#/definitions/Grunduppgifter' '400': description: Bad request schema: $ref: '#/definitions/Fel' '403': description: Unauthorized user of service schema: $ref: '#/definitions/Fel' '404': description: Organisation number missing 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' '/arendestatus/{orgnr}': get: tags: - information summary: Get case status for organization description: >- The service delivers information about the latest event related to the annual report for an organization. operationId: arendestatus consumes: - "application/json" produces: - "application/json" parameters: - $ref: '#/parameters/orgnrPathParam' responses: '200': description: successful operation schema: $ref: '#/definitions/Arendestatus' '400': description: Bad request schema: $ref: '#/definitions/Fel' '403': description: Unauthorized user of service schema: $ref: '#/definitions/Fel' '404': description: Organisation number missing 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' parameters: orgnrPathParam: name: orgnr in: path required: true type: string pattern: '[0-9]{10}' description: 'Organization number for the organization. Ten digits, no hyphen' definitions: 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"] Grunduppgifter: type: object description: Information about an organization that can be useful for drawing up an annual report properties: orgnr: type: string pattern: '[0-9]{10}' description: 'Organization number for the organization. Ten digits, no hyphen' lopnummer: type: integer format: int32 minimum: 1 description: 'Sequential number for the organization. Only used when there are several company names for an organization number, e.g. for non-profit associations' example: null namn: type: string maxLength: 200 description: The organization's name as it is registered in the Swedish Companies Registration Office's register example: Exempel AB status: type: array items: $ref: '#/definitions/Foretagstatus' rakenskapsperioder: type: array description: The last four accounting periods. For newly started organisations, the current accounting period is shown. items: $ref: '#/definitions/Rakenskapsperiod' foretradare: type: array description: Information about registered representatives of an organization items: $ref: '#/definitions/Foretradare' required: ["orgnr", "namn"] Foretagstatus: type: object description: Information on the status of the company. properties: kod: type: string description: Code for the company status pattern: '[0-9]{2}' text: type: string description: Descriptive text for the company status datum: type: string format: date description: Date for the company status Rakenskapsperiod: type: object description: >- Information about the reporting period of an organization. For newly founded companies that have not yet reached the end of their first financial year, this is information about the first reporting period. For older public companies, this is the information about the last four closed reporting periods. - Example 1: if a company that is founded June 15 2018 and has calendar year as fiscal year and a query is made on December 25 2018, then the reporting period will be June 15 - December 31 2018. - Example 2: Assume that a public company is going to submit annual reports for reporting periods December 1 2017 to December 31 2017 and January 1 2018 to December 31 2018. If this service is queried at December 31 2018, the reporting periods returned is from December 1 2017 to December 31 2017 plus the previous three. If this service is queried at January 1 2019, the reporting periods returned is from January 1 2018 to December 31 2018 plus the previous three. properties: from: type: string format: date description: First date in the organization's accounting period example: "2023-01-01" tom: type: string format: date description: Last date in the organization's accounting period example: "2023-12-31" kravPaRevisionsberattelse: type: string description: |- Auditor's report required. - ja (yes) if an auditor's report is required for the reporting period. - nej (no) if an auditor's report is not required for the reporting period. - uppgift_saknas (data missing) if the requirement of an auditor's report is missing. For example at newly started companies where the period has not passed. enum: - ja - nej - uppgift_saknas required: ["kravPaRevisionsberattelse"] Foretradare: type: object description: Information about a representative of an organization properties: fornamn: type: string maxLength: 50 description: First name of the representative, if applicable namn: type: string maxLength: 50 description: >- Surname or company name of the representative personnummer: type: string description: Personal ID number of the representative without century. Twelve digits, no dash pattern: '(19|20)[0-9]{10}' annanIdentitet: type: string maxLength: 10 description: >- Other identification if the person does not have a personal identification number: date of birth, organization number or other funktioner: type: array items: $ref: '#/definitions/Funktion' required: ["namn"] Funktion: type: object description: Information about a representative's function in an organization properties: kod: type: string description: Code that describes the function of the representative text: type: string description: Description of the function of the representative required: ["kod", "text"] Arendestatus: type: object properties: orgnr: type: string pattern: '[0-9]{10}' description: Organization number for the organization. Ten digits, no hyphen lopnummer: type: integer format: int32 minimum: 1 description: 'Sequential number for the organization. Only used when there are several company names for an organization number, e.g. for non-profit associations' example: null namn: type: string maxLength: 200 description: The organization's name as it is registered in the Swedish Companies Registration Office's register example: Exempel AB hamtat: type: string format: date-time description: Date and time when the status was retrieved, ie. when the response was generated tidpunkt: type: string format: date description: Date of change of status typ: type: string description: Type of event that gave rise to the change of status enum: - arsred_inkommen - arsred_registrerad - arsred_avslutad_ej_registrerad - arsred_forelaggande_skickat - arsred_komplettering_inkommen - arsred_saknas arendenummer: type: string pattern: '[0-9]+/[0-9]{4}' description: Case number for the annual report submission example: '12345/2024' rakenskapsperiod: type: object description: The reporting period which the event applies to properties: from: type: string format: date example: "2023-01-01" tom: type: string format: date example: "2023-12-31" required: ["from", "tom"] required: ["orgnr", "namn", "hamtat", "typ"]