---
openapi: 3.0.1
info:
title: Opendata Registered Notices Api
version: 2.0
license:
name: Creative Commons Nimeä 4.0
url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://avoindata.prh.fi/opendata-registerednotices-api/v3
paths:
/{businessId}:
get:
summary: "Sök företagets uppgifter och anmälningsuppgifter på FO-nummer"
operationId: GetCompany
parameters:
- in: path
name: businessId
required: true
description: "Exakt FO-nummer"
schema:
type: string
responses:
200:
description: "OK"
content:
application/json:
schema:
$ref: '#/components/schemas/Company'
400:
description: "Felaktig begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
429:
description: "För många begäranden"
content:
text/plain:
schema:
type: string
500:
description: "Internt serverfel"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
503:
description: "Servern kan inte behandla begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/:
get:
summary: "Sök uppgifter om registrerade anmälningar på olika kriterier"
operationId: GetCompanies
parameters:
- in: query
name: name
description: "Företagsnamn (firma) eller dess förled"
schema:
type: string
- in: query
name: businessId
description: "FO-nummer"
schema:
type: string
- in: query
name: location
description: "Postkontor"
schema:
type: string
- in: query
name: companyForm
description: >
Företagsform
schema:
type: string
enum: [ "AOY", "ASH", "ASY", "AY", "AYH", "ETS", "ETY", "SCE", "SCP", "HY", "KOY", "KVJ", "KVY", "KY", "OK",
"OP", "OY", "OYJ", "SE", "SL", "SP", "SÄÄ", "TYH", "VOJ", "VOY", "VY", "VALTLL"]
- in: query
name: registrationDateStart
description: "Företagets registreringsdatum under en tidsperiod (skriv in startdatum i formatet åååå-mm-dd)"
schema:
type: string
format: date
minLength: 10
maxLength: 10
- in: query
name: registrationDateEnd
description: "Företagets registreringsdatum under en tidsperiod (skriv in slutdatum i formatet åååå-mm-dd)"
schema:
type: string
format: date
minLength: 10
maxLength: 10
- in: query
name: recordNumber
description: "Diarienummer"
schema:
type: string
- in: query
name: entryCode
description: >
VVälj rubrik för registeranteckning
schema:
type: string
enum: [ "ALE", "ALLEK", "ANTIK", "ANTIP", "ANTIPP", "ARVO", "ASH", "ASTO", "ASY", "EDU", "ELI",
"ELLI", "ELSI", "ELUPA", "EMU", "EOJ", "EOJ4", "EPO", "ERIK", "ERIOI", "ESR", "ETJÄS",
"ETY", "EUSI", "EUVAL", "FUUSI", "HAL", "HALE", "HKJ", "HN", "HNE", "IAT", "IHA", "IKJ",
"IKV", "IMH", "IPA", "ISAN", "ISM", "ISV", "ITA", "IUM", "JAKEO", "JAKEP", "JAKHYL",
"JAKKUU", "JAKLLP", "JAKLOP", "JAKMUU", "JAKRAU", "JAKSUU", "JAPPO", "JOH", "JOHE", "JOHT",
"JOPO", "JULKUU", "JULPE", "JULU", "JÄSEN", "KANRA", "KANTA", "KEHOTU", "KLAJI", "KONALK",
"KONLOP", "KONRAU", "KOR", "KOROI", "KOTI", "KRM", "KUO", "KUUL", "KVE", "KVO", "LAA",
"LAKK", "LIIKUU", "LIILOP", "LIILUP", "LIISUU", "LMAKS", "LOPTIL", "LOSU", "LUNAS",
"LUNRI", "LUNVAL", "LUOVAL", "LUPEP", "LUPLOP", "LUPLOPP", "MAKSU", "MUI", "MUU", "MUUNTO",
"MUUSUU", "NIMA", "NIMAR", "NIML", "NIMO", "NIMOE", "NIMP", "NIMPE", "NIMPO", "NOPA",
"NORA", "NORTIL", "OALE", "OANKO", "OANTI", "OIK", "OIKP", "OLAJI", "OPJÄS", "OPO",
"OPOKO", "OPOMEN", "OPTIO", "OSAVU", "OSK", "OSK/R", "OSLUKU", "OSLUN", "OSLUNP", "OSLUO",
"OSMIT", "OSU", "OSUUS", "OSYHD", "OVE", "PALA", "PALE", "PEK", "PEKO", "PEPO", "PERPY",
"PERSUU", "PERUS", "POHJA", "POHJAE", "POISTO", "POITIL", "POIUH", "PTK", "SANALK",
"SANERO", "SANLOP", "SANRAJ", "SANSEL", "SELA", "SELAS", "SELJUL", "SELLOP", "SELM",
"SELME", "SELO", "SELOE", "SIIKUU", "SIILUP", "SIISUU", "SIIVAL", "SL", "SOLA", "SPO",
"STA", "STARA", "SULEO", "SULEP", "SULHYL", "SULKUU", "SULLLP", "SULLOP", "SULLUP",
"SULMUU", "SULRAK", "SULRAU", "SULSOP", "SULSUU", "SULTIE", "SULTIL", "SUOST", "SVE",
"SÄÄSTÖ", "TAL", "TALA", "TALPU", "TASE", "TEDU", "TEKSTI", "TIEELÄ", "TIEJUL", "TIEMUU",
"TILIKA", "TILTAE", "TILTAP", "TILTAR", "TLAJI", "TMI", "TMIA", "TMIAR", "TMIR", "TNIMAR",
"TOIJAT", "TOIM", "TOLUKU", "TOYHD", "TPKOR", "TPO", "TPSIJ", "TUNMU", "TUPLA", "TVE",
"ULKEDU", "ULKERO", "ULKOS", "USMI", "UTILI", "VAALI", "VAH/A", "VAH/M", "VAI", "VAIPA",
"VAIPAP", "VAIRA", "VAL", "VALIP", "VALP", "VALTPO", "VELALK", "VELLOP", "VKAKI", "VVOPT",
"VÄLKI", "YEH", "YHEN", "YHENE", "YHM", "YHME", "YHMUU", "YJ", "YMAKS", "YMUSUU", "YMUU" ]
- in: query
name: noticeRegistrationDateStart
description: "Registreringsdatum för anmälan under en tidsperiod (skriv in startdatum i formatet åååå-mm-dd)"
schema:
type: string
format: date
minLength: 10
maxLength: 10
- in: query
name: noticeRegistrationDateEnd
description: "Registreringsdatum för anmälan under en tidsperiod (skriv in slutdatum i formatet åååå-mm-dd)"
schema:
type: string
format: date
minLength: 10
maxLength: 10
- in: query
name: noticeRegistrationType
description: >
Välj typ av anmälan
schema:
type: string
enum: [ "DIF", "FUU", "H", "JH", "KM", "M", "OI", "T", "TA", "U", "VA" ]
- in: query
name: page
description: "Om sökningen ger mer än 50 träffar, visas de på flera sidor. Med parametern page kan du ange önskad resultatsida. Om parametern page inte anges, visas träffarna på första sidan. Om parametern page anger en sida som inte finns med i resultaten (till exempel om du söker sidan 5 och resultaten bara har 3 sidor), får du ett tomt svar."
schema:
type: integer
format: int32
responses:
200:
description: "OK"
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyResult'
400:
description: "Felaktig begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
429:
description: "För många begäranden"
content:
text/plain:
schema:
type: string
500:
description: "Internt serverfel"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
503:
description: "Servern kan inte behandla begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/publicnotices/{recordYear}/{recordNumber}:
get:
summary: "Sök registrerade anmälningar på diarienummer"
operationId: GetPublicNotices
parameters:
- in: path
name: recordYear
required: true
description: "År i diarienummer"
schema:
type: integer
format: int32
- in: path
name: recordNumber
required: true
description: "Diarienummer"
schema:
type: string
responses:
200:
description: "OK"
content:
application/json:
schema:
$ref: '#/components/schemas/CompanyPublicNotice'
400:
description: "Felaktig begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
429:
description: "För många begäranden"
content:
text/plain:
schema:
type: string
500:
description: "Internt serverfel"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
503:
description: "Servern kan inte behandla begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/description:
get:
summary: "Hämta uppgifter i kodlistan"
operationId: GetDescription
parameters:
- in: query
name: code
required: true
description: "Kod"
schema:
type: string
enum: [ "CF", "EC", "NRT" ]
- in: query
name: lang
required: true
description: "Språk kod"
schema:
type: string
enum: [ "EN", "FI", "SV" ]
responses:
200:
description: "OK"
content:
text/plain:
schema:
type: string
400:
description: "Felaktig begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
429:
description: "För många begäranden"
content:
text/plain:
schema:
type: string
500:
description: "Internt serverfel"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
503:
description: "Servern kan inte behandla begäran"
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
CompanyResult:
type: object
description: "Uppgifter om företaget eller sammanslutningen"
required: ["totalResults", "companies"]
properties:
totalResults:
type: integer
format: int64
description: "Totalt antal resultat"
companies:
type: array
description: "Uppgifter om företaget eller sammanslutningen"
items:
$ref: '#/components/schemas/Company'
Company:
type: object
description: "Uppgifter om företaget eller sammanslutningen"
required: ["businessId", "registeredEntries", "tradeRegisterStatus", "lastModified"]
properties:
businessId:
type: object
required: ["value", "source"]
description: "FO-nummer, till exempel 0116297-6"
properties:
value:
type: string
description: "FO-nummer"
minLength: 9
maxLength: 9
registrationDate:
type: string
nullable: true
format: date
description: "Y-tunnuksen antamispäivä"
minLength: 10
maxLength: 10
source:
$ref: '#/components/schemas/Source'
euId:
type: object
required: ["value", "source"]
description: "EUID, till exempel FIFPRO.0116297-6"
properties:
value:
type: string
description: "EUID"
minLength: 16
maxLength: 16
source:
$ref: '#/components/schemas/Source'
names:
type: array
description: "Företagets namn; huvudfirma, parallellfirmor och bifirmor"
items:
$ref: '#/components/schemas/RegisterName'
minItems: 0
mainBusinessLine:
type: object
required: ["type", "source"]
description: "Huvudsaklig bransch"
properties:
type:
type: string
description: "Branschkod"
minLength: 2
maxLength: 5
descriptions:
type: array
description: "Beskrivningar av bransch"
items:
$ref: '#/components/schemas/DescriptionEntry'
minItems: 0
typeCodeSet:
type: string
description: "Näringsgrensindelningens kodlistor TOIMI, TOIMI2, TOIMI3"
minLength: 5
maxLength: 6
registrationDate:
type: string
nullable: true
format: date
description: "Startdatum för branschkod i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
source:
$ref: '#/components/schemas/Source'
website:
type: object
required: ["url", "source"]
description: "Företagets webbplats"
properties:
url:
type: string
description: "Webbplats"
minLength: 0
maxLength: 255
registrationDate:
type: string
nullable: true
format: date
minLength: 10
maxLength: 10
source:
$ref: '#/components/schemas/Source'
companyForms:
type: array
description: "Företagsform och tidigare uppgift om den finns"
items:
$ref: '#/components/schemas/CompanyForm'
minItems: 0
maxItems: 2
companySituations:
type: array
description: "Företagets situation (eventuell sanering, likvidation eller konkurs)"
items:
$ref: '#/components/schemas/CompanySituation'
minItems: 0
registeredEntries:
type: array
description: "Företagets registeranteckningar"
items:
$ref: '#/components/schemas/RegisteredEntry'
minItems: 0
addresses:
type: array
description: "Företagets besöks- eller postadress"
items:
$ref: '#/components/schemas/Address'
minItems: 0
maxItems: 2
publicNotices:
type: array
description: "Registrerade anmälningar"
items:
$ref: '#/components/schemas/PublicNotice'
tradeRegisterStatus:
type: string
description: >
[Uppgift om företagets status i handelsregistret](/opendata-ytj-api/v3/description?code=REK_KDI&lang=sv)
status:
type: string
description: >
[Företagets FO-nummerstatus](/opendata-ytj-api/v3/description?code=STATUS3&lang=sv)
registrationDate:
type: string
nullable: true
format: date
description: "Företagets registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
endDate:
type: string
nullable: true
minLength: 10
maxLength: 10
format: date
description: "Datum för upphörande i formatet åååå-mm-dd"
lastModified:
type: string
minLength: 19
maxLength: 19
format: date-time
x-field-extra-annotation: "@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING, pattern = \"yyyy-MM-dd HH:mm:ss\")"
description: "Senast reviderad på sekundnivå utan tidszon i formatet 'åååå-mm-dd 00:00:00'"
Address:
type: object
description: "Adressuppgifter"
required: ["type", "source"]
properties:
type:
type: integer
format: int32
description: "Typ av adress, besöksadress: 1, postadress: 2. "
street:
type: string
nullable: true
description: "Gatuadress"
minLength: 0
maxLength: 50
postCode:
type: string
nullable: true
description: "Postnummer"
minLength: 0
maxLength: 5
postOffices:
type: array
description: "Postkontor på olika språk"
items:
$ref: '#/components/schemas/PostOffice'
minItems: 0
postOfficeBox:
type: string
nullable: true
description: "Postbox"
minLength: 0
maxLength: 5
buildingNumber:
type: string
nullable: true
description: "Hus"
minLength: 0
maxLength: 13
entrance:
type: string
nullable: true
description: "Trappa"
minLength: 0
maxLength: 13
apartmentNumber:
type: string
nullable: true
description: "Lägenhet"
minLength: 0
maxLength: 4
apartmentIdSuffix:
type: string
nullable: true
description: "Delningsbokstav"
minLength: 0
maxLength: 1
co:
type: string
nullable: true
description: "C/o i adress"
minLength: 0
maxLength: 34
country:
type: string
nullable: true
description: "Landskod med två bokstäver"
minLength: 0
maxLength: 2
freeAddressLine:
type: string
nullable: true
description: "Fritt formulerad adress till exempel för en utländsk adress. Radbyten har ersatts med mellanslag, mellanslag har ersatts med understreck, till exempel Norgårdsvägen_3 _ SE-451_75 Uddevalla"
minLength: 0
maxLength: 1000
registrationDate:
type: string
nullable: true
format : date
description: "Registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
source:
$ref: '#/components/schemas/Source'
RegisterName:
type: object
description: "Namnuppgifter"
required: ["name", "type", "version", "source"]
properties:
name:
type: string
description: "Firma (företagsnamn)"
minLength: 0
maxLength: 1000
type:
type: string
description: >
[Typ av namn](/opendata-ytj-api/v3/description?code=TLAJI&lang=sv)
minLength: 1
maxLength: 8
registrationDate:
type: string
nullable: true
format: date
description: "Registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
endDate:
type: string
nullable: true
format: date
description: "Registreringens slutdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
version:
type: integer
format: int32
description: "Version, 1 nuvarande version, andra siffror tidigare versioner"
source:
$ref: '#/components/schemas/Source'
CompanyForm:
type: object
required: ["type", "version", "source"]
description: "Företagsform"
properties:
type:
type: string
description: >
[Kod för företagsform](/opendata-ytj-api/v3/description?code=YRMU&lang=sv)
minLength: 1
maxLength: 8
descriptions:
type: array
description: "Beskrivningar av företagsform"
items:
$ref: '#/components/schemas/DescriptionEntry'
minItems: 0
registrationDate:
type: string
nullable: true
format: date
description: "Registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
endDate:
type: string
nullable: true
format: date
description: "Registreringens slutdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
version:
type: integer
format: int32
description: "Version, 1 nuvarande version, andra siffror tidigare versioner"
source:
$ref: '#/components/schemas/Source'
CompanySituation:
type: object
required: ["type", "source"]
description: "Företagets situation (eventuell sanering, likvidation eller konkurs)"
properties:
type:
type: string
description: >
[Kod för företagets situation](/opendata-ytj-api/v3/description?code=SELTILA,SANE,KONK&lang=sv)
enum: ["SANE", "SELTILA", "KONK"]
registrationDate:
type: string
nullable: true
format: date
description: "Registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
endDate:
type: string
nullable: true
format: date
description: "Registreringens slutdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
source:
$ref: '#/components/schemas/Source'
RegisteredEntry:
type: object
required: ["type", "register", "authority"]
description: "Registeranteckningar"
properties:
type:
type: string
description: >
[Kod för företagets registreringsstatus](/opendata-ytj-api/v3/description?code=REK_KDI&lang=sv). Tulkittava Koodistosta REK_KDI yhdistämällä rekisterimerkinnän koodi rekisterikoodiin erotettuna alaviivalla, esim '1_0' on rekisteröimätön kaupparekisterissä
minLength: 1
maxLength: 8
descriptions:
type: array
description: "Beskrivningar av registreringsstatus"
items:
$ref: '#/components/schemas/DescriptionEntry'
minItems: 0
registrationDate:
type: string
nullable: true
format: date
description: "Registreringsdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
endDate:
type: string
nullable: true
format: date
description: "Registreringens slutdatum i formatet åååå-mm-dd"
minLength: 10
maxLength: 10
register:
type: string
description: >
[Registerkod](/opendata-ytj-api/v3/description?code=REK&lang=sv)
minLength: 1
maxLength: 8
authority:
type: string
description: >
[Myndighetskod](/opendata-ytj-api/v3/description?code=VIRANOM&lang=sv)
minLength: 1
maxLength: 8
Source:
type: string
description: >
Datakälla
DescriptionEntry:
type: object
required: ["languageCode"]
description: "Databeskrivning"
properties:
languageCode:
type: string
description: "Språkkod, 1 - Finska, 2 - Svenska, 3 - Engelska"
maxLength: 2
description:
type: string
description: "Kodbeskrivning"
nullable: true
maxLength: 255
PostOffice:
type: object
required: ["city", "languageCode"]
description: "Postadresser"
properties:
city:
type: string
description: "Postkontor"
maxLength: 50
languageCode:
type: string
description: >
[Språkkod](/opendata-ytj-api/v3/description?code=KIELI&lang=sv)
maxLength: 8
municipalityCode:
type: string
description: "Kommunkod"
nullable: true
minLength: 3
maxLength: 3
PostOfficeEntry:
type: object
required: ["postCode", "city", "active", "languageCode"]
description: "Postadresser"
properties:
postCode:
type: string
description: "Postnummer"
minLength: 5
maxLength: 5
city:
type: string
description: "Postkontor"
maxLength: 50
active:
type: boolean
description: "Är uppgiften aktiv"
languageCode:
type: string
description: >
[Språkkod](/opendata-ytj-api/v3/description?code=KIELI&lang=sv)
maxLength: 8
municipalityCode:
type: string
description: "Kommunkod"
nullable: true
minLength: 3
maxLength: 3
PublicNotice:
type: object
required: [ "recordNumber" ]
description: ""
properties:
registrationDate:
type: string
format: date
description: "Registreringsdatum"
recordNumber:
type: string
description: "Diarienummer av anteckning"
typeOfRegistration:
type: string
description: "Registreringstyp av anteckning"
entryCodes:
type: array
description: "Koderna för registrerat ärende"
items:
type: string
CompanyPublicNotice:
type: object
required: [ "businessId", "recordNumber" ]
description: ""
properties:
businessId:
type: string
description: "FO-nummer för företag"
registrationDate:
type: string
format: date
description: "Registreringsdatum"
recordNumber:
type: string
description: "Diarienummer av anteckning"
typeOfRegistration:
type: string
description: "Registreringstyp av anteckning"
entryCodes:
type: array
description: "Koderna för registrerat ärende"
items:
type: string
companyDetailsUri:
type: string
description: "URI för ytterligare uppgifter"
ErrorResponse:
type: object
required: [ "timestamp", "code" ]
description: "Felmeddelande"
properties:
timestamp:
type: string
minLength: 19
maxLength: 19
format: date-time
x-field-extra-annotation: "@com.fasterxml.jackson.annotation.JsonFormat(shape = com.fasterxml.jackson.annotation.JsonFormat.Shape.STRING, pattern = \"yyyy-MM-dd HH:mm:ss\")"
description: "Tid på sekundnivå utan tidszon i formatet ’ÅÅÅÅ-MM-DD 00:00:00'"
message:
type: string
description: "Felmeddelande"
maxLength: 1000
errorcode:
type: integer
format: int32
description: "Felkod"
externalDocs:
description: "Ytterligare information om programvaran Swagger"
url: 'http://swagger.io'