Meetod: GET /company/companyRelations
OpenAPI/Swagger: https://ar-rest.rik.ee/docs#/Company/get_company_relations
Võimaldab otsida ettevõtteid ja nende seoseid füüsiliste ning juriidiliste isikutega. Otsingut saab piirata ettevõtte nime, registrikoodi, tegevusala, aadressi ja staatuse järgi. Seotud füüsilist isikut otsitakse nime, sünnikuupäeva või isikukoodi järgi; seotud juriidilist isikut nime või registrikoodi järgi. personRoles piirab otsingut seotud isiku rollidega. Vastus sisaldab ettevõtete rekvisiite, kontaktandmeid ja otsinguga seotud isikuid.
Päringu parameetrid
| Parameeter |
Tüüp |
Kohustuslik |
Kirjeldus |
|---|
| legalEntityName |
string |
Valikuline |
Ettevõtte nimi. |
| registryCode |
integer |
Valikuline |
Ettevõtte registrikood. |
| activityCode |
string |
Valikuline |
Ettevõtte tegevusala kood. |
| personFirstName |
string |
Valikuline |
Seotud füüsilise isiku eesnimi. |
| personSurname |
string |
Valikuline |
Seotud füüsilise isiku perekonnanimi. |
| personBirthday |
string (date) |
Valikuline |
Seotud füüsilise isiku sünnikuupäev. |
| identityCode |
string |
Valikuline |
Seotud füüsilise isiku isikukood. |
| identityCodeCountry |
string |
Valikuline |
Seotud füüsilise isiku isikukoodi riik. |
| personRoles |
array[string] |
Valikuline |
Filter seotud isiku rollikoodide järgi. Vt Seotud isiku rollid. |
| legalPersonName |
string |
Valikuline |
Seotud juriidilise isiku nimi. |
| legalPersonCode |
string |
Valikuline |
Seotud juriidilise isiku registrikood. |
| legalPersonCodeCountry |
string |
Valikuline |
Seotud juriidilise isiku registrikoodi riik. |
| locationEnterpriserByAddress |
string |
Valikuline |
Ettevõtte aadressijärgne asukoht. |
| adminUnitEnterpriserByAddress |
string |
Valikuline |
Ettevõtja aadressijärgne haldusüksus. |
| onlyValid |
boolean |
Valikuline |
Kuvab ainult kehtivad andmed. Vaikeväärtus: true. |
| statuses |
array[CompanyStatus | string] |
Valikuline |
Ettevõtja staatuse filter; vt Staatused. Filtri puudumisel tagastatakse kõik staatused, välja arvatud projekt, registrisse kandmata ja keeldutud. |
| pageNumber |
integer |
Valikuline |
Tulemuste lehekülje number. Vaikeväärtus: 1; Maksimum: 100000; Suurem kui: 0. |
| pageSize |
integer |
Valikuline |
Soovitud tulemuste arv ühel lehel. Vaikeväärtus: 100; Maksimum: 1000; Suurem kui: 0. |
Päise parameetrid
| Parameeter |
Tüüp |
Kohustuslik |
Kirjeldus |
|---|
| apiVersion |
ApiVersions |
Valikuline |
API versioon. Lubatud ja toetatud väärtus: V1. Vaikimisi: V1. |
| acceptLanguage |
AcceptLanguage |
Valikuline |
Klassifikaatorite tõlgete keel: est – eesti, eng – inglise. Vaikimisi: est. |
Vastuse skeem
Kohustuslikud väljad peavad vastuses sisalduma. Muud väljad võivad puududa; null on lubatud ainult siis, kui see on välja tüübis kirjas.
CompanyRelationsResponse
| Väli |
Tüüp |
Kirjeldus |
|---|
| total |
integer (int64) |
Kohustuslik. Kirjete koguarv |
| list |
array[CompanyRequisites] |
Kohustuslik. Ettevõtjad |
CompanyRequisites
| Väli |
Tüüp |
Kirjeldus |
|---|
| legalEntityName |
string |
Kohustuslik. Ettevõtte ärinimi või nimi Minimaalne pikkus: 1. |
| registryCode |
integer | null (int64) |
Ettevõtte registrikood |
| legalForm |
string | null |
Ettevõtja õiguslik vorm. OpenAPI määrab tüübiks string, kuid ei piira väärtusi loendiga. |
| legalFormSubtype |
string | null |
Ettevõtja õigusliku vormi alaliik |
| status |
string |
Kohustuslik. Ettevõtja staatus Minimaalne pikkus: 1.. Vt Staatused. |
| statusAsText |
string |
Kohustuslik. Ettevõtja staatus tekstina Minimaalne pikkus: 1.. Vt Staatused. |
| firstEntrydate |
string (date) | null |
Ettevõtja esmase kande kuupäev |
| deletionDate |
string (date) | null |
Kustutatud ettevõtja kustutamise kuupäev |
| einvoiceProvider |
string | null |
E-arve teenusepakkuja tunnus |
| reportedActivities |
array[ReportedActivityArea] | null |
Aruandes esitatud tegevusalad |
| email |
array[RecordType] | null |
E-posti aadress |
| phone |
array[string] | null |
Telefon |
| homepage |
array[string] | null |
Ettevõtte peamine veebileht |
| infoSystemUrl |
string | null |
Ettevõtte link e-äriregistris |
| vatNumber |
string | null |
Käibemaksukohustuslase registrinumber |
| address |
array[RecordFullAddress] | null |
Aadress |
| searchRelatedPersons |
array[PersonRolesInfo] | null |
Otsinguga seotud isik |
ReportedActivityArea
| Väli |
Tüüp |
Kirjeldus |
|---|
| emtakCode |
string | null |
Tegevusala kood EMTAK-i järgi |
| emtakAsText |
string | null |
EMTAK-i kood tekstina |
| emtakVersion |
integer | null (int64) |
EMTAK-i versioon |
| emtakVersionAsText |
string | null |
EMTAK-i versioon tekstina |
| naceCode |
string | null |
NACE kood |
| isMainBusinessArea |
boolean | null |
Kas on põhitegevusala |
| recordId |
integer | null (int64) |
ID |
| startDate |
string (date) | null |
Alguskuupäev |
| endDate |
string (date) | null |
Lõppkuupäev |
RecordType
| Väli |
Tüüp |
Kirjeldus |
|---|
| type |
string | null |
Tüüp |
| typeAsText |
string | null |
Tüüp tekstina |
| content |
string | null |
Sisu |
| cardNumber |
integer | null (int64) |
Kaardi number |
| cardType |
string | null |
Kaardi tüüp |
| entryNumber |
integer | null (int64) |
Kande number |
| recordId |
integer | null (int64) |
ID |
| startDate |
string (date) | null |
Alguskuupäev |
| endDate |
string (date) | null |
Lõppkuupäev |
RecordFullAddress
| Väli |
Tüüp |
Kirjeldus |
|---|
| address |
FullAddress |
Kohustuslik. Täisaadress |
| cardNumber |
integer (int64) |
Kohustuslik. Kaardi number |
| cardType |
string |
Kohustuslik. Kaardi tüüp |
| entryNumber |
integer (int64) |
Kohustuslik. Kande number |
| recordId |
integer (int64) |
Kohustuslik. ID |
| startDate |
string (date) |
Kohustuslik. Alguskuupäev |
| endDate |
string (date) | null |
Lõppkuupäev |
FullAddress
| Väli |
Tüüp |
Kirjeldus |
|---|
| country |
string | null |
Riik |
| countryAsText |
string | null |
Riik tekstina |
| address |
string | null |
Aadress |
| postalCode |
string | null |
Postiindeks |
| ehak |
string | null |
EHAK kood Minimaalne pikkus: 1. |
| ehakAsText |
string | null |
EHAK tekstina Minimaalne pikkus: 1. |
| adsAdobId |
string | null |
Aadressi ADOBID |
| adsNormalizedFullAddressSuffix |
string | null |
Normaliseeritud ADS-aadressi tekstiline täiendus (nt postkasti number) |
| adsType |
string | null |
Aadressi tüüp: 0 – täielik ADS, 1 – osaline ADS, 2 – ADS-ita |
| adsOid |
string | null |
Aadressi ADS OID |
| adrId |
integer | null |
Aadressi ADR ID |
| adsNormalizedFullAddress |
string | null |
ADS-i normaliseeritud täisaadress |
| adsCodeAddress |
string | null |
Aadressi ADS-kood |
| loadingDate |
string (date) | null |
Andmete KR-ist laadimise kuupäev |
PersonRolesInfo
| Väli |
Tüüp |
Kirjeldus |
|---|
| role |
string |
Kohustuslik. Isiku roll. Vt Seotud isiku rollid. |
| roleAsText |
string |
Kohustuslik. Isiku roll tekstina. Vt Seotud isiku rollid. |
| startDate |
string (date) | null |
Seose alguskuupäev |
| endDate |
string (date) | null |
Seose lõppkuupäev |
| type |
string |
Kohustuslik. Isiku liik: F – füüsiline isik, J – juriidiline isik. |
| firstName |
string | null |
Eesnimi |
| surnameLegalEntityName |
string |
Kohustuslik. Perekonnanimi või ärinimi |
| identityCode |
string | null |
Kohustuslik. Isiku- või registrikood |
| foreignCode |
string | null |
Välisriigi isikukood |
| foreignCodeCountry |
string | null |
Välisriigi isikukoodi riik |
| foreignCodeCountryAsText |
string | null |
Välisriigi isikukoodi riik tekstina |
| birthday |
string (date) | null |
Sünnikuupäev |
| share |
ShareData | null |
Osaluse andmed (rollid O, OSAN, S). |
ShareData
| Väli |
Tüüp |
Kirjeldus |
|---|
| sharePercentage |
number | null (double) |
Osaluse protsent. |
| shareSize |
number | null (double) |
Osaluse suurus. |
| shareCurrencyAsText |
string | null |
Osaluse vääring tekstina. |
CustomValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| message |
string |
Kohustuslik. Veateade. |
| code |
APIError |
Kohustuslik. Veakood. Lubatud väärtused on APIError skeemis. |
| id |
string | null |
Kohustuslik. Vea identifikaator. |
| timestamp |
string (date-time) |
Vea ajatempel. |
HTTPValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| detail |
array[ValidationError] |
Valideerimisvigade loend. |
ValidationError
| Väli |
Tüüp |
Kirjeldus |
|---|
| loc |
array[string | integer] |
Kohustuslik. Vigase väärtuse asukoht. |
| msg |
string |
Kohustuslik. Veateade. |
| type |
string |
Kohustuslik. Vea tüüp. |
| input |
any |
Valideeritud sisendväärtus. |
| ctx |
object |
Valideerimisvea lisateave. |
Vastuse koodid
- 200 – Edukas vastus.
- 204 – Päringule vastavad andmed puuduvad. Vastuse keha puudub.
- 403 – Juurdepääs teenusele on keelatud. OpenAPI ei määra vastuse keha.
- 404 – Ei leitud (CustomValidationError).
- 422 – Päringu valideerimisviga (HTTPValidationError).
Näited
200 – Ettevõtte seos juhatuse liikmega
GET /company/companyRelations?personFirstName=Mari&personSurname=Maasikas&personRoles=JUHL&statuses=R&pageNumber=1&pageSize=100
acceptLanguage: est
{
"total": 1,
"list": [
{
"legalEntityName": "Pilveaia OÜ",
"registryCode": 12345678,
"legalForm": null,
"legalFormSubtype": null,
"status": "R",
"statusAsText": "Registrisse kantud",
"firstEntrydate": "2024-05-15",
"deletionDate": null,
"email": [
{
"type": "EMAIL",
"typeAsText": "Elektronposti aadress",
"content": "[email protected]",
"cardNumber": 1,
"cardType": "R",
"entryNumber": 1,
"recordId": 910001,
"startDate": "2024-05-15",
"endDate": null
}
],
"homepage": [
"https://pilveaed.example"
],
"address": [
{
"address": {
"address": "Pilveaia tee 1",
"postalCode": "10111"
},
"cardNumber": 1,
"cardType": "R",
"entryNumber": 1,
"recordId": 910002,
"startDate": "2024-05-15",
"endDate": null
}
],
"searchRelatedPersons": [
{
"role": "JUHL",
"roleAsText": "Juhatuse liige",
"startDate": "2024-05-15",
"endDate": null,
"type": "F",
"firstName": "Mari",
"surnameLegalEntityName": "Maasikas",
"identityCode": "48503151233",
"birthday": "1985-03-15",
"foreignCode": null,
"foreignCodeCountry": null,
"foreignCodeCountryAsText": null,
"share": null
}
]
}
]
}
404 – Veavastuse näide
Näide illustreerib veavastuse struktuuri; OpenAPI ei täpsusta koodi 4041 tähendust.
{
"message": "Not found",
"code": 4041,
"id": null,
"timestamp": "2024-07-01T10:00:00Z"
}
422 – Valideerimisvea näide
GET /company/companyRelations?pageNumber=0
{
"detail": [
{
"loc": [
"query",
"pageNumber"
],
"msg": "Input should be greater than 0",
"type": "greater_than",
"input": 0,
"ctx": {
"gt": 0
}
}
]
}
Klassifikaatorid
| Kood |
Nimetus |
Liik |
|---|
| A |
Asutaja |
Kandeväline isik |
| AJPH |
Ajutine pankrotihaldur likvideerija ülesannetes |
Kandesse kantud isik |
| AJUTPH |
Ajutine pankrotihaldur |
Kandesse kantud isik |
| ARP |
Aktsiaraamatu pidaja |
Kandesse kantud isik |
| ASES |
Asutuse esindusõiguslik isik |
Kandesse kantud isik |
| B |
Asutaja (sissemakseta) |
Kandeväline isik |
| D |
Audiitorettevõtja |
Kandeväline isik |
| DOKH |
Dokumentide hoidja |
Kandesse kantud isik |
| E |
Nõukogu esimees |
Kandeväline isik |
| ERIH |
Erirežiimihaldur |
Kandesse kantud isik |
| ESIS2 |
Esindama õigustatud isik |
Kandesse kantud isik |
| EUSOS2 |
Esindama volitatud usaldusosanik |
Kandesse kantud isik |
| FIE |
Füüsilisest isikust ettevõtja |
Kandesse kantud isik |
| FV |
Fondivalitseja |
Kandesse kantud isik |
| H |
Hooneühistu liige |
Kandeväline isik |
| HNKL |
Haldusnõukogu liige |
Kandesse kantud isik |
| HUL |
Hooneühistu liige |
Kandesse kantud isik |
| J |
Revident |
Kandeväline isik |
| JPNKR |
Järelevalveõiguslik pankrotihaldur |
Kandesse kantud isik |
| JUHL |
Juhatuse liige |
Kandesse kantud isik |
| K |
Kohaliku omavalitsuse liidu liige |
Kandeväline isik |
| KISIK |
Kontaktisik |
Kandesse kantud isik |
| KOAS |
Kõrgemalseisev asutus |
Kandesse kantud isik |
| L |
Liikmeskogudus |
Kandeväline isik |
| LIKV |
Likvideerija |
Kandesse kantud isik |
| LIKVJ |
Juhatuse liikmest likvideerija |
Kandesse kantud isik |
| M |
Mitterahalist sissemakset hinnanud audiitor |
Kandeväline isik |
| MDKPI |
Menetlusdokumentide kättesaamiseks pädev isik |
Kandesse kantud isik |
| MORAH |
Moratooriumihaldur |
Kandesse kantud isik |
| N |
Nõukogu liige |
Kandeväline isik |
| O |
Osanik |
Kandeväline isik |
| ORP |
Osade registripidaja |
Kandesse kantud isik |
| OSAN |
Osanik |
Kandesse kantud isik |
| P |
Pankrotitoimkonna liige |
Kandeväline isik |
| PANKR |
Pankrotihaldur |
Kandesse kantud isik |
| PANTP |
Pandipidaja |
Kandesse kantud isik |
| PROK |
Prokurist |
Kandesse kantud isik |
| R |
Revisjonikomisjoni liige |
Kandeväline isik |
| RKL |
Revisjonikomisjoni liige (Registrikaardil) |
Kandesse kantud isik |
| S |
Aktsionär |
Kandeväline isik |
| SJESI |
Äriühingu seadusjärgne esindaja |
Kandesse kantud isik |
| TOSAN |
Täisosanik |
Kandesse kantud isik |
| TVH |
Tagatisvara haldur |
Kandesse kantud isik |
| UOSAN |
Usaldusosanik |
Kandesse kantud isik |
| V |
Volitatud isik |
Kandeväline isik |
| VALIT |
Valitseja |
Kandesse kantud isik |
| VFILJ |
Filiaali juhataja |
Kandesse kantud isik |
| W |
Tegelik kasusaaja |
Kandeväline isik |
| YFI |
Ühendav füüsiline isik |
Kandesse kantud isik |
| YHL |
Ühistu liige |
Kandesse kantud isik |
| YHLLV |
Lisavastutusega ühistu liige |
Kandesse kantud isik |
Staatused
Ettevõtja staatused päringu statuses filtris (CompanyStatus) ning vastuse CompanyRequisites.status / statusAsText väljadel.
| Kood |
Nimetus |
|---|
| K |
Kustutatud |
| L |
Likvideerimisel |
| N |
Pankrotis |
| R |
Registrisse kantud |