services.krediidiinfo.ee - User contributions [en]

KiCompany

2020-05-18T13:07:22Z

Madis: /* findCompanies */

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCompany__en|In English]]
|}

= Tutvustus =

KiCompany on SOAP protokollil põhinev Creditinfo AS veebiteenus ettevõtete, mittetulundusühingute ja riigiasutuste põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi firmaotsingu funktsiooni.

= WSDL =

KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. See erineb varasemast WSDL-ist selle poolest, et ''RPC/encode'' asemel kasutatakse ''RPC/litteral''-i.

= Testimine =

Lühidalt on KiCompany testpäringute sooritamiseks vaja vastavat õigust ning päringu URL'i tuleb lisada "debug" parameeter (https://services.krediidiinfo.ee/soap.php?name=KiCompany -> https://services.krediidiinfo.ee/soap.php?name=KiCompany&debug). Testimise kohta rohkem ja detailsemat infot leiab http://services.krediidiinfo.ee/wiki/index.php/Veebiteenuste_silumine lehelt.

= Meetodid =

== getName ==

Ettevõtte nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri, ettevõtte äriregistrikood vigane vms), siis on väljundparameetri väärtuseks tühistring.
|}

== getRegistryName ==

Ettevõtte Äriregistri pika nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri), siis on väljundparameetri väärtuseks tühistring.
| Vigase registrikoodi korral tagastatakse viga -20501 (Invalid registry code value)
|}

== findCompanies ==

Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| name
| xs:string
| Ettevõtte nimi või nime algus. Kui lisada ette % märk, siis otsitakse antud sõne sisalduvust ka ettevõtte nime sees. NB! % märgiga otsing võib olla oluliselt aeglasem.
|-
| 
| count
| xs:int
| Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla. (Meetod ei tagasta korraga rohkem kui 100 ettevõtet)
|-
| Väljundparameeter:
| companies
| ResultCompanyIDDataArray
| Indekseeritud massiiv, mille elementideks on ResultCompanyIDData tüüpi elemendid.
|}

ResultCompanyIDData on kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| name
| xs:string
| Ettevõtte nimi.
|}

== getBasicData ==

Ettevõtte põhiandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyBasicDataType
| Kirje ettevõtte andmetega.
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyBasicDataType tüüpi kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| ettevõtte äriregistri kood
|-
| name
| xs:string
| ettevõtte nimi.
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| legalStreet
| xs:string
| tänava nimi juriidilises aadressis
|-
| legalPostCode
| xs:string
| posti indeksi number juriidilises aadressis
|-
| legalCity
| xs:string
| linnanimi juriidilises aadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|-
| legalForm
| xs:string
| juriidiline vorm
|-
| shareCapital
| xs:int
| osakapitali suurus
|-
| shareCapitalCur
| xs:string
| valuuta tähis, milles on osakapitali suurus antud
|-
| regTime
| xs:string
| ettevõtte registreerimise aeg Äriregistris. Formaat: yyyy-mm-dd
|-
| regPlace
| xs:string
| registriosakonna nimetus kus ettevõte registreeriti
|-
| activities
| xs:string
| ettevõtte tegevusalade loetelu. Iga tegevusala ees on string '* ' (tärn ja tühik). Alates 29.07.2011 on väärtuseks tühistring.
|-
| status
| xs:string
| äriregistri staatuse nimetus
|-
|}

== getContactData ==

Ettevõtte kontaktandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyContactDataType
| kirje kontaktandmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyContactDataType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|}

== getLegalPostAddress ==

Ettevõtte juriidilise aadressi pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyPostAddressType
| kirje juriidilise aadressi andmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyPostAddressType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi
|-
| postCode
| xs:string
| indeks
|-
| city
| xs:string
| linn
|}

== isRegCodeValid ==

Ettevõtte äriregistri korrektsuse kontrollimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| Väljundparameeter:
| isValid
| xs:boolean
| Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige.
|}

== getVATNo ==

Ettevõtte käibemaksukohustuslase numbri pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| vatNo
| xs:string
| KMK number. Kui KMK number ei kehti või ettevõte ei ole käibemaksukohuslane, siis tagastatakse tühistring. Probleemide korral ühendumisel Maksuametiga tagastatakse viga -20502 (Error connecting to Tax Board)
|}

= Veakoodid =

== -10231 No company found! ==

Creditinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.

(vt lisaks [[Veakoodid|üldiseid veakoode]])

= Programmi näidis PHP-s =

Järgnevalt on toodud PHP-s kirjutatud KiCompany veebiteenuse kasutamise näide.

<pre>
<?php
/**
* Example of using KiCompany web service of Creditinfo AS
*
* @author Rait Kapp <rait@creditinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$data = $client->getBasicData($regCode);
echo "Aadress: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
echo "Äriregistri kood {$regCode} on vigane.\n";
} else {
echo "Äriregistri kood {$regCode} on korrektne\n";
}

?>

</pre>

Programmi väljund:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Äriregistri kood 10256137 kuulub ettevõttele CREDITINFO EESTI AS
Aadress: Narva mnt 5 10117 Tallinn
Äriregistri kood 10256136 on vigane.

</pre>

= HTTP päringute näidised =

Failis [http://services.krediidiinfo.ee/wiki/images/e/ed/KiCompany_request_examples.zip kiCompany_request_examples.zip] on KiCompany HTTP päringute ja päringu vastuste näidised. Kui KiCompany integreeritakse süsteemi saates otse HTTP päringuid, siis HTTP vastuse parsimisel kasutada XML vahendeid. Mitte käsitleda HTTP vastuseid kui stringe ja parsida neid nö käsitsi. Kui Creditinfo uuendab SOAP serveri tarkvara, siis võib vastuse sõnumi kuju muutuda.

KiCompany en

2020-05-18T13:06:59Z

Madis: /* findCompanies */

{| align="right"
| [[Image:Flag of Estonia.svg|border|30px]] [[KiCompany|eesti keeles]]
|}

= Introduction =

KiCompany is the name of a Web Service based on SOAP protocol for requesting basic data about companies, non-profit organizations and state agencies. The interface is designed clients who want to integrate the functionality of company request into their own system.

= WSDL =

KiCompany WDSL is located at [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

WSDL for users of Microsoft Development Tools is located at: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. It differs from the previous WSDL in that '''RPC/litteral''' is used instead of '''RPC/encode'''.

= Testing =

In short KiCompany testrequests require the relevant permission and adding "debug" parameter to the URL (https://services.krediidiinfo.ee/soap.php?name=KiCompany -> https://services.krediidiinfo.ee/soap.php?name=KiCompany&debug). More and detailed information about testing can be found on the http://services.krediidiinfo.ee/wiki/index.php/Web_Service_Debugging page.

= Methods =

== getName ==

Requesting company’s name.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| name
| xs:string
| Company’s name. Output value is an empty string if the name is not found (compnay does not exist, error in the registry code etc).
|}

== findCompanies ==

Searching companies by name. The result is an array, which includes companies’ names and registry codes according to the search string.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| name
| xs:string
| Company’s name or the beginning of it. Inserting % at the start will search the existence of that string anywhere in the company's name. NB! Search with % can be considerably slower.
|-
| 
| count
| xs:int
| Maximum number of companies found in the result of the method (The method does not return at once more than 100 companies)
|-
| Output parameter:
| companies
| ResultCompanyIDDataArray
| Indexed array which elements are ResultCompanyIDData array elements.
|}

ResultCompanyIDData is a record with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| regCode
| xs:string
| Company’s registry code
|-
| name
| xs:string
| Company’s name.
|}

== getBasicData ==

Requesting company’s basic data.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| data
| CompanyBasicDataType
| A record with company’s data.
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyBasicDataType record with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| regCode
| xs:string
| Company’s registry code
|-
| name
| xs:string
| Company’s name.
|-
| street
| xs:string
| Street name in postal address (for marketing activities)
|-
| postCode
| xs:string
| Postcode in postal address (for marketing activities)
|-
| city
| xs:string
| Name of the city in postal address (for marketing activities)
|-
| legalStreet
| xs:string
| Street name in legal address
|-
| legalPostCode
| xs:string
| Postcode in legal address
|-
| legalCity
| xs:string
| Name of city in legal address
|-
| phones
| xs:string
| Phone numbers
|-
| faxes
| xs:string
| Fax numbers
|-
| web
| xs:string
| Website URL
|-
| emails
| xs:string
| E-post addresses
|-
| legalForm
| xs:string
| Legal form
|-
| shareCapital
| xs:int
| Amount of share capital
|-
| shareCapitalCur
| xs:string
| Currency of share capital
|-
| regTime
| xs:string
| Company’s registration time in Commercial Register. Format: yyyy-mm-dd
|-
| regPlace
| xs:string
| Name of registration department where company was registered
|-
| activities
| xs:string
| The list of company’s activities. Before every activity there is a string '* ' (asterisk and space). From 7/29/2011 an empty string will be given as a result.
|-
| status
| xs:string
| Status in Commercial Register
|-
|}

== getContactData ==

Requesting company’s contact data.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| company’s registry code.
|-
| Output parameter:
| data
| CompanyContactDataType
| A record with contact data
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyContactDataType record is with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| street
| xs:string
| Street name in postal address (for marketing activities)
|-
| postCode
| xs:string
| Postcode in postal address (for marketing activities)
|-
| city
| xs:string
| Name of the city in postal address (for marketing activities)
|-
| phones
| xs:string
| Phone numbers
|-
| faxes
| xs:string
| Fax numbers
|-
| web
| xs:string
| Website URL
|-
| emails
| xs:string
| E-post addresses
|}

== getLegalPostAddress ==

Requesting company’s legal post address.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| regCode
| xs:string
| company’s registry code.
|-
| Output parameter:
| data
| CompanyPostAddressType
| A record with legal address data
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyPostAddressType record is with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| street
| xs:string
| street name
|-
| postCode
| xs:string
| postcode
|-
| city
| xs:string
| city
|}

== isRegCodeValid ==

Verification of company’s registry code.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code
|-
| Output parameter:
| isValid
| xs:boolean
| True if registry code given with parameter is an eight-digit number and the last check digit is correct.
|}

== getVATNo ==

Requesting company’s VAT number .

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| vatNo
| xs:string
| VAT number. If VAT number is not valid or the company is not VAT pager, an empty string will be given.
|}

= Error codes =

== -10231 No company found! ==

No company found with the registry code given for parameter from Creditinfo’s database. Check the registry code.

(see more [[Veakoodid_en|general error codes]])

= Example in PHP =

Example of using KiCompany web service in PHP.

<pre>
<?php
/**
* Example of using KiCompany web service of Creditinfo Eesti AS
*
* @author Rait Kapp <rait@creditinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Registry code {$regCode} belongs to the company {$name}\n";

$data = $client->getBasicData($regCode);
echo "Address: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // check number is invalid!
if (!$client->isRegCodeValid($regCode)) {
echo "Registry code {$regCode} is incorrect.\n";
} else {
echo "Registry code {$regCode} is correct.\n";
}

?>

</pre>

Program output:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Registry code 10256137 belongs to the company CREDITINFO EESTI AS
Address: Narva mnt 5 10117 Tallinn
Registry code 10256136 is incorrect.

</pre>

KiCompany en

2020-04-24T13:14:11Z

Madis:

{| align="right"
| [[Image:Flag of Estonia.svg|border|30px]] [[KiCompany|eesti keeles]]
|}

= Introduction =

KiCompany is the name of a Web Service based on SOAP protocol for requesting basic data about companies, non-profit organizations and state agencies. The interface is designed clients who want to integrate the functionality of company request into their own system.

= WSDL =

KiCompany WDSL is located at [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

WSDL for users of Microsoft Development Tools is located at: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. It differs from the previous WSDL in that '''RPC/litteral''' is used instead of '''RPC/encode'''.

= Testing =

In short KiCompany testrequests require the relevant permission and adding "debug" parameter to the URL (https://services.krediidiinfo.ee/soap.php?name=KiCompany -> https://services.krediidiinfo.ee/soap.php?name=KiCompany&debug). More and detailed information about testing can be found on the http://services.krediidiinfo.ee/wiki/index.php/Web_Service_Debugging page.

= Methods =

== getName ==

Requesting company’s name.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| name
| xs:string
| Company’s name. Output value is an empty string if the name is not found (compnay does not exist, error in the registry code etc).
|}

== findCompanies ==

Searching companies by name. The result is an array, which includes companies’ names and registry codes according to the search string.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code
|-
| 
| count
| xs:int
| Maximum number of companies found in the result of the method (The method does not return at once more than 100 companies)
|-
| Output parameter:
| companies
| ResultCompanyIDDataArray
| Indexed array which elements are ResultCompanyIDData array elements.
|}

ResultCompanyIDData is a record with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| regCode
| xs:string
| Company’s registry code
|-
| name
| xs:string
| Company’s name.
|}

== getBasicData ==

Requesting company’s basic data.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| data
| CompanyBasicDataType
| A record with company’s data.
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyBasicDataType record with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| regCode
| xs:string
| Company’s registry code
|-
| name
| xs:string
| Company’s name.
|-
| street
| xs:string
| Street name in postal address (for marketing activities)
|-
| postCode
| xs:string
| Postcode in postal address (for marketing activities)
|-
| city
| xs:string
| Name of the city in postal address (for marketing activities)
|-
| legalStreet
| xs:string
| Street name in legal address
|-
| legalPostCode
| xs:string
| Postcode in legal address
|-
| legalCity
| xs:string
| Name of city in legal address
|-
| phones
| xs:string
| Phone numbers
|-
| faxes
| xs:string
| Fax numbers
|-
| web
| xs:string
| Website URL
|-
| emails
| xs:string
| E-post addresses
|-
| legalForm
| xs:string
| Legal form
|-
| shareCapital
| xs:int
| Amount of share capital
|-
| shareCapitalCur
| xs:string
| Currency of share capital
|-
| regTime
| xs:string
| Company’s registration time in Commercial Register. Format: yyyy-mm-dd
|-
| regPlace
| xs:string
| Name of registration department where company was registered
|-
| activities
| xs:string
| The list of company’s activities. Before every activity there is a string '* ' (asterisk and space). From 7/29/2011 an empty string will be given as a result.
|-
| status
| xs:string
| Status in Commercial Register
|-
|}

== getContactData ==

Requesting company’s contact data.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| company’s registry code.
|-
| Output parameter:
| data
| CompanyContactDataType
| A record with contact data
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyContactDataType record is with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| street
| xs:string
| Street name in postal address (for marketing activities)
|-
| postCode
| xs:string
| Postcode in postal address (for marketing activities)
|-
| city
| xs:string
| Name of the city in postal address (for marketing activities)
|-
| phones
| xs:string
| Phone numbers
|-
| faxes
| xs:string
| Fax numbers
|-
| web
| xs:string
| Website URL
|-
| emails
| xs:string
| E-post addresses
|}

== getLegalPostAddress ==

Requesting company’s legal post address.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| regCode
| xs:string
| company’s registry code.
|-
| Output parameter:
| data
| CompanyPostAddressType
| A record with legal address data
|}

If the company according '''regCode''' is not found, the SOAP error message code -10231 will be returned.

CompanyPostAddressType record is with the following structure:

{| style="border-style: solid; border-width: 1px;"
! Name
! Type
! Description
|-
| street
| xs:string
| street name
|-
| postCode
| xs:string
| postcode
|-
| city
| xs:string
| city
|}

== isRegCodeValid ==

Verification of company’s registry code.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code
|-
| Output parameter:
| isValid
| xs:boolean
| True if registry code given with parameter is an eight-digit number and the last check digit is correct.
|}

== getVATNo ==

Requesting company’s VAT number .

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| vatNo
| xs:string
| VAT number. If VAT number is not valid or the company is not VAT pager, an empty string will be given.
|}

= Error codes =

== -10231 No company found! ==

No company found with the registry code given for parameter from Creditinfo’s database. Check the registry code.

(see more [[Veakoodid_en|general error codes]])

= Example in PHP =

Example of using KiCompany web service in PHP.

<pre>
<?php
/**
* Example of using KiCompany web service of Creditinfo Eesti AS
*
* @author Rait Kapp <rait@creditinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Registry code {$regCode} belongs to the company {$name}\n";

$data = $client->getBasicData($regCode);
echo "Address: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // check number is invalid!
if (!$client->isRegCodeValid($regCode)) {
echo "Registry code {$regCode} is incorrect.\n";
} else {
echo "Registry code {$regCode} is correct.\n";
}

?>

</pre>

Program output:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Registry code 10256137 belongs to the company CREDITINFO EESTI AS
Address: Narva mnt 5 10117 Tallinn
Registry code 10256136 is incorrect.

</pre>

KiCompany

2020-04-24T12:58:35Z

Madis: /* Testimine */

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCompany__en|In English]]
|}

= Tutvustus =

KiCompany on SOAP protokollil põhinev Creditinfo AS veebiteenus ettevõtete, mittetulundusühingute ja riigiasutuste põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi firmaotsingu funktsiooni.

= WSDL =

KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. See erineb varasemast WSDL-ist selle poolest, et ''RPC/encode'' asemel kasutatakse ''RPC/litteral''-i.

= Testimine =

Lühidalt on KiCompany testpäringute sooritamiseks vaja vastavat õigust ning päringu URL'i tuleb lisada "debug" parameeter (https://services.krediidiinfo.ee/soap.php?name=KiCompany -> https://services.krediidiinfo.ee/soap.php?name=KiCompany&debug). Testimise kohta rohkem ja detailsemat infot leiab http://services.krediidiinfo.ee/wiki/index.php/Veebiteenuste_silumine lehelt.

= Meetodid =

== getName ==

Ettevõtte nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri, ettevõtte äriregistrikood vigane vms), siis on väljundparameetri väärtuseks tühistring.
|}

== getRegistryName ==

Ettevõtte Äriregistri pika nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri), siis on väljundparameetri väärtuseks tühistring.
| Vigase registrikoodi korral tagastatakse viga -20501 (Invalid registry code value)
|}

== findCompanies ==

Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| name
| xs:string
| Ettevõtte nimi või nime algus
|-
| 
| count
| xs:int
| Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla. (Meetod ei tagasta korraga rohkem kui 100 ettevõtet)
|-
| Väljundparameeter:
| companies
| ResultCompanyIDDataArray
| Indekseeritud massiiv, mille elementideks on ResultCompanyIDData tüüpi elemendid.
|}

ResultCompanyIDData on kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| name
| xs:string
| Ettevõtte nimi.
|}

== getBasicData ==

Ettevõtte põhiandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyBasicDataType
| Kirje ettevõtte andmetega.
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyBasicDataType tüüpi kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| ettevõtte äriregistri kood
|-
| name
| xs:string
| ettevõtte nimi.
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| legalStreet
| xs:string
| tänava nimi juriidilises aadressis
|-
| legalPostCode
| xs:string
| posti indeksi number juriidilises aadressis
|-
| legalCity
| xs:string
| linnanimi juriidilises aadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|-
| legalForm
| xs:string
| juriidiline vorm
|-
| shareCapital
| xs:int
| osakapitali suurus
|-
| shareCapitalCur
| xs:string
| valuuta tähis, milles on osakapitali suurus antud
|-
| regTime
| xs:string
| ettevõtte registreerimise aeg Äriregistris. Formaat: yyyy-mm-dd
|-
| regPlace
| xs:string
| registriosakonna nimetus kus ettevõte registreeriti
|-
| activities
| xs:string
| ettevõtte tegevusalade loetelu. Iga tegevusala ees on string '* ' (tärn ja tühik). Alates 29.07.2011 on väärtuseks tühistring.
|-
| status
| xs:string
| äriregistri staatuse nimetus
|-
|}

== getContactData ==

Ettevõtte kontaktandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyContactDataType
| kirje kontaktandmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyContactDataType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|}

== getLegalPostAddress ==

Ettevõtte juriidilise aadressi pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyPostAddressType
| kirje juriidilise aadressi andmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyPostAddressType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi
|-
| postCode
| xs:string
| indeks
|-
| city
| xs:string
| linn
|}

== isRegCodeValid ==

Ettevõtte äriregistri korrektsuse kontrollimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| Väljundparameeter:
| isValid
| xs:boolean
| Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige.
|}

== getVATNo ==

Ettevõtte käibemaksukohustuslase numbri pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| vatNo
| xs:string
| KMK number. Kui KMK number ei kehti või ettevõte ei ole käibemaksukohuslane, siis tagastatakse tühistring. Probleemide korral ühendumisel Maksuametiga tagastatakse viga -20502 (Error connecting to Tax Board)
|}

= Veakoodid =

== -10231 No company found! ==

Creditinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.

(vt lisaks [[Veakoodid|üldiseid veakoode]])

= Programmi näidis PHP-s =

Järgnevalt on toodud PHP-s kirjutatud KiCompany veebiteenuse kasutamise näide.

<pre>
<?php
/**
* Example of using KiCompany web service of Creditinfo AS
*
* @author Rait Kapp <rait@creditinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$data = $client->getBasicData($regCode);
echo "Aadress: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
echo "Äriregistri kood {$regCode} on vigane.\n";
} else {
echo "Äriregistri kood {$regCode} on korrektne\n";
}

?>

</pre>

Programmi väljund:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Äriregistri kood 10256137 kuulub ettevõttele CREDITINFO EESTI AS
Aadress: Narva mnt 5 10117 Tallinn
Äriregistri kood 10256136 on vigane.

</pre>

= HTTP päringute näidised =

Failis [http://services.krediidiinfo.ee/wiki/images/e/ed/KiCompany_request_examples.zip kiCompany_request_examples.zip] on KiCompany HTTP päringute ja päringu vastuste näidised. Kui KiCompany integreeritakse süsteemi saates otse HTTP päringuid, siis HTTP vastuse parsimisel kasutada XML vahendeid. Mitte käsitleda HTTP vastuseid kui stringe ja parsida neid nö käsitsi. Kui Creditinfo uuendab SOAP serveri tarkvara, siis võib vastuse sõnumi kuju muutuda.

KiCompany

2020-04-24T12:56:25Z

Madis:

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiCompany__en|In English]]
|}

= Tutvustus =

KiCompany on SOAP protokollil põhinev Creditinfo AS veebiteenus ettevõtete, mittetulundusühingute ja riigiasutuste põhiandmete pärimiseks. Liides on mõeldud klientidele, kes soovivad integreerida oma süsteemi firmaotsingu funktsiooni.

= WSDL =

KiCompany WSDL asub aadressil [http://services.krediidiinfo.ee/KiCompany.wsdl http://services.krediidiinfo.ee/KiCompany.wsdl].

Microsofti arendusvahendite kasutajate jaoks on tehtud teine WSDL: [http://services.krediidiinfo.ee/KiCompanyLit.wsdl http://services.krediidiinfo.ee/KiCompanyLit.wsdl]. See erineb varasemast WSDL-ist selle poolest, et ''RPC/encode'' asemel kasutatakse ''RPC/litteral''-i.

= Testimine =

Lühidalt on KiCompany testpäringute sooritamiseks vaja vastavat õigust ning päringu url'i tuleb lisada "debug": https://services.krediidiinfo.ee/soap.php?name=KiCompany -> https://services.krediidiinfo.ee/soap.php?name=KiCompany&debug
Testimise kohta rohkem ja detailsemat infot leiab http://services.krediidiinfo.ee/wiki/index.php/Veebiteenuste_silumine lehelt.

= Meetodid =

== getName ==

Ettevõtte nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri, ettevõtte äriregistrikood vigane vms), siis on väljundparameetri väärtuseks tühistring.
|}

== getRegistryName ==

Ettevõtte Äriregistri pika nime pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| name
| xs:string
| Ettevõtte nimi. Kui ettevõtte nime ei leita (sellise nimega ettevõtet ei eksisteeri), siis on väljundparameetri väärtuseks tühistring.
| Vigase registrikoodi korral tagastatakse viga -20501 (Invalid registry code value)
|}

== findCompanies ==

Ettevõtete otsimine nime järgi. Tulemuseks on massiiv, mis sisaldab otsingustringile sobivate ettevõtete nimesid ja äriregistrikoode.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| name
| xs:string
| Ettevõtte nimi või nime algus
|-
| 
| count
| xs:int
| Leitud ettevõtete maksimaalne arv, mis meetodi tulemuses võib olla. (Meetod ei tagasta korraga rohkem kui 100 ettevõtet)
|-
| Väljundparameeter:
| companies
| ResultCompanyIDDataArray
| Indekseeritud massiiv, mille elementideks on ResultCompanyIDData tüüpi elemendid.
|}

ResultCompanyIDData on kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| name
| xs:string
| Ettevõtte nimi.
|}

== getBasicData ==

Ettevõtte põhiandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyBasicDataType
| Kirje ettevõtte andmetega.
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyBasicDataType tüüpi kirje järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| regCode
| xs:string
| ettevõtte äriregistri kood
|-
| name
| xs:string
| ettevõtte nimi.
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| legalStreet
| xs:string
| tänava nimi juriidilises aadressis
|-
| legalPostCode
| xs:string
| posti indeksi number juriidilises aadressis
|-
| legalCity
| xs:string
| linnanimi juriidilises aadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|-
| legalForm
| xs:string
| juriidiline vorm
|-
| shareCapital
| xs:int
| osakapitali suurus
|-
| shareCapitalCur
| xs:string
| valuuta tähis, milles on osakapitali suurus antud
|-
| regTime
| xs:string
| ettevõtte registreerimise aeg Äriregistris. Formaat: yyyy-mm-dd
|-
| regPlace
| xs:string
| registriosakonna nimetus kus ettevõte registreeriti
|-
| activities
| xs:string
| ettevõtte tegevusalade loetelu. Iga tegevusala ees on string '* ' (tärn ja tühik). Alates 29.07.2011 on väärtuseks tühistring.
|-
| status
| xs:string
| äriregistri staatuse nimetus
|-
|}

== getContactData ==

Ettevõtte kontaktandmete pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyContactDataType
| kirje kontaktandmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyContactDataType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi turunduseks kasutatavas postiaadressis
|-
| postCode
| xs:string
| posti indeksi number turunduseks kasutatavas postiaadressis
|-
| city
| xs:string
| linna nimi turunduseks kasutatavas postiaadressis
|-
| phones
| xs:string
| telefonide numbrid
|-
| faxes
| xs:string
| fakside numbrid
|-
| web
| xs:string
| interneti kodulehekülje URL
|-
| emails
| xs:string
| e-posti aadressid
|}

== getLegalPostAddress ==

Ettevõtte juriidilise aadressi pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| data
| CompanyPostAddressType
| kirje juriidilise aadressi andmetega
|}

Kui ''regCode''-ile vastavat ettevõtet ei leita, siis tagastatakse SOAP veateade koodiga -10231.

CompanyPostAddressType tüüpi kirje on järgmise struktuuriga:

{| style="border-style: solid; border-width: 1px;"
! Nimi
! Tüüp
! Kirjeldus
|-
| street
| xs:string
| tänava nimi
|-
| postCode
| xs:string
| indeks
|-
| city
| xs:string
| linn
|}

== isRegCodeValid ==

Ettevõtte äriregistri korrektsuse kontrollimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood
|-
| Väljundparameeter:
| isValid
| xs:boolean
| Tõene, kui parameetriga ette antud äriregistri kood on kaheksakohaline arv ja viimane kontrollnumber on õige.
|}

== getVATNo ==

Ettevõtte käibemaksukohustuslase numbri pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte äriregistri kood.
|-
| Väljundparameeter:
| vatNo
| xs:string
| KMK number. Kui KMK number ei kehti või ettevõte ei ole käibemaksukohuslane, siis tagastatakse tühistring. Probleemide korral ühendumisel Maksuametiga tagastatakse viga -20502 (Error connecting to Tax Board)
|}

= Veakoodid =

== -10231 No company found! ==

Creditinfo andmebaasist ei leitud parameetriga ette antud registrikoodile vastavat ettevõtet. Kontrollida registrikoodi.

(vt lisaks [[Veakoodid|üldiseid veakoode]])

= Programmi näidis PHP-s =

Järgnevalt on toodud PHP-s kirjutatud KiCompany veebiteenuse kasutamise näide.

<pre>
<?php
/**
* Example of using KiCompany web service of Creditinfo AS
*
* @author Rait Kapp <rait@creditinfo.ee>
* @created 15.02.2011
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCompany.wsdl';
$server_url = 'https://services.krediidiinfo.ee/soap.php?name=KiCompany';

$params = array('location' => $server_url
, 'login' => 'online_code' // Online Code issued by Creditinfo client management. Make sure that login value is string type (PHP bug?).
, 'password' => 'passwd'
// , 'proxy_host' => 'cache.neti.ee' // If necessary use proxy and proxy port.
// , 'proxy_port' => 8080
, 'encoding' => 'ISO-8859-13'
);

$client = new SoapClient($wsdl_url, $params);

$name = 'KREDIIDI';
$companies = $client->findCompanies($name, 3);
print_r($companies);

$regCode = '10256137';
$name = $client->getName($regCode);
echo "Äriregistri kood {$regCode} kuulub ettevõttele {$name}\n";

$data = $client->getBasicData($regCode);
echo "Aadress: {$data->street} {$data->postCode} {$data->city}\n";

$regCode = '10256136'; // kontrollnumber on vale!
if (!$client->isRegCodeValid($regCode)) {
echo "Äriregistri kood {$regCode} on vigane.\n";
} else {
echo "Äriregistri kood {$regCode} on korrektne\n";
}

?>

</pre>

Programmi väljund:

<pre>
Array
(
[0] => stdClass Object
(
[regCode] => 90006012
[name] => KREDIIDI JA EKSPORDI GARANTEERIMISE SIHTASUTUS KREDEX
)

[1] => stdClass Object
(
[regCode] => 10704587
[name] => KREDIIDI JÄRELVALVE OÜ
)

[2] => stdClass Object
(
[regCode] => 11626688
[name] => KREDIIDIBÜROO OÜ
)

)
Äriregistri kood 10256137 kuulub ettevõttele CREDITINFO EESTI AS
Aadress: Narva mnt 5 10117 Tallinn
Äriregistri kood 10256136 on vigane.

</pre>

= HTTP päringute näidised =

Failis [http://services.krediidiinfo.ee/wiki/images/e/ed/KiCompany_request_examples.zip kiCompany_request_examples.zip] on KiCompany HTTP päringute ja päringu vastuste näidised. Kui KiCompany integreeritakse süsteemi saates otse HTTP päringuid, siis HTTP vastuse parsimisel kasutada XML vahendeid. Mitte käsitleda HTTP vastuseid kui stringe ja parsida neid nö käsitsi. Kui Creditinfo uuendab SOAP serveri tarkvara, siis võib vastuse sõnumi kuju muutuda.