Ettevõtte detailandmed

Meetod: GET /company/{registryCode}

OpenAPI / Swagger: get_company_data

Tagastab ettevõtte detailandmed registrikoodi alusel. Päringu include-parameetritega saab valida üldandmed, seotud isikud, kommertspandid, määrused ja registrikaardid.

Autentimine: OAuth2 Bearer-pääsutõend Authorization-päises.

Tee parameetrid

Parameeter Tüüp Kohustuslik Kirjeldus
registryCode integer Jah Ettevõtte registrikood.

Päringu parameetrid

Parameeter Tüüp Kohustuslik Kirjeldus
includeGeneralData boolean Ei Taotleb üldandmeid. Vaikimisi: false.
includeRelatedPersons boolean Ei Taotleb seotud isikute andmeid. Vaikimisi: false.
includeCommercialPledgeData boolean Ei Taotleb kommertspandiandmeid. Vaikimisi: false.
includeRulings boolean Ei Taotleb määruseid koos olekumuutuste ja seotud kande andmetega. Vaikimisi: false.
includeRegistryCards boolean Ei Taotleb registrikaarte koos nende kannetega. Vaikimisi: false.
onlyValid boolean Ei Kuvab ainult kehtivad andmed. Vaikimisi: true.

Päise parameetrid

Parameeter Tüüp Kohustuslik Kirjeldus
apiVersion ApiVersions Ei API versioon. Toetatud väärtus: V1. Vaikimisi: V1.
acceptLanguage AcceptLanguage Ei Klassifikaatorite tõlgete keel: est – eesti, eng – inglise. Vaikimisi: est.

Vastus (200)

Vastus on CompanyDetailDataResponse objekt. Kohustuslikkus näitab välja olemasolu nõuet sisaldavas objektis; see ei muuda valikulist andmeplokki kohustuslikuks. Tüübis null tähendab, et välja väärtus võib olla null.

Vastuse põhiväljad

Väli Tüüp Kohustuslik Kirjeldus
legalEntityName string Jah Ettevõtte ärinimi.
registryCode integer Jah Ettevõtte registrikood.
companyId integer Jah Ettevõtte sisemine ID.
vatID string | null Ei Käibemaksukohustuslase number.
generalData DetailDataGeneralData | null Ei Üldandmed; taotlemiseks includeGeneralData=true. Ettevõtte üldandmed.
relatedPersons DetailDataRelatedPersons | null Ei Seotud isikud; taotlemiseks includeRelatedPersons=true. Ettevõttega seotud isikud.
commercialPledgeData CommercialPledge[] | null Ei Kommertspantide loend; taotlemiseks includeCommercialPledgeData=true. Ettevõtte kommertspandid.
rulings Ruling[] | null Ei Määruste loend; taotlemiseks includeRulings=true. Vt allpool Ruling.
registryCards RegistryCard[] | null Ei Registrikaartide loend; taotlemiseks includeRegistryCards=true. Vt allpool RegistryCard.

Üldandmed — DetailDataGeneralData

Ettevõtte üldandmed

Seotud isikud — DetailDataRelatedPersons

Ettevõttega seotud isikud

Kommertspandid — CommercialPledge

Ettevõtte kommertspandid

Määrused — includeRulings

includeRulings=true taotleb rulings loendit. Määrus sisaldab oma liiki, jõustumise viisi, kuupäevi ja olekut. statusChanges kirjeldab määruse olekumuutusi; entry sisaldab seotud registrikannet. additionalTerm ja entry on valikulised ning võivad olla null. statusChanges on määruse objektis kohustuslik loend ega või olla null.

Ruling

Väli Tüüp Kohustuslik Kirjeldus
number string Jah Määruse number.
date string (date) Jah Määruse kuupäev.
type string Jah Määruse liigi kood.
typeAsText string Jah Määruse liik tekstina.
effectiveDate string (date) Jah Määruse jõustumise kuupäev.
rulingInForceType string Jah Määruse jõustumise viisi kood.
rulingInForceTypeAsText string Jah Määruse jõustumise viis tekstina.
additionalTerm string (date) | null Ei Lisatähtaja kuupäev.
status string Jah Määruse oleku kood, mitte ettevõtte staatuse kood.
statusAsText string Jah Määruse olek tekstina.
statusDate string (date) Jah Määruse oleku kuupäev.
statusChanges StatusChange[] Jah Määruse olekumuutused; iga element on StatusChange.
entry Entry | null Ei Määrusega seotud kande andmed; vt Entry.

StatusChange

Väli Tüüp Kohustuslik Kirjeldus
id integer Jah Olekumuutuse sisemine ID e-äriregistris.
status string Jah Määruse oleku kood pärast muutust.
statusAsText string Jah Määruse olek tekstina.
statusChangeDate string (date) Jah Määruse oleku muutmise kuupäev.

Entry

Väli Tüüp Kohustuslik Kirjeldus
number integer Jah Kande number.
date string (date) Jah Kande kuupäev.
type string Jah Kande liigi kood.
typeAsText string Jah Kande liik tekstina.
cardNumber integer Jah Registrikaardi number.
cardType string Jah Registrikaardi liigi kood.

Registrikaardid — includeRegistryCards

includeRegistryCards=true taotleb registryCards loendit. Iga kaart sisaldab kirje ID-d, kaardi numbrit ja liiki ning kannete loendit. Kaardi entries elemendis on kande kirje ID; määruse entry objektis on selle asemel kaardi number ja liik. Neid kahte kandestruktuuri ei tule samastada. Kõik allpool toodud RegistryCard ja DetailDataEntry väljad on kohustuslikud ega või olla null.

RegistryCard

Väli Tüüp Kohustuslik Kirjeldus
recordId integer (int64) Jah Registrikaardi kirje ID.
cardNumber integer (int64) Jah Registrikaardi number.
cardType string Jah Registrikaardi liigi kood, näiteks R.
entries DetailDataEntry[] Jah Selle registrikaardi kanded; iga element on DetailDataEntry.

DetailDataEntry

Väli Tüüp Kohustuslik Kirjeldus
recordId integer (int64) Jah Kandekirje ID.
number integer (int64) Jah Kande number.
date string (date) Jah Kande kuupäev.
type string Jah Kande liigi kood.
typeAsText string Jah Kande liik tekstina.

Päringu näited

Kõik andmeplokid, ainult kehtivad andmed:

GET /company/19999991?includeGeneralData=true&includeRelatedPersons=true&includeCommercialPledgeData=true&includeRulings=true&includeRegistryCards=true&onlyValid=true
apiVersion: V1
acceptLanguage: est

Kõik andmeplokid, kehtivate andmete filtrita:

GET /company/19999991?includeGeneralData=true&includeRelatedPersons=true&includeCommercialPledgeData=true&includeRulings=true&includeRegistryCards=true&onlyValid=false

Vastuse näide (200)

{
 "legalEntityName": "Kasepilve Tarkvara OÜ",
 "registryCode": 19999991,
 "companyId": 990001,
 "generalData": {
 "companyRegistryNumber": 19999991,
 "einvoiceProvider": null,
 "hasUndeclaredReports": false,
 "firstEntryTime": "2025-02-03",
 "deletionDate": null,
 "isFIEOperating": null,
 "isFIEOperatingAsText": null,
 "isCSDRegistered": false,
 "entryCSDRegistrationDate": null,
 "status": {
 "status": "R",
 "statusAsText": "Registrisse kantud",
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991001,
 "startDate": "2025-02-03",
 "endDate": null
 },
 "legalEntityNames": [
 {
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991002,
 "startDate": "2025-02-03",
 "endDate": null,
 "content": "Kasepilve Tarkvara OÜ"
 }
 ],
 "additionalNames": null,
 "addresses": [
 {
 "address": {
 "address": "Näidistänav 1, Näidislinn"
 },
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991003,
 "startDate": "2025-02-03"
 }
 ],
 "boardLocationAddresses": null,
 "contactPersonAddresses": null,
 "legalForm": [
 {
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991004,
 "startDate": "2025-02-03",
 "endDate": null,
 "content": "OÜ",
 "contentNumber": 5,
 "contentAsText": "Osaühing"
 }
 ],
 "legalFormSubtypes": null,
 "capitals": [
 {
 "currency": "EUR",
 "currencyAsText": "euro",
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991005,
 "startDate": "2025-02-03",
 "endDate": null,
 "size": 2500
 }
 ],
 "noParValueShares": null,
 "financialYears": [
 {
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991006,
 "startDate": "2025-02-03",
 "endDate": null,
 "financialYearStartDate": "2025-01-01",
 "financialYearEndDate": "2025-12-31"
 }
 ],
 "associationArticles": [
 {
 "approvalDate": "2025-01-30",
 "modifiedDate": null,
 "explanation": null,
 "containsSpecialRights": false,
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991007,
 "startDate": "2025-02-03",
 "endDate": null
 }
 ],
 "commMeans": [
 {
 "type": "EMAIL",
 "typeAsText": "Elektronposti aadress",
 "cardNumber": null,
 "cardType": null,
 "entryNumber": null,
 "recordId": 991008,
 "startDate": "2025-02-03",
 "endDate": null,
 "content": "[email protected]"
 },
 {
 "type": "WWW",
 "typeAsText": "Interneti WWW aadress",
 "cardNumber": null,
 "cardType": null,
 "entryNumber": null,
 "recordId": 991010,
 "startDate": "2025-02-03",
 "endDate": null,
 "content": "https://example.invalid"
 }
 ],
 "reportedActivities": null,
 "infoFinancialYearFromReports": null,
 "isFoundedWithoutPayment": false,
 "hasAbandonedFormReqs": false,
 "isAccountingLiable": null,
 "isRequiredtoProvideBeneficiaries": true,
 "isHDRCompetentAuthority": null
 },
 "relatedPersons": {
 "representationRights": {
 "persons": [
 {
 "firstName": "Mari",
 "surnameLegalEntityName": "Maasikas",
 "entityCode": "48503151233",
 "entityCodeCountry": "EST",
 "birthday": "1985-03-15",
 "personType": "F",
 "role": "JUHL",
 "roleAsText": "Juhatuse liige",
 "exclusiveRightOfRepresentation": true,
 "entityCodeCountryAsText": "Eesti"
 }
 ],
 "representationRightSpecialConditions": [],
 "representationRightGroups": []
 },
 "personsOnCard": [
 {
 "person": {
 "role": "JUHL",
 "roleAsText": "Juhatuse liige",
 "startDate": "2025-02-03",
 "endDate": null,
 "type": "F",
 "firstName": "Mari",
 "surnameLegalEntityName": "Maasikas",
 "identityCode": "48503151233",
 "foreignCode": null,
 "foreignCodeCountry": null,
 "foreignCodeCountryAsText": null,
 "birthday": "1985-03-15"
 },
 "address": {},
 "expirationDate": null,
 "email": "[email protected]",
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 1,
 "recordId": 991011,
 "startDate": "2025-02-03",
 "endDate": null
 }
 ],
 "representationRightNormalRulings": [
 {
 "role": "JUHL",
 "content": "Osaühingut võib kõikide tehingute tegemisel esindada iga juhatuse liige."
 }
 ],
 "representationRightSpecialConditions": null,
 "partialPledgesAndTransfers": null,
 "shareholders": [
 {
 "person": {
 "role": "OSAN",
 "roleAsText": "Osanik",
 "startDate": "2025-02-03",
 "endDate": null,
 "type": "F",
 "firstName": "Mari",
 "surnameLegalEntityName": "Maasikas",
 "identityCode": "48503151233",
 "foreignCode": null,
 "foreignCodeCountry": null,
 "foreignCodeCountryAsText": null,
 "birthday": "1985-03-15",
 "share": {
 "sharePercentage": 100.0,
 "shareSize": 2500.0,
 "shareCurrencyAsText": "euro"
 }
 },
 "address": {},
 "sharePercentage": 100.0,
 "shareSize": 2500.0,
 "shareCurrency": "EUR",
 "shareCurrencyAsText": "euro",
 "shareOwnershipType": "L",
 "shareOwnershipTypeAsText": "Ainuomand",
 "shareFractionNumerator": null,
 "shareFractionDenominator": null,
 "expirationDate": null,
 "authoritySource": null,
 "authoritySourceAsText": null,
 "authoritySourceDate": null,
 "groupId": null,
 "recordId": 991012,
 "startDate": "2025-02-03",
 "endDate": null
 }
 ],
 "nonCardRelatedPersons": null,
 "buildingAssociationMembers": null
 },
 "commercialPledgeData": [
 {
 "id": 1001,
 "number": 1,
 "status": null,
 "statusAsText": null,
 "rank": null,
 "rankAsText": null,
 "amount": "100000.00",
 "currency": "EUR",
 "currencyAsText": "euro",
 "rankings": null,
 "amounts": [
 {
 "currency": "EUR",
 "currencyAsText": "euro",
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 2,
 "recordId": 991013,
 "startDate": "2025-02-10",
 "endDate": null,
 "size": 100000.0
 }
 ],
 "pledgees": [
 {
 "personType": "J",
 "name": "Kuldoru Finantseerimine OÜ",
 "code": "19999992",
 "country": "EST",
 "countryAsText": "Eesti",
 "ehak": null,
 "ehakAsText": null,
 "fraction": null,
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 2,
 "recordId": 991014,
 "startDate": "2025-02-10",
 "endDate": null
 }
 ],
 "notes": null,
 "cardNumber": 1,
 "cardType": "R",
 "entryNumber": 2,
 "recordId": 991015,
 "startDate": "2025-02-10",
 "endDate": null
 }
 ],
 "rulings": [
 {
 "number": "Ä 59999991 / 1",
 "date": "2025-02-03",
 "type": "K1",
 "typeAsText": "Kanne",
 "effectiveDate": "2025-02-03",
 "rulingInForceType": "J",
 "rulingInForceTypeAsText": "Jõustub kande tegemisel",
 "additionalTerm": null,
 "status": "J",
 "statusAsText": "Jõustunud",
 "statusDate": "2025-02-03",
 "statusChanges": [
 {
 "id": 990001,
 "status": "J",
 "statusAsText": "Jõustunud",
 "statusChangeDate": "2025-02-03"
 }
 ],
 "entry": {
 "number": 1,
 "date": "2025-02-03",
 "type": "2",
 "typeAsText": "Esmakanne",
 "cardNumber": 1,
 "cardType": "R"
 }
 }
 ],
 "registryCards": [
 {
 "recordId": 990002,
 "cardNumber": 1,
 "cardType": "R",
 "entries": [
 {
 "recordId": 990003,
 "number": 1,
 "date": "2025-02-03",
 "type": "2",
 "typeAsText": "Esmakanne"
 },
 {
 "recordId": 990004,
 "number": 2,
 "date": "2025-02-10",
 "type": "21",
 "typeAsText": "Kommertspandi avamiskanne"
 }
 ]
 }
 ]
}

Veavastused

  • 403 – teenusele juurdepääs keelatud. Vastuse sisu vormingut ei ole OpenAPI-s määratud.
  • 404 – ei leitud. Vastus: CustomValidationError.
  • 422 – päringu valideerimisviga. Vastus: HTTPValidationError.

404 — CustomValidationError

Väli Tüüp Kohustuslik Kirjeldus
message string Jah Veateade.
code APIError Jah APIError veakood: 2001, 4030 või 4041–4049.
id string | null Jah Vea identifikaator.
timestamp string (date-time) Ei Vea ajatempel.

422 — HTTPValidationError

Väli Tüüp Kohustuslik Kirjeldus
detail ValidationError[] Ei Valideerimisvigade loend; iga element on ValidationError.

ValidationError

Väli Tüüp Kohustuslik Kirjeldus
loc string | integer[] Jah Vea asukoha osad: parameetri nimi või loendi indeks.
msg string Jah Veateade.
type string Jah Valideerimisvea tüüp.
input any Ei Valideerimisel saadud sisend; tüüp ei ole piiratud.
ctx object Ei Täiendav veakontekst.

Illustratiivne veavastus (404)

Kood 4041 on APIError lubatud väärtus; näide ei määra selle koodi tähendust.

{
 "message": "Andmeid ei leitud.",
 "code": 4041,
 "id": null,
 "timestamp": "2025-02-03T10:00:00Z"
}

Valideerimisvea näide (422)

{
 "detail": [
 {
 "loc": [
 "query",
 "includeRulings"
 ],
 "msg": "Sisend peab olema tõeväärtus.",
 "type": "bool_parsing",
 "input": "abc"
 }
 ]
}