services.krediidiinfo.ee - User contributions [en]

Skooringu erilahendus 56064

2019-07-29T11:18:59Z

Julia: /* API dokumentatsioon */

Lehelt leiab Creditinfo Eesti poolt Kaubamaja AS jaoks loodud krediidivõimelisuse hindamise erilahenduse dokumentatisooni.

== API dokumentatsioon ==
API dokumentatsioon on kättesaadav siit: https://documenter.getpostman.com/view/6003560/S1TPZfWf

Skooringu erilahendus 56064

2019-07-29T11:17:41Z

Julia: Created page with "Lehelt leiab Creditinfo Eesti poolt Kaubamaja AS jaoks loodud krediidivõimelisuse hindamise erilahenduse dokumentatisooni. == API dokumentatsioon == API dokumentatsioon on k..."

Main Page

2019-07-25T13:49:57Z

Julia: /* Creditinfo Eesti AS veebiteenused */

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

Lehelt leiate Creditinfo Eesti AS veebiteenuste dokumentatsioonid ja näidised.

= Tutvustus =
* '''Mis on veebiteenus?'''
Veebiteenused (Web Service) on tarkvarakomponendid, mis asuvad serveris ning mille poole kliendiprogrammid pöörduvad üle interneti.

Veebiteenuse looja koostab koos veebiteenusega ka veebiteenuse dokumentatsiooni. Dokumentatsioonis on täpselt ära kirjeldatud veebiteenuse interneti aadress, mis andmevahetusprotokolle peab kasutama, millised on liidese meetodite nimed, millised on sisend- ja väljundparameetrite tüübid. Veebiteenuse kirjeldamiseks kasutatakse XML-põhist WSDL (Web Services Description Language) keelt.

Veebiteenused on sõltumatud kasutatavast platvormist. Veebiteenus võib ise töötada Linux operatsioonisüsteemiga serveris, kliendiprogramm seevastu Win32 operatsioonisüsteemiga lauaarvutis. Ühte veebiteenust on võimalik integreerida ükskõik millisesse arvutisse eeldusel, et on olemas internetiühendus.

Tänapäeval on kõrgtaseme tarkvaraarenduskeskkondadesse loodud tööriistad veebiteenuste lihtsaks integreerimiseks. WSDL kirjelduse põhjal suudavad arenduskeskkonnad genereerida programmeerija jaoks vajalikud teegid programmeerija poolt kasutatavas programmeerimiskeeles. Sisuliselt ei erine tarkvaraarendaja jaoks veebiteenuse väljakutsumine tavalisest funktsiooni väljakutsumisest. Kogu andmevahetuse ja tüübiteisenduste loogika on tarkvaraarendaja eest peidetud.

= Creditinfo Eesti AS veebiteenused =
* [[KiReport|XML raportite pärimine]]
* [[KiReportExt|Lisaandmete saatmisega XML raportite pärimine]]
* [[Kireport.php|PDF ja HTML raportite pärimine]]
* [[KiDocExchange]]
* [[KiCompany]]
* [[KiCreditRiskManagement]]

= Arendajatele =
* [[Creditinfo veebiteenuste arhitektuur]]
* [[Autentimine]]
* [[Veebiteenuste silumine]]- Serveri testimine, raportite testimine testkeskkonnas
* [[Veatöötlus]]
* [[Veakoodid]]
* [[SOAP teenuse testimine]]
* [[Tehniline tugi]]
* Kasutatavad standardid/protokollid
** [http://www.w3schools.com/xml/default.asp XML]
** [http://www.w3schools.com/schema/default.asp XML Schema]
** [http://www.w3schools.com/soap/default.asp SOAP]
** [http://www.w3schools.com/wsdl/default.asp WSDL]

File:KiCompany request examples.zip

2018-12-20T14:30:18Z

Julia: Julia uploaded a new version of File:KiCompany request examples.zip

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-12-12T15:06:45Z

Julia: /* Formaat bank_debtors_payments_ver4 */

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-12-12T15:06:35Z

Julia: /* Formaat debtors_info_ver4 */

KiCreditRiskManagement en

2018-11-26T16:06:57Z

Julia: /* getEvents */

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

= Introduction =

KiCreditRiskManagement is the name of a Credit Risk Management Web Service based on SOAP protocol. The service - [http://www.krediidiinfo.ee/index.php?m=49 http://www.krediidiinfo.ee/index.php?m=49]

= WSDL =

KiCreditRiskManagement WSDL is located at [http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl].

= Methods =

== ''start'' ==

Adding company into Credit Risk Management.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| resultCode
| xs:int
| The value is 0, if the request succeeds. If the value is negative, then it is an error code. Possible values of [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement_en#Error_Codes error codes].
|}

== ''end'' ==

Ending company's credit risk management.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Company’s registry code.
|-
| Output parameter:
| resultCode
| xs:int
| The value is 0, if the request succeeds. If the value is negative, then it is an error code. Possible values of [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement_en#Error_Codes error codes].
|}

== ''getCreditRiskData'' ==

Requesting company's basic data and events.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Output parameter:
| xml
| xs:string
| Response in XML format. XML schema is located at [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd]. See an example: [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xml KiCreditRiskManagement__getCreditRiskData.xml]. An empty tag ''company'' will be given in XML, if the requested company does not exist in the credit management database
|}

== ''getEvents'' ==

Requesting events in certain period of time (max 30 days).

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| begin
| xs:date
| Start date (incl), from which the events are requested.
|-
|
| end
| xs:date
| End date (incl), until the events are requested.
|-
| Output parameter:
| xml
| xs:string
| Response in XML format. XML schema is located at [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd]. See an example: [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xml KiCreditRiskManagement__getEvents.xml].
|}

= Error codes =

== -20400 UNKNOWN ==

Unknown error

== -20401 INVALID_REGCODE ==

Invalid registry code

== -20402 SERVICE_ALREADY_ACTIVE ==

The company is already in credit risk management.

== -20403 SERVICE_INACTIVE ==

The company is not in credit risk management.

== -20404 LONG_PERIOD ==

Requested period of time is too long.

= Developing =

Sample user is made for integrating the service:

* Method of authentication: ''Basic Authentication''
* Username: ''30546''
* Password: ''soapdemo''

= Example in PHP =

<pre>
<?php
/**
* Example of using Creditinfo Eesti AS SOAP interface KiCreditRiskManagement.
*
* In this example the demo username and password is used so there is no need
* to contact with Creditinfo Eesti AS in order to run this program.
*
* @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement
* @author Julia Parkkonen <julia.parkkonen@creditinfo.ee>
* @created 04.06.2013
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl';
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement'
, 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?).
, 'password' => 'soapdemo' // <-- password
);

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

$regCode = '10256137';
$resultCode = $client->start($regCode);
if ($resultCode == 0) {
echo "Company is added into credit risk management!";
}

$xml = $client->getCreditRiskData($regCode);
echo $xml;

$resultCode = $client->end($regCode);
if ($resultCode == 0) {
echo "Company's credit risk management is ended!";
}

$xml = $client->getEvents('2013-01-01', '2013-01-07');
echo $xml;
?>

</pre>

KiCreditRiskManagement

2018-11-26T16:06:41Z

Julia: /* getEvents */

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

= Tutvustus =

KiCreditRiskManagement on Creditinfo SOAP protokollil põhinev krediiriskide halduse veebiteenus. Teenuse sisu - [http://www.krediidiinfo.ee/index.php?m=49 http://www.krediidiinfo.ee/index.php?m=49]

= WSDL =

KiCreditRiskManagement WSDL asub aadresslil [http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl].

= Meetodid =

== ''start'' ==

Ettevõtte lisamine krediidiriskide jälgimise alla.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| resultCode
| xs:int
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin].
|}

== ''end'' ==

Ettevõtte krediidiriskide jälgimise lõpetamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| resultCode
| xs:int
| kui päring õnnestub, siis on väärtuseks 0. Kui väärtus on negatiivne, siis on tegemist vea koodiga. Veakoodi võimalikud väärtused [http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement#Veakoodid siin].
|}

== ''getCreditRiskData'' ==

Ettevõtte krediidiriskide põhiandmete ja sündmuste pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| regCode
| xs:string
| Ettevõtte registrikood.
|-
| Väljundparameeter:
| xml
| xs:string
| vastus XML formaadis. XML skeem asub aadressil [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xsd]. Vaata näidisfaili: [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getCreditRiskData.xml KiCreditRiskManagement__getCreditRiskData.xml]. Kui päritav ettevõte ei ole krediidiriskide jälgimise all, siis on päringu tulemuseks saadav XML-is märgendi ''company'' sisu tühi!
|}

== ''getEvents'' ==

Etteantud ajavahemikus (maksimaalselt 30 päeva) toimunud sündmuste pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| begin
| xs:date
| Alguskuupäev (ka), millest alates toimunud sündmusi soovitakse pärida.
|-
|
| end
| xs:date
| Lõpukuupäev (ka), milleni toimunud sündmusi soovitakse pärida.
|-
| Väljundparameeter:
| xml
| xs:string
| vastus XML formaadis. XML skeem asub aadressil [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xsd]. Vaata näidisfaili: [http://www.krediidiinfo.ee/schemas/services/KiCreditRiskManagement__getEvents.xml KiCreditRiskManagement__getEvents.xml].
|}

= Veakoodid =

== -20400 UNKNOWN ==

Tundmatu viga

== -20401 INVALID_REGCODE ==

Vigane ettevõtte registrikood

== -20402 SERVICE_ALREADY_ACTIVE ==

Ettevõte on juba krediidiriskide jälgimise all.

== -20403 SERVICE_INACTIVE ==

Ettevõte ei ole krediidiriskide jälgimise all.

== -20404 LONG_PERIOD ==

Liiga pikk ajavahemik, milles registreeritud andmeid soovitakse pärida.

= Arendamine =

Liidese integreerimiseks vajaliku arenduse jaoks on tehtud näidiskasutaja:

* Autentimise meetod: ''Basic Authentication''
* Kasutajanimi: ''30546''
* Parool: ''soapdemo''

= Näide PHP-s =

<pre>
<?php
/**
* Example of using Creditinfo Eesti AS SOAP interface KiCreditRiskManagement.
*
* In this example the demo username and password is used so there is no need
* to contact with Creditinfo Eesti AS in order to run this program.
*
* @link http://services.krediidiinfo.ee/wiki/index.php/KiCreditRiskManagement
* @author Julia Parkkonen <julia.parkkonen@creditinfo.ee>
* @created 04.06.2013
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiCreditRiskManagement.wsdl';
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiCreditRiskManagement'
, 'login' => '30546' // <-- username. Make sure username is string type (PHP bug?).
, 'password' => 'soapdemo' // <-- password
);

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

$regCode = '10256137';
$resultCode = $client->start($regCode);
if ($resultCode == 0) {
echo "Ettevõte lisatud krediidiriskide jälgimise alla!";
}

$xml = $client->getCreditRiskData($regCode);
echo $xml;

$resultCode = $client->end($regCode);
if ($resultCode == 0) {
echo "Ettevõte krediidiriskide jälgimine on lõpetatud!";
}

$xml = $client->getEvents('2013-01-01', '2013-01-07');
echo $xml;
?>

</pre>

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-09-13T10:25:20Z

Julia:

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info_ver2'' =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML skeem]
* [[debtors_info_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info ver2.png | debtors info ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver3'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver3'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML skeem]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ci.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ci_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

Mhrlisamine en

2018-09-13T10:24:33Z

Julia:

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

= Introduction =

Payment defaults can be updated by means of Creditinfo’s credit management service. To do that, Sale Ledger statements should be regularly sent to credit management, and an individual agreement as to when they should be sent is made with each customer.

You can send the Sales Ledger to credit management as an XML file of the format specified by the following schema: [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! A separate XML schema has been created for banks: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd]

= Principles of synchronising the credit management data =

Only the information about outstanding payments needs to be sent to credit management. The overall receivables balance is what shows the debtor’s balance, and the debt age can be deduced from the payments. These are the key data on which credit management relies. The paid invoices do not affect the balance, so they are of no significance for credit management.

Depending on the type of credit management services the debtor data you send to credit management can be additionally restricted to the debt age. For example, if your agreement with credit management specifies that only the service of updating the information in the Credit register is used, you can only send credit management the information about the debtors whose payments have been outstanding for over 45 days. Credit management does not need the data about the debtors whose debt is not over 45 days old. As the data to be sent is restricted, the size of the file and the time it will take to import the data will be reduced.

When the data is imported to credit management, the balances of the debtor’s payments in the database are updated. The payments that were outstanding before the data import are considered to have been paid and the balance is set to zero if the input file contains no information about them. Thus you do not need to inform credit management that an invoice has been paid. You just need to export a statement about the current outstanding payments, including advance payments for the overall receivables balance to be calculated correctly. This approach is easier for the customer (who does not need to remember anything from the previous data export), and the latest input file always corrects all the data in credit management (the data do not go out of sync).

= The ''debtors_info_ver2'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML schema]
* [[debtors_info_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Debtors info ver2.png | debtors info ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

The ''/debtors/debtor/additional_data'' tag value with the ''additional_data_name="contract_no"'' attribute is used to add a payment default to the Credit register. The Credit Register also requires the number of the contract that was breached by the outstanding payment to be entered.

If the amounts are stated in euros, the sums referring to the period before the moment the euro came into use will be replaced by Estonian kroons at the rate of 15.6466 kroons to euro. If amounts are still sent in Estonian kroons after the change to the euro, kroons will be substituted with euros at the same rate, so the customer can choose when to start sending the data in euros.

= The ''bank_debtors_payments_ver3'' format =

This format is meant to be used by banks to forward data to credit management. The difference between ''bank_debtors_payments_ver3'' and ''debtors_info'' lies in the fact that the former is not based on invoices.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML schema]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - sample debtor data file. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - diagram of the structure of the XML file containing debtors’ data.

If the currency rate is not set in attributes of the ''/debtors/debtor/overdue_payments'' tag, the rate of 15.6466 kroons to euro is used and currency conversions are performed if necessary.

= Forwarding the files =

Files can be sent to Creditinfo by means of the [[KiDocExchange]] SOAP interface.

The format of the name of the file to be sent to Creditinfo must be the following:

<pre>
<initials>_krediidihaldus_<id>.<extension>
</pre>

* <initials> - the initials of the company, for example, ki for Creditinfo. ki.
* <id> - the unique ID of the file in the sender’s system by which the sent file can be identified, for example, the time when the file was generated.
* <extension> - the extension of the file to be sent (XML or ZIP). We recommend compressing the files to be sent.

Example 1: a file to be sent to Creditinfo Eesti AS

<pre>
ki_krediidihaldus_20100613.zip
</pre>

Mhrlisamine en

2018-09-13T10:23:15Z

Julia:

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

= Introduction =

Payment defaults can be updated by means of Creditinfo’s credit management service. To do that, Sale Ledger statements should be regularly sent to credit management, and an individual agreement as to when they should be sent is made with each customer.

You can send the Sales Ledger to credit management as an XML file of the format specified by the following schema: [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! A separate XML schema has been created for banks: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd]

= Principles of synchronising the credit management data =

Only the information about outstanding payments needs to be sent to credit management. The overall receivables balance is what shows the debtor’s balance, and the debt age can be deduced from the payments. These are the key data on which credit management relies. The paid invoices do not affect the balance, so they are of no significance for credit management.

Depending on the type of credit management services the debtor data you send to credit management can be additionally restricted to the debt age. For example, if your agreement with credit management specifies that only the service of updating the information in the Credit register is used, you can only send credit management the information about the debtors whose payments have been outstanding for over 45 days. Credit management does not need the data about the debtors whose debt is not over 45 days old. As the data to be sent is restricted, the size of the file and the time it will take to import the data will be reduced.

When the data is imported to credit management, the balances of the debtor’s payments in the database are updated. The payments that were outstanding before the data import are considered to have been paid and the balance is set to zero if the input file contains no information about them. Thus you do not need to inform credit management that an invoice has been paid. You just need to export a statement about the current outstanding payments, including advance payments for the overall receivables balance to be calculated correctly. This approach is easier for the customer (who does not need to remember anything from the previous data export), and the latest input file always corrects all the data in credit management (the data do not go out of sync).

= The ''debtors_info_ver2'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML schema]
* [[debtors_info_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Debtors info ver2.png | debtors info ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

The ''/debtors/debtor/additional_data'' tag value with the ''additional_data_name="contract_no"'' attribute is used to add a payment default to the Credit register. The Credit Register also requires the number of the contract that was breached by the outstanding payment to be entered.

If the amounts are stated in euros, the sums referring to the period before the moment the euro came into use will be replaced by Estonian kroons at the rate of 15.6466 kroons to euro. If amounts are still sent in Estonian kroons after the change to the euro, kroons will be substituted with euros at the same rate, so the customer can choose when to start sending the data in euros.

= The ''bank_debtors_payments_ver3'' format =

This format is meant to be used by banks to forward data to credit management. The difference between ''bank_debtors_payments_ver3'' and ''debtors_info'' lies in the fact that the former is not based on invoices.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML schema]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - sample debtor data file. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - diagram of the structure of the XML file containing debtors’ data.

If the currency rate is not set in attributes of the ''/debtors/debtor/overdue_payments'' tag, the rate of 15.6466 kroons to euro is used and currency conversions are performed if necessary.

= Forwarding the files =

Files can be sent to Creditinfo by means of the [[KiDocExchange]] SOAP interface.

The format of the name of the file to be sent to Creditinfo must be the following:

<pre>
<initials>_krediidihaldus_<id>.<extension>
</pre>

* <initials> - the initials of the company, for example, ki for Creditinfo. ki.
* <id> - the unique ID of the file in the sender’s system by which the sent file can be identified, for example, the time when the file was generated.
* <extension> - the extension of the file to be sent (XML or ZIP). We recommend compressing the files to be sent.

Example 1: a file to be sent to Creditinfo Eesti AS

<pre>
ki_krediidihaldus_20100613.zip
</pre>

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse.

2018-09-13T10:12:36Z

Julia: Julia moved page Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse. to Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

#REDIRECT [[Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse]]

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-09-13T10:12:35Z

Julia: Julia moved page Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse. to Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info_ver2'' =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML skeem]
* [[debtors_info_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info ver2.png | debtors info ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver3'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver3'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML skeem]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ci.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ci_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

File:Bank debtors payments ver3.png

2018-07-16T06:48:01Z

Julia: Julia uploaded a new version of File:Bank debtors payments ver3.png

Bank debtors payments ver3 mhr example.xml

2018-07-16T06:47:39Z

Julia:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd" generated="2015-01-01">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<contract_no>123</contract_no>
<client_code>456</client_code>
<id>00000000</id>
<client_class>A</client_class>
<mail_address>
<street>Kuusiku 10-2</street>
<ship_code>10001</ship_code>
<city>Nuustaku</city>
<country/>
</mail_address>
<email>ohk@pohk.ee</email>
<fax>609233423</fax>
<phone>2349082</phone>
<client_manager>Jaan Jalgratas</client_manager>
<overdue_payments>
<overdue_payment pay_due="2015-01-10" currency="EUR" exchange_rate="1" exchange_rate_to="EUR">
<primary_debt>100.23</primary_debt>
<interest>4.77</interest>
<fine xsi:nil="true"/>
</overdue_payment>
<overdue_payment pay_due="2014-12-10" currency="EUR" exchange_rate="1" exchange_rate_to="EUR">
<primary_debt>100.23</primary_debt>
<interest>4.77</interest>
<fine xsi:nil="true"/>
</overdue_payment>
</overdue_payments>
<additional_info>
<data name="client_manager_comment">15.11.2014 promised to pay in two days</data>
</additional_info>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<contract_no>321</contract_no>
<client_code>654</client_code>
<id>00000000</id>
<overdue_payments/>
<payment_default_ending>
<end_date>2018-01-01</end_date>
<is_debt_assigned assignee_country_code="EST" assignee_id="00000000" assignee_name="Inkasso AS">true</is_debt_assigned>
</payment_default_ending>
</debtor>
</debtors>
</pre>

File:Debtors info ver2.png

2018-07-16T06:46:56Z

Julia: Julia uploaded a new version of File:Debtors info ver2.png

Debtors info ver2 mhr example.xml

2018-07-16T06:46:01Z

Julia:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns="http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" generated="2015-01-01">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<client_code>123</client_code>
<id>00000000</id>
<client_class>VIP</client_class>
<mail_address>
<street>Kuusiku 10-2</street>
<ship_code>10001</ship_code>
<city>Nuustaku</city>
<country/>
</mail_address>
<email>ohk@pohk.ee</email>
<fax>609233423</fax>
<phone>2349082</phone>
<client_manager>Jaan Jalgratas</client_manager>
<invoices>
<invoice>
<invoice_date>2007-01-01</invoice_date>
<invoice_no>A-003231</invoice_no>
<payment_term>2007-01-08</payment_term>
<final_sum>3092.23</final_sum>
<unpaid_sum>1000.23</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about invoice</add_inv_data>
</invoice>
<invoice>
<invoice_date>2010-03-01</invoice_date>
<invoice_no>23422</invoice_no>
<payment_term>2010-03-14</payment_term>
<final_sum>-1000.0</final_sum>
<unpaid_sum>-1000.0</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about creditinvoice</add_inv_data>
</invoice>
</invoices>
<additional_data additional_data_name="client_manager_comment">02.09.2007 promised to pay in two days</additional_data>
<additional_data additional_data_name="contract_no">984932342</additional_data>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<client_code>321</client_code>
<id>00000000000</id>
<invoices/>
<payment_default_ending>
<end_date>2018-01-01</end_date>
<is_debt_assigned assignee_country_code="EST" assignee_id="00000000" assignee_name="Inkasso AS">true</is_debt_assigned>
</payment_default_ending>
</debtor>
</debtors>
</pre>

Debtors info ver2 mhr example.xml

2018-07-16T06:44:47Z

Julia:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns="http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" generated="2015-01-01">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<client_code>123</client_code>
<id>00000000</id>
<client_class>VIP</client_class>
<mail_address>
<street>Kuusiku 10-2</street>
<ship_code>10001</ship_code>
<city>Nuustaku</city>
<country/>
</mail_address>
<email>ohk@pohk.ee</email>
<fax>609233423</fax>
<phone>2349082</phone>
<client_manager>Jaan Jalgratas</client_manager>
<invoices>
<invoice>
<invoice_date>2007-01-01</invoice_date>
<invoice_no>A-003231</invoice_no>
<payment_term>2007-01-08</payment_term>
<final_sum>3092.23</final_sum>
<unpaid_sum>1000.23</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about invoice</add_inv_data>
</invoice>
<invoice>
<invoice_date>2010-03-01</invoice_date>
<invoice_no>23422</invoice_no>
<payment_term>2010-03-14</payment_term>
<final_sum>-1000.0</final_sum>
<unpaid_sum>-1000.0</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about creditinvoice</add_inv_data>
</invoice>
</invoices>
<additional_data additional_data_name="client_manager_comment">02.09.2007 promised to pay in two days</additional_data>
<additional_data additional_data_name="contract_no">984932342</additional_data>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<client_code>321</client_code>
<id>00000000000</id>
<invoices/>
<payment_default_ending>
<end_date>2018-01-01</end_date>
<is_debt_assigned aassignee_country_code="EST" assignee_id="00000000" assignee_name="Inkasso AS">true</is_debt_assigned>
</payment_default_ending>
</debtor>
</debtors>
</pre>

Mhrlisamine en

2018-07-10T12:03:17Z

Julia: /* The bank_debtors_payments_ver2 format */

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

= Introduction =

Payment defaults can be updated by means of Creditinfo’s credit management service. To do that, Sale Ledger statements should be regularly sent to credit management, and an individual agreement as to when they should be sent is made with each customer.

You can send the Sales Ledger to credit management as an XML file of the format specified by the following schema: [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! A separate XML schema has been created for banks: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Principles of synchronising the credit management data =

Only the information about outstanding payments needs to be sent to credit management. The overall receivables balance is what shows the debtor’s balance, and the debt age can be deduced from the payments. These are the key data on which credit management relies. The paid invoices do not affect the balance, so they are of no significance for credit management.

Depending on the type of credit management services the debtor data you send to credit management can be additionally restricted to the debt age. For example, if your agreement with credit management specifies that only the service of updating the information in the Credit register is used, you can only send credit management the information about the debtors whose payments have been outstanding for over 45 days. Credit management does not need the data about the debtors whose debt is not over 45 days old. As the data to be sent is restricted, the size of the file and the time it will take to import the data will be reduced.

When the data is imported to credit management, the balances of the debtor’s payments in the database are updated. The payments that were outstanding before the data import are considered to have been paid and the balance is set to zero if the input file contains no information about them. Thus you do not need to inform credit management that an invoice has been paid. You just need to export a statement about the current outstanding payments, including advance payments for the overall receivables balance to be calculated correctly. This approach is easier for the customer (who does not need to remember anything from the previous data export), and the latest input file always corrects all the data in credit management (the data do not go out of sync).

= The ''debtors_info_ver2'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML schema]
* [[debtors_info_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Debtors info ver2.png | debtors info ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

The ''/debtors/debtor/additional_data'' tag value with the ''additional_data_name="contract_no"'' attribute is used to add a payment default to the Credit register. The Credit Register also requires the number of the contract that was breached by the outstanding payment to be entered.

If the amounts are stated in euros, the sums referring to the period before the moment the euro came into use will be replaced by Estonian kroons at the rate of 15.6466 kroons to euro. If amounts are still sent in Estonian kroons after the change to the euro, kroons will be substituted with euros at the same rate, so the customer can choose when to start sending the data in euros.

= The ''bank_debtors_payments_ver3'' format =

This format is meant to be used by banks to forward data to credit management. The difference between ''bank_debtors_payments_ver2'' and ''debtors_info'' lies in the fact that the former is not based on invoices.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML schema]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - sample debtor data file. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - diagram of the structure of the XML file containing debtors’ data.

If the currency rate is not set in attributes of the ''/debtors/debtor/overdue_payments'' tag, the rate of 15.6466 kroons to euro is used and currency conversions are performed if necessary.

= Forwarding the files =

Files can be sent to Creditinfo by means of the [[KiDocExchange]] SOAP interface.

The format of the name of the file to be sent to Creditinfo must be the following:

<pre>
<initials>_krediidihaldus_<id>.<extension>
</pre>

* <initials> - the initials of the company, for example, ki for Creditinfo. ki.
* <id> - the unique ID of the file in the sender’s system by which the sent file can be identified, for example, the time when the file was generated.
* <extension> - the extension of the file to be sent (XML or ZIP). We recommend compressing the files to be sent.

Example 1: a file to be sent to Creditinfo Eesti AS

<pre>
ki_krediidihaldus_20100613.zip
</pre>

Mhrlisamine en

2018-07-10T12:03:05Z

Julia: /* The bank_debtors_payments_ver2 format */

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

= Introduction =

Payment defaults can be updated by means of Creditinfo’s credit management service. To do that, Sale Ledger statements should be regularly sent to credit management, and an individual agreement as to when they should be sent is made with each customer.

You can send the Sales Ledger to credit management as an XML file of the format specified by the following schema: [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! A separate XML schema has been created for banks: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Principles of synchronising the credit management data =

Only the information about outstanding payments needs to be sent to credit management. The overall receivables balance is what shows the debtor’s balance, and the debt age can be deduced from the payments. These are the key data on which credit management relies. The paid invoices do not affect the balance, so they are of no significance for credit management.

Depending on the type of credit management services the debtor data you send to credit management can be additionally restricted to the debt age. For example, if your agreement with credit management specifies that only the service of updating the information in the Credit register is used, you can only send credit management the information about the debtors whose payments have been outstanding for over 45 days. Credit management does not need the data about the debtors whose debt is not over 45 days old. As the data to be sent is restricted, the size of the file and the time it will take to import the data will be reduced.

When the data is imported to credit management, the balances of the debtor’s payments in the database are updated. The payments that were outstanding before the data import are considered to have been paid and the balance is set to zero if the input file contains no information about them. Thus you do not need to inform credit management that an invoice has been paid. You just need to export a statement about the current outstanding payments, including advance payments for the overall receivables balance to be calculated correctly. This approach is easier for the customer (who does not need to remember anything from the previous data export), and the latest input file always corrects all the data in credit management (the data do not go out of sync).

= The ''debtors_info_ver2'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML schema]
* [[debtors_info_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Debtors info ver2.png | debtors info ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

The ''/debtors/debtor/additional_data'' tag value with the ''additional_data_name="contract_no"'' attribute is used to add a payment default to the Credit register. The Credit Register also requires the number of the contract that was breached by the outstanding payment to be entered.

If the amounts are stated in euros, the sums referring to the period before the moment the euro came into use will be replaced by Estonian kroons at the rate of 15.6466 kroons to euro. If amounts are still sent in Estonian kroons after the change to the euro, kroons will be substituted with euros at the same rate, so the customer can choose when to start sending the data in euros.

= The ''bank_debtors_payments_ver2'' format =

This format is meant to be used by banks to forward data to credit management. The difference between ''bank_debtors_payments_ver2'' and ''debtors_info'' lies in the fact that the former is not based on invoices.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML schema]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - sample debtor data file. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - diagram of the structure of the XML file containing debtors’ data.

If the currency rate is not set in attributes of the ''/debtors/debtor/overdue_payments'' tag, the rate of 15.6466 kroons to euro is used and currency conversions are performed if necessary.

= Forwarding the files =

Files can be sent to Creditinfo by means of the [[KiDocExchange]] SOAP interface.

The format of the name of the file to be sent to Creditinfo must be the following:

<pre>
<initials>_krediidihaldus_<id>.<extension>
</pre>

* <initials> - the initials of the company, for example, ki for Creditinfo. ki.
* <id> - the unique ID of the file in the sender’s system by which the sent file can be identified, for example, the time when the file was generated.
* <extension> - the extension of the file to be sent (XML or ZIP). We recommend compressing the files to be sent.

Example 1: a file to be sent to Creditinfo Eesti AS

<pre>
ki_krediidihaldus_20100613.zip
</pre>

Mhrlisamine en

2018-07-10T12:01:49Z

Julia: /* The debtors_info format */

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

= Introduction =

Payment defaults can be updated by means of Creditinfo’s credit management service. To do that, Sale Ledger statements should be regularly sent to credit management, and an individual agreement as to when they should be sent is made with each customer.

You can send the Sales Ledger to credit management as an XML file of the format specified by the following schema: [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! A separate XML schema has been created for banks: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Principles of synchronising the credit management data =

Only the information about outstanding payments needs to be sent to credit management. The overall receivables balance is what shows the debtor’s balance, and the debt age can be deduced from the payments. These are the key data on which credit management relies. The paid invoices do not affect the balance, so they are of no significance for credit management.

Depending on the type of credit management services the debtor data you send to credit management can be additionally restricted to the debt age. For example, if your agreement with credit management specifies that only the service of updating the information in the Credit register is used, you can only send credit management the information about the debtors whose payments have been outstanding for over 45 days. Credit management does not need the data about the debtors whose debt is not over 45 days old. As the data to be sent is restricted, the size of the file and the time it will take to import the data will be reduced.

When the data is imported to credit management, the balances of the debtor’s payments in the database are updated. The payments that were outstanding before the data import are considered to have been paid and the balance is set to zero if the input file contains no information about them. Thus you do not need to inform credit management that an invoice has been paid. You just need to export a statement about the current outstanding payments, including advance payments for the overall receivables balance to be calculated correctly. This approach is easier for the customer (who does not need to remember anything from the previous data export), and the latest input file always corrects all the data in credit management (the data do not go out of sync).

= The ''debtors_info_ver2'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML schema]
* [[debtors_info_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Debtors info ver2.png | debtors info ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

The ''/debtors/debtor/additional_data'' tag value with the ''additional_data_name="contract_no"'' attribute is used to add a payment default to the Credit register. The Credit Register also requires the number of the contract that was breached by the outstanding payment to be entered.

If the amounts are stated in euros, the sums referring to the period before the moment the euro came into use will be replaced by Estonian kroons at the rate of 15.6466 kroons to euro. If amounts are still sent in Estonian kroons after the change to the euro, kroons will be substituted with euros at the same rate, so the customer can choose when to start sending the data in euros.

= The ''bank_debtors_payments_ver2'' format =

This format is meant to be used by banks to forward data to credit management. The difference between ''bank_debtors_payments_ver2'' and ''debtors_info'' lies in the fact that the former is not based on invoices.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver2.xsd XML schema]
* [[bank_debtors_payments_ver2_mhr_example.xml]] - sample debtor data file. 
* [[Bank debtors payments ver2.png | bank debtors payments ver2.png]] - diagram of the structure of the XML file containing debtors’ data.

If the currency rate is not set in attributes of the ''/debtors/debtor/overdue_payments'' tag, the rate of 15.6466 kroons to euro is used and currency conversions are performed if necessary.

= Forwarding the files =

Files can be sent to Creditinfo by means of the [[KiDocExchange]] SOAP interface.

The format of the name of the file to be sent to Creditinfo must be the following:

<pre>
<initials>_krediidihaldus_<id>.<extension>
</pre>

* <initials> - the initials of the company, for example, ki for Creditinfo. ki.
* <id> - the unique ID of the file in the sender’s system by which the sent file can be identified, for example, the time when the file was generated.
* <extension> - the extension of the file to be sent (XML or ZIP). We recommend compressing the files to be sent.

Example 1: a file to be sent to Creditinfo Eesti AS

<pre>
ki_krediidihaldus_20100613.zip
</pre>

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-07-10T12:00:47Z

Julia: /* Formaat bank_debtors_payments_ver2 */

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info_ver2'' =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML skeem]
* [[debtors_info_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info ver2.png | debtors info ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver3'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver3'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd XML skeem]
* [[bank_debtors_payments_ver3_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver3.png | bank debtors payments ver3.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ci.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ci_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

Bank debtors payments ver3.png

2018-07-10T12:00:25Z

Julia: Created page with "Image:Bank debtors payments ver3.png"

[[Image:Bank debtors payments ver3.png]]

File:Bank debtors payments ver3.png

2018-07-10T12:00:13Z

Julia:

Bank debtors payments ver3 mhr example.xml

2018-07-10T11:59:25Z

Julia: Created page with "<pre> <?xml version="1.0" encoding="UTF-8"?> <debtors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_..."

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver3.xsd" generated="2015-01-01">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<contract_no>123</contract_no>
<client_code>456</client_code>
<id>00000000</id>
<client_class>A</client_class>
<mail_address>
<street>Kuusiku 10-2</street>
<ship_code>10001</ship_code>
<city>Nuustaku</city>
<country/>
</mail_address>
<email>ohk@pohk.ee</email>
<fax>609233423</fax>
<phone>2349082</phone>
<client_manager>Jaan Jalgratas</client_manager>
<overdue_payments>
<overdue_payment pay_due="2015-01-10" currency="EUR" exchange_rate="1" exchange_rate_to="EUR">
<primary_debt>100.23</primary_debt>
<interest>4.77</interest>
<fine xsi:nil="true"/>
</overdue_payment>
<overdue_payment pay_due="2014-12-10" currency="EUR" exchange_rate="1" exchange_rate_to="EUR">
<primary_debt>100.23</primary_debt>
<interest>4.77</interest>
<fine xsi:nil="true"/>
</overdue_payment>
</overdue_payments>
<additional_info>
<data name="client_manager_comment">15.11.2014 promised to pay in two days</data>
</additional_info>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<contract_no>321</contract_no>
<client_code>654</client_code>
<id>00000000</id>
<overdue_payments/>
<payment_default_ending>
<end_date>2018-01-01</end_date>
<is_debt_assigned assignee_registry_code="00000000" assignee_name="Inkasso AS">true</is_debt_assigned>
</payment_default_ending>
</debtor>
</debtors>
</pre>

Debtors info ver2.png

2018-07-10T11:57:47Z

Julia: Created page with "Image:Debtors info ver2.png"

[[Image:Debtors info ver2.png]]

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-07-10T11:52:31Z

Julia: /* Formaat debtors_info */

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info_ver2'' =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd XML skeem]
* [[debtors_info_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info ver2.png | debtors info ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver2'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver2'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver2.xsd XML skeem]
* [[bank_debtors_payments_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver2.png | bank debtors payments ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ci.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ci_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

File:Debtors info ver2.png

2018-07-10T11:51:44Z

Julia:

Debtors info ver2 mhr example.xml

2018-07-10T11:50:54Z

Julia: Created page with "<pre> <?xml version="1.0" encoding="UTF-8"?> <debtors xmlns="http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"..."

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns="http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" generated="2015-01-01">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<client_code>123</client_code>
<id>00000000</id>
<client_class>VIP</client_class>
<mail_address>
<street>Kuusiku 10-2</street>
<ship_code>10001</ship_code>
<city>Nuustaku</city>
<country/>
</mail_address>
<email>ohk@pohk.ee</email>
<fax>609233423</fax>
<phone>2349082</phone>
<client_manager>Jaan Jalgratas</client_manager>
<invoices>
<invoice>
<invoice_date>2007-01-01</invoice_date>
<invoice_no>A-003231</invoice_no>
<payment_term>2007-01-08</payment_term>
<final_sum>3092.23</final_sum>
<unpaid_sum>1000.23</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about invoice</add_inv_data>
</invoice>
<invoice>
<invoice_date>2010-03-01</invoice_date>
<invoice_no>23422</invoice_no>
<payment_term>2010-03-14</payment_term>
<final_sum>-1000.0</final_sum>
<unpaid_sum>-1000.0</unpaid_sum>
<currency>EUR</currency>
<bank_ref_no>00000000000000</bank_ref_no>
<add_inv_data add_inv_data_name="comment">a comment about creditinvoice</add_inv_data>
</invoice>
</invoices>
<additional_data additional_data_name="client_manager_comment">02.09.2007 promised to pay in two days</additional_data>
<additional_data additional_data_name="contract_no">984932342</additional_data>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<client_code>321</client_code>
<id>00000000000</id>
<invoices/>
<payment_default_ending>
<end_date>2018-01-01</end_date>
<is_debt_assigned assignee_registry_code="00000000" assignee_name="Inkasso AS">true</is_debt_assigned>
</payment_default_ending>
</debtor>
</debtors>
</pre>

KiDocExchange

2018-03-12T08:47:21Z

Julia: /* Silumine */

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

= Tutvustus =

KiDocExchange on Creditinfo veebiteenus failide saatmiseks ja vastuvõtmiseks.

= Failide edastamine ja vastuvõtmine=

Faile saab Creditinfole edastada ja ka vastu võtta [[KiDocExchange]] SOAP liidese kaudu.

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<kliendi_faili_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<kliendi_faili_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

= WSDL =

KiDocExchange veebiteenuse WSDL fail on aadressil [http://services.krediidiinfo.ee/KiDocExchange.wsdl http://services.krediidiinfo.ee/KiDocExchange.wsdl].

= Järgnevusdiagramm =

Järgnevusdiagrammil on näidatud KiDocExchange meetodite väljakutsumise järjekorrad faili üles laadimisel.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

ja alla laadimisel

[[Image:Download_diagram.png]]

Alla laetavate failide nimekirja saab pärida funkstiooniga getDownloadQueue(). Kord alla laetud fail kaob nimekirjast, aga faili ID säilitamisel saab faili alla laadida ka hiljem.

== Meetodid ==

=== startUpload ===

Failide üleslaadimise initsialiseerimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameeter:
| fileName
| xs:string
| Faili nimi
|-
| Väljundparameeter:
| docID
| xs:integer
| Unikaalne faili id Creditinfo serveris.
|}

=== uploadChunk ===

Laetakse serverisse ning lisatakse juba serveris olevale failile lõppu osa failist. Kliendid võivad kogu faili saata ka ühe osana. Failide jupitamist on soovitav kasutada desktop lahendustes suurte failide saatmisel.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator.
|-
|
| chunk
| xs:base64Binary
| Järgmine faili osa.
|-
| Väljundparameeter:
|
|
| None
|}

=== finishUpload ===

Faili üleslaadimise lõpetamine.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator
|-
|
| md5
| xs:string
| Üles laetud faili MD5 kontrollsumma.
|-
| Väljundparameeter:
| errorCode
| xs:integer
| Kui 0, siis faili üleslaadimine õnnestus. Kui negatiivne, siis tekkis mingi viga (vt veakoodide).
|}

=== downloadChunk ===

Faili alamosa allalaadimine Creditinfo failiserverist.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator
|-
|
| start
| xs:integer
| Positsioon failis, millest alates andmeid alla laetakse (positsiooni lugemine algab nullist)
|-
|
| count
| xs:integer
| Alla laetava tüki suurus baitides.
|-
| Väljundparameeter:
| chunk
| xs:base64Binary
| Faili alamosa
|}

=== getDownloadQueue ===

Creditinfo serveris kliendi poolt allalaadimist ootavate failide loetelu.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Väljundparameeter:
| queue
| DownloadQueueArray
| Massiiv DownloadQueueType tüüpi elementidest
|}

DownloadQueueType on assiotsiatiivne massiiv, millel on järgmised elemendid:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| docID
| xs:integer
| faili id
|-
| fileName
| xs:string
| faili nimi
|}

=== getStatusCode ===

Tagastatakse üles laetud faili staatus serveris.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! colspan="2" style="text-align: left;" | Kirjeldus
|-
| Sisendparameeter:
| docID
| xs:integer
| colspan="2" |Faili identifikaator
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | Faili staatuse kood:
|-
| colspan="3" |
| align="right" | 0
| Fail on töödeldud
|-
| colspan="3" |
| align="right" | 2
| Toimub faili üles laadimine
|-
| colspan="3" |
| align="right" | 3
| Toimub faili töötlemine
|-
|-
| colspan="3" |
| align="right" | 4
| Fail on edukalt üles laetud ning ootab töötlemist
|-
| colspan="3" |
| align="right" | -1
| Tundmatu viga. Täpsema info saamiseks võtke ühendust tehnilise teoga. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 kontroll ebaõnnestus. Kliendi saadetud MD5 kontrollsumma ei langenud kokku serveri poolt arvutatud MD5 kontrollsummaga.
|-
| colspan="3" |
| align="right" | -xxxxx
| Faili töötlemine ebaõnnestus. Täpsema info saamiseks võta ühendust tehnilise toega. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg.
|}

=== getStatusMsg ===

Tagastatakse staatust täpsustav info.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameeter:
| docID
| xs:integer
| Faili identifikaator
|-
| Väljundparameeter:
| statusMsg
| xs:string
| Faili staatust täpsustav info
|}

= Veakoodid =

<table>
<tr>
<td>Kood</td>
<td>Kirjeldus</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Päringu töötlus õnnestus.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>Üritatakse pöörduda faili poole, mis kuulub kellelegi teisele.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>Kasutati faili identifikaatorit, mida ei eksisteeri.</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Kliendi saadetud MD5 ei lange kokku serveri poolt arvutatud MD5-ga</td>
</tr>
</table>

= Testimine =

Faili edastamiseks testserverisse tuleb lisada parameeter ''debug'' serveri aadressile, ehk 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'

= Näidis PHP-s =

Programm laeb faili Creditinfo serverisse ning seejärel laeb sama faili alla. Lõpus kontrollitakse, kas üles ja alla laetud faili sisu on sama. Programmi põhimõte sobib KiDocExchange liidese testimiseks. Kui soovite maksehäire sisestamiseks mõeldud faili testida siis ärge kasutage silumismoodi.

<pre>
<?php
/**
* Example of uploading and downloading files using KiDocExchange interface.
* @author Rait Kapp <rait@creditinfo.ee>
* @created 27.04.2007
*/
$wsdl_url = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'
, 'login' => 'username' // <-- username. Make sure username is string type (PHP bug?).
, 'password' => 'password' // <-- password
);

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

// Uploading file.
$content = 'I am a little test file!';
$docID = $client->startUpload('test.txt');
$client->uploadChunk($docID, $content);

$md5 = md5($content);
$result = $client->finishUpload($docID, $md5);
if ($result != 0) {
die("upload failed.! Error code: {$result}\n");
}

// Downloading file
$start = 0;
$count = 512; // can be a big number if you do not have to display download progress.
$data = '';
while ($chunk = $client->downloadChunk($docID, $start, $count)) {
$start += $count;
$data .= $chunk;
}

if ($content != $data) {
echo "Something is not right!\n";
} else {
echo "We got back: {$data}\n";
}

?>
</pre>

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2018-03-12T07:47:28Z

Julia: /* Failide edastamine */

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info'' =

* [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd XML skeem]
* [[debtors_info_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info.png | debtors info.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver2'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver2'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver2.xsd XML skeem]
* [[bank_debtors_payments_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver2.png | bank debtors payments ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ci.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ci_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

Masspäring

2017-06-28T06:55:18Z

Julia:

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

= Tutvustus =

Masspäringud võimaldavad pärida Creditinfost andmeid mitme ettevõtte või isiku kohta korraga. Masspäring saab teha saates ja vastuvõttes faili. Iga masspäringu faili struktuur ja andmete koosseis on eraldi kokkulepe. Creditinfosse tuleb saata kokku lepitud ajal päringufaili, kus see töödeldakse ning saadetakse vastus. Päringu- ja vastusfaili nimed tuleb kokku leppida.

= Failide edastamine ja vastuvõtmine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<unikaalne_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
req_RAX99999AE_20170101.zip
</pre>

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<unikaalne_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

== Testimine ==

Maksehäirete lisamine ja uuendamine registris läbi krediidihalduse

2017-06-05T12:21:03Z

Julia: /* Failide edastamine */

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) väljavõte müügireskontrast.

Müügireskontrat saab saata krediidihaldusesse XML failis, mille formaat on määratud skeemiga [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd].

NB! Pankade jaoks on loodud oma XML skeem: [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_info_ver2.xsd http://www.krediidiinfo.ee/schemas/kh/debtors_info_ver2.xsd]

= Krediidihalduse andmete sünkroniseerimise põhimõtted =

Krediidihaldusesse tuleb saata infot vaid maksmata arvete kohta. Maksmata arvete koondsaldo näitabki deebitori saldot ning arvetest saab järeldada võla vanust. Need ongi põhilised andmed millel põhineb krediidihaldus. Makstud arved saldod ei muuda ning seepärast ei oma need krediidihalduse jaoks tähtsust.

Sõltuvalt krediidihalduse pakutavatest teenusest võib krediidihaldusesse saadetavaid deebitorite andmeid piirata veel lisaks võla vanusega. Näiteks kui on krediidihaldusega kokkulepe, et kasutatakse ainult maksehäireregistris andmete uuendamise teenust, siis võib krediidihaldusesse saata infot vaid nende deebitoride kohta, kellel on võlgnevused vanemad kui 45 päeva. Deebitorid, kelle võla vanus ei ole 45 päeva, ei ole krediidihaldusele vaja. Saadetavate andmete piiramisega väheneb saadetava faili maht ja andmete importimise kiirus.

Krediidihaldusesse importimisel uuendatakse andmebaasis deebitori arvete saldosid. Need arved, mis enne importi olid maksmata kuid mille kohta sisendfailis info puudus, loetakse makstuks ning saldo märgitakse nulliks. Seega ei ole vaja krediidihaldust teavitada sellest kui mõni arve tasuti. Lihtsalt tuleb teha väljavõte maksmata arvete (ka ettemaksudest, et koondsaldo arvutataks õigesti) hetkeseisust. Selline lähenemine on kliendi jaoks lihtsam (ei ole eelmisest ekspordist vaja midagi meeles pidada) ning viimane sisendfail fail parandab alati kõik andmed krediidihalduses õigeks (andmed ei lähe sünkroonist välja).

= Formaat ''debtors_info'' =

* [http://www.krediidiinfo.ee/schemas/kh/debtors_info.xsd XML skeem]
* [[debtors_info_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors info.png | debtors info.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/additional_data'' atribuudiga ''additional_data_name="contract_no"'' väärtust kasutatakse maksehäire lisamisel registrisse. Maksehäireregistri nõuete järgi tuleb maksehäire juurde lisada ka lepingu number, mille kohustuse mittetäitmisel maksehäire tekkis.

Kui summad on eurodes, siis teisendatakse need kuni eurole ülemineku hetkeni Eesti kroonideks kursiga 15.6466 krooni ühe euro eest. Kui pärast eurole üleminekut saadetakse ikkagi summasid eesti kroonides, siis teisendatakse sama kursiga kroonid euordeks. Seega võivad kliendid ise valida hetke, millal hakata andmeid saatma eurodes.

= Formaat ''bank_debtors_payments_ver2'' =

Formaat on mõeldud pankadele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver2'' erineb ''debtors_info'' formaadist selle poolest, et ei ole arvepõhine.

* [http://www.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver2.xsd XML skeem]
* [[bank_debtors_payments_ver2_mhr_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank debtors payments ver2.png | bank debtors payments ver2.png]] - deebitoride andmete XML faili struktuuri diagramm.

Kui märgnedi ''/debtors/debtor/overdue_payments'' atribuutides ei ole määratud valuuta kurssi, siis võetakse kursiks 15.6466 krooni ühe euro eest ning tehakse vajadusel valuuta teisendused.

= Failide edastamine =

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
<initsiaalid>_krediidihaldus_<id>.<laiend>
</pre>

* <initsiaalid> - ettevõtte initsiaalid. Näiteks Creditinfo puhul ki.
* <id> - faili saatja süsteemis unikaalne id, millega saab saadetud faili identifitseerida. Võib olla ka näiteks faili genereerimise aeg.
* <laiend> - saadetud faili laiend. XML või ZIP. Saadetud faile on soovitav pakkida.

Näide 1: Creditinfo Eesti AS saadetav fail

<pre>
ki_krediidihaldus_20100613.zip
</pre>

== Failiedastusmeetodid ==

=== KiDocExchange ===

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

=== Creditinfo failiedastuskeskkond ===

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

Masspäring

2017-06-05T12:16:29Z

Julia:

Masspäring

2017-06-05T11:01:35Z

Julia:

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

= Tutvustus =

Masspäringud võimaldavad pärida Creditinfost andmeid mitme ettevõtte või isiku kohta korraga. Masspäring saab teha saates ja vastuvõttes faili. Iga masspäringu faili struktuur ja andmete koosseis on eraldi kokkulepe. Creditinfosse tuleb saata kokku lepitud ajal päringufaili, kus see töödeldakse ning saadetakse vastus. Päringu- ja vastusfaili nimed tuleb kokku leppida.

= Failide edastamine ja vastuvõtmine =

Faile saab Creditinfole edastada ja ka vastu võtta [http://services.krediidiinfo.ee/wiki/index.php/KiDocExchange KiDocExchange] veebiteenuse kaudu.

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<unikaalne_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
req_RAX99999AE_20170101.zip
</pre>

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<unikaalne_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

== Failiedastusmeetodid ==

== KiDocExchange ==

[[KiDocExchange]] on Creditinfo SOAP liides failide edastamiseks Creditinfosse. Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

== Creditinfo failiedastuskeskkond ==

Creditinfo failiedastuskeskkond on veebiliides failide saatmiseks Creditinfosse. Liides asub aadressil [https://services.krediidiinfo.ee/filestore.php https://services.krediidiinfo.ee/filestore.php] ning selle kasutamiseks on vaja kasutajanime ja parooli ning liidese kasutamise õiguseid.

Masspäring

2017-05-29T07:50:44Z

Julia:

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

= Tutvustus =

Masspäringud võimaldavad pärida Creditinfost andmeid mitme ettevõtte või isiku kohta korraga. Masspäring saab teha saates ja vastuvõttes faili. Iga masspäringu faili struktuur ja andmete koosseis on eraldi kokkulepe. Creditinfosse tuleb saata kokku lepitud ajal päringufaili, kus see töödeldakse ning saadetakse vastus. Päringu- ja vastusfaili nimed tuleb kokku leppida.

= Failide edastamine ja vastuvõtmine =

Faile saab Creditinfole edastada ja ka vastu võtta [http://services.krediidiinfo.ee/wiki/index.php/KiDocExchange KiDocExchange] veebiteenuse kaudu.

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<unikaalne_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
req_RAX99999AE_20170101.zip
</pre>

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<unikaalne_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <unikaalne_id> - kliendi poolt määratud unikaalne identifikaator, millega eristatakse faile üksteisest. Näiteks päringufaili genereerimise aeg.

Näide:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

Batch request

2017-05-29T07:47:16Z

Julia: Created page with "{| align="right" | 30px eesti keeles |} = Introduction = Batch requests make possible to request the data about multip..."

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

= Introduction =

Batch requests make possible to request the data about multiple companies or private persons. The batch request can be made by sending and receiving files. The file structure and the data composition should be agreed with Creditinfo. The request file should be sent at agreed time to Creditinfo, where it is proceeded and the response file is generated. The request and response file names should be agreed with Creditinfo.

= Sending and receiving files =

The file could be sent and received using [http://services.krediidiinfo.ee/wiki/index.php/KiDocExchange_en KiDocExchange]

When sending the file name should be in form of:

<pre>
req_<Creditinfo_product_code>_<client_unique_id>.xml.zip
</pre>

* <Creditinfo_product_code> - The product code agreed with Creditinfo, which is used for generating the response file.
* <client_unique_id> - unique identifier generated by the client, which distinguish sent files from each other. For example, the time when the request file was generated.

The file name example:

<pre>
req_RAX99999AE_20170101.zip
</pre>

When receiving the file name should be in form of:
<pre>
resp_<Creditinfo_product_code>_<client_unique_id>.zip
</pre>

* <Creditinfo_product_code> - The product code agreed with Creditinfo, which is used for generating the response file.
* <client_unique_id> - unique identifier generated by the client, which distinguish sent files from each other. For example, the time when the request file was generated.

The file name example:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

Masspäring

2017-05-29T07:26:28Z

Julia:

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

= Tutvustus =

Masspäringud võimaldavad pärida Creditinfost andmeid mitme ettevõtte või isiku kohta korraga. Iga masspäring on eraldi kokkulepe. Creditinfosse tuleb saata päringufaili, kus see kokku lepitud ajal töödeldakse ning saadetakse vastus. Päringu- ja vastusfaili nimed tuleb kokku leppida.

= Failide edastamine ja vastuvõtmine =

Faile saab Creditinfole edastada ja ka vastu võtta [http://services.krediidiinfo.ee/wiki/index.php/KiDocExchange KiDocExchange] veebiteenuse kaudu.

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<kliendi_faili_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

Näide:

<pre>
req_RAX99999AE_20170101.zip
</pre>

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<kliendi_faili_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

Näide:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

Masspäring

2017-05-29T07:24:07Z

Julia: Created page with "{| align="right" | 30px In English |} = Tutvustus = Masspäringud võimaldavad pärida Creditinfost andme..."

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

= Tutvustus =

Masspäringud võimaldavad pärida Creditinfost andmeid mitme ettevõtte või isiku kohta korraga. Iga masspäring on eraldi kokkulepe. Creditinfosse tuleb saata päringufaili, kus see kokku lepitud ajal töödeldakse ning saadetakse vastus. Päringu- ja vastusfaili nimed tuleb kokku leppida.

= Failide edastamine ja vastuvõtmine =

Faile saab Creditinfole edastada ja ka vastu võtta [http://services.krediidiinfo.ee/wiki/index.php/KiDocExchange KiDocExchange] veebiteenuse kaudu.

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<Creditinfo_toote_kood>_<kliendi_faili_id>.xml.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

Näide:

<pre>
req_RAX99999AE_20170101.zip
</pre>

Creditinfo vastusfaili kuju:
<pre>
resp_<Creditinfo_toote_kood>_<kliendi_faili_id>.zip
</pre>

* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

Näide:

<pre>
resp_RAX99999AE_20170101.zip
</pre>

Positiivne register: funktsionaalne spetsifikatsioon

2017-04-10T11:05:34Z

Julia: /* Lingid */

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

= Sissejuhatus =
'''Positiivne Register''' on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta. Positiivne Register võimaldab laenuandjal täita seadusest tulenevat vastutustundliku laenamise nõuet ning veenduda inimese võimes täita oma laenukohustust. Laenuklient ei pea enam tooma paberkandjal väljavõtteid teiste laenuandjate juurest ning on paremini kaitstud emotsionaalsete laenuotsuste ja ülelaenamisest tekkivate probleemide eest.

= Mõisted =

* '''Andmed''' – andmed tarbija olemasolevate kohustuste kohta, mis võimaldavad Osalejal hinnata tarbija krediidivõimelisust;
* '''Andmevahetussüsteem''' (''Data exchange system '') – infotehniline rakendus, mille vahendusel Osalejad vahetavad Andmeid;
* '''Andmevahetussüteemi haldaja''' (''Data exchange system manager'') – Creditinfo Eesti AS;
* '''Krediiditaotleja''' (''consumer'') - eraisik, kes on pöördunud Osaleja poole tarbijakrediidilepingu sõlmimise sooviga.
* '''Krediidisaaja''' (''consumer'') – eraisik, kellele Osaleja on väljastanud tarbijakrediidilepingu alusel krediidi.
* '''Tarbijakrediit''' (''consumer credit'') – Osaleja poolt Krediidisaajale väljastatud krediit;
* '''Krediidiotsus''' (''credit decision'') – Osaleja poolt langetatav otsus tarbijakrediidilepingu sõlmimiseks Kreediiditaotlejaga;
* '''Tarbijakrediidileping''' (''consumer credit contract'') – leping, mille alusel on Osaleja väljastanud Krediidisaajale krediidi;
* '''Kaastaotleja''' (''codebtor'') - isik, kellega Krediiditaotleja koos krediiti taotleb ja kelle sissetulekud ning varad võetakse Krediidiotsuse tegemisel arvesse;
* '''Käendaja''' (''guarantor'') - isik, kes võtab Osaleja ees kohustuse vastutada Krediidisaaja Tarbijakrediidi kohustuse täitmise eest;
* '''Tarbijakrediidilepingu subjekt''' (''subject'')- lepingu osapool;
* '''Osaleja''' (''member'') – Andmevahetussüsteemiga liitunud Eesti, kes jagab temale teadaolevaid Andmeid Krediiditaotleja kohta samaväärses koosseisus teiste Osalejatega;
* '''Krediiditaotleja nõusolek''' (''consent'') - Krediiditaotleja nõusolek päringu adressaatideks olevatele Osalejatele Krediiditaotleja Andmete edastamiseks päringu teinud Osalejale.

= Ärireeglid =
* ''Andmevahetussüsteemi'' kasutajad on ''Osalejad''.
* ''Osaleja'' peab olema liitunud X-teega.
* ''Osaleja'' sisestab ''Andmed'' ''Andmevahetussüsteemi haldaja ''andmebaasi või tekitab ''Andmevahetussüsteemi haldajale ''tehnoloogiline võimalus ''Andmeid'' pärida oma ''Andmekogust.''
* ''Osaleja'' uuendab ''Andmed'' edastades ''Andmevahetussüsteemi haldajale ''kas kõik kehtivad ''Andmed'' või ''Tarbijakrediidilepingu'' kaupa.
* ''Osaleja'' uuendab ''Andmed'' iga 24 tunni järel. Äärmisel juhul kuni 7 päeva järel.
* ''Osaleja'' pärib ''Krediiditaotleja'' kohta ''Andmeid'' tema ''Nõusoleku'' olemaolul. Kui ''Nõusolek'' ei ole digitaalselt allkirjastatud, siis pärijal ei ole õigust saada ''Andmeid'' teistelt ''Osalejatelt'', kes on seadnud päringule vastamise ja ''Andmete'' edastamise tingimuseks digitaalselt allkirjastatud ''Nõusoleku'' olemasolu.
* ''Nõusoleku'' dokument säilib ''Andmevahetussüsteemis'' 3 aastat.
* ''Admete'' päringu vastus ei kajasta andmeid ''Osaleja'' kohta.
* ''Andmete'' päringu vastus ei sisalda päringut teinud ''Osaleja Andmekogust'' ''Andmeid''.
* ''Andmete'' päringu vastuse koosseis kirjeldatud peatükis "Andmete koosseis".
* ''Osalejad'' jagavad ''Andmeid'' samaväärses koosseisus teiste ''Osalejatega.''

== Andmete kooseis ==
#Uuendamise kuupäev ''(update date and time)''
#Isikukood ''(identity code)''
#Isiku roll ''(role)'' antud lepingu raames
#Lepingu number (''contract number'') - Osaleja ja Krediidisaaja vahel sõlmitud Tarbijakrediidilepingu number;
#Krediidi liik (''type of credit'')
#Krediidi algus (''effective date of credit agreement'') – Tarbijakrediidilepingu kehtivuse alguskuupäev
#Krediidi lõpp (end date of credit) – Kuupäev, millal Tarbijakrediit tuleb tagastada
#Krediidi summa (''credit sum'') - Krediidisaajale väljamakstud või väljamaksmisele kuuluv maksimaalne Tarbijakrediidi summa;
#Krediidi valuuta (''credit currency'') - Tarbijakrediidi valuuta;
#Maksegraafik (''schedule payments'') – Järgmise või lähima kolme väljamakse summa ja tähtaeg;
#Hetkesaldo (''balance'') - Tarbija kohustuse suurus Osaleja ees;
#Üle tähtaja saldo (''days over net balance'') – 7 päeva üle maksetähtaja hilinenud maksete summa.
#Päringud ''(inquiries)'' – Krediidisaaja kohta Andmete saamiseks viimase kolme aasta jooksul tehtud päringute kuupäevad.

'''Isiku rollid'''

# Krediidisaaja (''borrower'')
# Kaastaotleja (''codebtor'')
# Käendaja (''guarantor'')

'''Krediidi liigid'''

# Tagatisega laen (''secured loan'')
# Järelmaks (''hire-purchase'')
# Tagatiseta laen (''unsecured loan)''
# Liising (''lease'')
# Krediitkaart (''credit card'')
# Muu (''other'')

= Kasutuslood =
[[File:Positive register use cases.jpg]]

== Members list request ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja pärib teiste Osalejate nimekirja et kasutada see nõusoleku dokumendi tekstis.

== Consent document creation / Nõusoleku dokumendi koostamine ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja pärib Andmevahetussüsteemis koostatud Krediiditaotleja Nõusoleku dokumendi tema Andmete pärimiseks Osalejate andmekogudest.

== Credit report request / Andmete pärimine ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

'''Eeldus''': Kui päringu sisendiks on nõusoleku dokument, siis see peab olema eelnevalt koostatud Andmevahetussüsteemis.
# Osaleja edastab päringu Andmevahetussüsteemi Krediiditaotleja krediidikohustuste pärimiseks;
# Andmevahetussüsteem kogub Andmeid andmebaasist;
# Andmevahetussüsteem edastab kogutud Andmed päringut teinud Osalejale.
Laiendused:
* Osaleja on seadnud päringule vastamise ja Andmete edastamise tingimuseks digitaalselt allkirjastatud Nõusoleku olemasolu ja seda ei ole edastatud päringuga

::2a. Andmevahetussüsteem ei edasta päringut Andmeid Osaleja andmekogusse;

::3a. Andmevahetussüsteem edastab veateadet mis sisaldab infot mitte edastatud päringu kohta.

* Andmed säilivad Osaleja peetavas andmekogus.
::2a. Andmevahetussüsteem kogub Andmeid Osalejate peetavatest andmekogudest.
* Andmete pärimine Osaleja peetavast andmekogust ebaõnnestub
::3a. Andmevahetussüsteem edastab päringu teinud Osalejale kogutud Andmeid ning ebaõnnestunud päringute arvu sisaldavat veateadet.

== Credit data management / Andmete haldus ==

Eeldus: Osaleja on sõlminud käsunduslepingu Andmevahetussüsteemi haldajaga, millega ta on andnud tema peetava andmekogu volitatud töötleja õigused Andmevahetussüsteemi haldajale.

'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja edastab tema peetava andmekogu andmed Andmevahetussüsteemi haldajale.

[[File:Credit data management use case.jpg]]

Stsenaariumid

A) Osaleja edastab kõik kehtivad tarbijakrediitide andmed Andmevahetussüsteemi haldajale.

B) Osaleja uuendab tarbijakrediidiandmed Andmevahetussüteemis.

== Manager data management / Osaleja andmete haldus ==
Andmevahetussüsteemi haldaja registreerib/kustutab Osaleja kohta andmeid Andmevahetussüteemis.

= Tegevusdiagrammid =

Allolevad tegevusdiagrammid ilustreerivad krediiditaotleja krediidivõimelisuse hindamise protsessi juhul kui

1. Krediiditaotleja allkirjastab Nõusolekut digitaalselt
[[File:Credit decision using digi consent.jpg]]

2. Krediiditaotleja Nõusolek ei ole digitaalselt allkirjastatud
[[File:Credit decision using digi consent.jpg]]

= Lingid =
* [[Andmevahetussüsteemi X-tee liides|Andmevahetussüsteemi X-tee liides]]

Data exchange system X-road interface

2017-04-10T11:03:36Z

Julia:

{| align="right"
| [[Image:Flag_of_Estonia.svg|border|30px]] [[Andmevahetussüsteemi_X-tee_liides|eesti keeles]]
|}

= Overview =
'''POSR''' is a data exchange system, through which creditors that are members of the system are able to share information about person’s credit obligations.

This document is about services of the system provided by the X-road.

= Use of services in production environment =
For using the services it is needed to be a member of X-Road, to install and configure the Security Server and to receive the rights for using the services from Creditinfo Eesti AS.

To send the request in production environment should the parameter xRoadInstance be "EE" in the header of request. Also, the request should be sent to the production Security Server.

= Use of services in test environment =
Testing of the services is offered by the X-Road test environment. For using the services it is needed to be a member of test-X-Road, to install and configure the Test Security Server and to receive the rights for using the services from Creditinfo Eesti AS.

To send the request in test environment should the parameter xRoadInstance be "ee-test" in the header of request. Also, the request should be sent to the Test Security Server.

It is possible to test the services allowed to use or the [http://x-road.eu/docs/x-road_service_metadata_protocol.pdf X-Road metadata services] like "listMethods" or "allowedMethods". There is no need to have rights for using the metadata services.

= WSDL =
POSR system WSDL can be downloaded on link http://services.krediidiinfo.ee/posr.wsdl

= X-road message =
X-road message is corresponding to the service description
* SOAP envelope
* or is in MIME multipart/related format. First part of the message is SOAP envelope.
Response is a SOAP envelope.

SOAP envelope consists of a header and a body.

== SOAP envelope header ==
Composition of data of the SOAP envelope header responds to [http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf X-road specification].

== SOAP envelope body ==
Composition of data of the SOAP envelope body is described in the present documentation.

== Request soap envelope example ==
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr"
xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>TEST</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReport>
<rep:subject>
<rep:ident_code>00000000000</rep:ident_code>
</rep:subject>
<rep:signed_consent>TEST</rep:signed_consent>
<rep:lang>et</rep:lang>
</posr:getCreditReport>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

== Response soap envelope example==

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="MEMBER" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>Test</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">test</xrd:id>
<xrd:userId xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">EE00000000000</xrd:userId>
<xrd:issue xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"/>
<xrd:protocolVersion xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">4.0</xrd:protocolVersion>
<xrd:requestHash algorithmId="http://www.w3.org/2001/04/xmlenc#sha512">Test</xrd:requestHash>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReportResponse>
<credit_report xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd"
xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/identifiers.xsd">
<rep:consumer_credits>
<rep:consumer_credit>
<cid:type>
<cid:code>CC</cid:code>
<cid:name>Krediitkaart</cid:name>
</cid:type>
<cid:begin_date>2016-07-14</cid:begin_date>
<cid:end_date>2017-07-14</cid:end_date>
<cid:sum>200</cid:sum>
<cid:balance>200</cid:balance>
<cid:unpaid_sum>7</cid:unpaid_sum>
<cid:currency>EUR</cid:currency>
<cid:schedule_payments>
<cid:schedule_payment>
<cid:due_date>2016-10-22</cid:due_date>
<cid:sum>100.0</cid:sum>
</cid:schedule_payment>
</cid:schedule_payments>
<cid:subjects>
<cid:subject>
<cid:ident_code>00000000000</cid:ident_code>
<cid:role>
<cid:code>BRW</cid:code>
<cid:name>Krediidivõtja</cid:name>
</cid:role>
</cid:subject>
</cid:subjects>
<cid:update_datetime>2017-01-01T03:00:00</cid:update_datetime>
</rep:consumer_credit>
</rep:consumer_credits>
<rep:inquiries>
<rep:inquiry>
<cid:datetime>2017-01-02T08:17:30</cid:datetime>
</rep:inquiry>
</rep:inquiries>
</credit_report>
<posr:fault xsi:nil="true"/>
</posr:getCreditReportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Services =

The member can use services if Creditinfo Eesti AS has given him the rights to use them.

== '''generateConsent.v1''' ==
Creation of the document, which provides the requester to inquire person’s credit obligations, whoes consent is given by the digital signature of the document. The consent document format is pdf.
===Request soap envelope body parameters===
[[File:GenerateConsentReq.png|link=]]
===Response soap envelope body parameters===

[[File:GenerateConsentResp.png]]

=== Testing of the service ===
The input parameter ident_code is the identity code of Estonia citizen.

== '''getMembers.v1''' ==
The request of members list, to use it while creating the consent document.

=== Request soap envelope body parameters ===

[[File:GetMembersReq.png]]

=== Response soap envelope body parameters ===

[[File:GetMembersResp.png]]

=='''getCreditReport.v1'''==
The request of person’s credit obligations from data repositories of creditors that are members of the data exchange system.

=== Request soap envelope body parameters ===

[[File:GetSubjectPositiveData.png | GetSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:GetSubjectPositiveDataResponse.png | GetSubjectPositiveDataResponse]]

=== Testing of the service ===
The input parameter ident_code is the identity code of Estonia citizen.

The input parameter signed_consent could be the any string encoded by base64 encoding.

== '''insertCredit.v1''' ==

Registration of the person’s credit obligation in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:AddSubjectPositiveData.png | AddSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:AddSubjectPositiveDataResponse.png | AddSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not insert the input data to the database.

== '''updateCredit.v1''' ==
Update of the person’s credit obligation in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:UpdateSubjectPositiveData.png | UpdateSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:UpdateSubjectPositiveDataResponse.png | UpdateSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not update the data in the database.

== '''deleteCredit.v1''' ==
Deletion of the person’s credit obligation from data exchange system repository.

=== Request soap envelope body parameters ===

[[File:DeleteSubjectPositiveData.png | DeleteSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:DeleteSubjectPositiveDataResponse.png | DeleteSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not delete the data from the database.

== '''uploadCreditsMtom.v1''' ==
Importing of data of all current credit obligations in data exchange system repository.

=== Request ===

Request is in format MTOM/XOP, which responds to the standard SOAP multipart/related. First part of the message is SOAP envelope. Second part of the message is XML which is zipped by gzip and encoded by base64. XML should be valid according to the schema https://services.krediidiinfo.ee/schemas/positive_register/credit/v1/insert.xsd.

Soap envelope body parameters:

[[File:UploadPositiveDataMtom.png | UploadPositiveDataMtom]]

[[File:Loaninfo debtors.png]]

'''Request example:'''

<pre>
...Other headers
Content-Type: multipart/related; type="application/xop+xml"; start="<xxx>"; start-info="text/xml"; boundary="MIME_boundary"'
MIME-Version: 1.0

--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <xxx>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystenCode>TEST</id:subsystenCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>uploadCreditsMtom</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:uploadCreditsMtom>
<positive_data>
<inc:Include href="cid:xxx"/>
</positive_data>
</posr:uploadCreditsMtom>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

--MIME_boundary
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64
Content-ID: <xxx>
Content-Disposition: attachment;

H4sIAAAAAAAAA12PsW7CQAyGd6S+Q+Q9dxeoRIkIbEx0KpXYoujOCRbEh84uyeM3abtQyfLi///kb7sf+1v2wCQUuYLCOMiQfQzEXQWfp0P+Bvvdy2LrI8tXj6n2CQOpZFOPpaRQwUX1Xlo7DIO5zkeahttoEK34C/aN2HsUUnpgnbAjUUz2F1NTQFZqaXrAjBLgDzsKPXGHlYmps0vnCnt+P378YHNi0YY9QtYhY2oU6zAtpR4rmLN5scyL9cltypUrX9cwi9j/Jrtv1xHpQQQBAAA=

--MIME_boundary--
</pre>

=== Response soap envelope body parameters ===

[[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]]

=== Testing of the service ===
The attachment in second part of the message could be any string encoded by base64 encoding.

As the result the service do not import the input data to the database.
== '''getUploadStatus.v1''' ==
Requesting of the document status that was created by importing of data of all current credit obligations in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:UploadPositiveDataStatus.png | UploadPositiveDataStatus]]

=== Response soap envelope body parameters ===

[[File:UploadPositiveDataStatusResponse.png | UploadPositiveDataStatusResponse]]

=== Testing of the service ===
The input parameter doc_id could be any number.

The result of the service is any status.

= Technical error =

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>Internal service error</faultstring>
<faultactor/>
<detail>
<faultCode>-50200</faultCode>
<faultString>Internal service error</faultString>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Error codes =
<table>
<tr>
<td>'''-50200'''</td>
<td>'''Internal service''' '''error'''</td>
</tr>
<tr>
<td></td>
<td>Internal service error</td>
</tr>
<tr>
<td>'''-50201'''
'''-50301'''
</td>
<td>'''Invalid request'''</td>
</tr>
<tr>
<td></td>
<td>Invalid request format or data</td>
</tr>
<tr>
<td>'''-50202'''</td>
<td>'''Access denied'''</td>
</tr>
<tr>
<td></td>
<td>User has no permission to use the system</td>
</tr>
<tr>
<td>'''-50203'''</td>
<td>'''Partial data'''</td>
</tr>
<tr>
<td></td>
<td>The data in response is partial</td>
</tr>
<tr>
<td>'''-50250'''</td>
<td>'''Credit data sync failed'''</td>
</tr>
<tr>
<td></td>
<td>Consumer credit data synchronization (insertion, updating, deletion) has failed</td>
</tr><tr><td>'''-50252'''</td><td>'''Invalid consent document'''</td></tr><tr><td></td><td>The consent document has not been pre-generated or is invalid digidoc container.</td></tr><tr><td>'''-50300'''</td><td>'''Invalid xml'''</td></tr><tr><td></td><td>Xml is invalid</td></tr></table>

= Links =
[[Positive_register: functional_specification | Functional specification]]

Andmevahetussüsteemi X-tee liides

2017-04-10T11:02:46Z

Julia:

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

= Tutvustus =

'''POSR''' on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta.

Käesolev dokument kirjeldab süsteemi poolt pakutavaid teenusi X-tee vahendusel.

= Teenuste kasutamine toodangukeskkonnas =
POSR süsteemi teenuste kasutamine eeldab, et osaleja on liitunud X-teega, paigaldanud ja seadistanud x-tee tervaserverit ning saanud liigipääsuõigused teenustele Creditinfolt.

Päringu edastamiseks toodangukkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "EE" ning saata päringu toodang x-tee turvaserverisse.

= Teenuste kasutamine testkeskkonnas =
Andmevahetussüsteemi testimine toimub x-tee testkeskonna vahendusel. Eelnevalt tuleb test-x-tee testkeskkonnaga liituda, paigaldada ja seadistada test-x-tee turvaserverit ning küsida ligipääsuõigused teenustele Creditinfolt.

Päringu edastamiseks testkeskkonda tuleb koostamisel kasutada päringu päises parameetri xRoadInstance väärtust "ee-test" ning saata päringu test-x-tee turvaserverisse.

Testida võimalik wsdl-s kirjeldatud teenused milledele ligipääs antud ning [http://x-road.eu/docs/x-road_service_metadata_protocol.pdf x-tee metateenused] nagu "listMethods" ja "allowedMethods". Metateenustele ligipääsuõigusi ei anta.

= WSDL =

POSR süsteemi WSDL asub aadressil http://services.krediidiinfo.ee/posr.wsdl.

= X-tee sõnum =
X-tee päring on vastavalt teenuse kirjeldusele kas
* SOAP ümbrik
* või on MIME multipart/related stiilis, mille esimeses osas on SOAP ümbrik.
Vastus on SOAP ümbrik.

SOAP ümbrik koosneb päisest ja kehast.

== SOAP ümbriku päis ==
SOAP ümbriku päises oleva info koosseis on määratud [http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf X-tee spetsifikatsiooni] poolt.

== SOAP ümbriku keha ==
SOAP ümbriku kehas oleva info koosseis on määratud käesoleva dokumendi poolt.

== Päringu soap ümbriku näide ==
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr"
xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>TEST</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReport>
<rep:subject>
<rep:ident_code>00000000000</rep:ident_code>
</rep:subject>
<rep:signed_consent>TEST</rep:signed_consent>
<rep:lang>et</rep:lang>
</posr:getCreditReport>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

== Vastuse soap ümbriku näide ==

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="MEMBER" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>Test</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">test</xrd:id>
<xrd:userId xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">EE00000000000</xrd:userId>
<xrd:issue xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"/>
<xrd:protocolVersion xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">4.0</xrd:protocolVersion>
<xrd:requestHash algorithmId="http://www.w3.org/2001/04/xmlenc#sha512">Test</xrd:requestHash>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReportResponse>
<credit_report xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd"
xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/identifiers.xsd">
<rep:consumer_credits>
<rep:consumer_credit>
<cid:type>
<cid:code>CC</cid:code>
<cid:name>Krediitkaart</cid:name>
</cid:type>
<cid:begin_date>2016-07-14</cid:begin_date>
<cid:end_date>2017-07-14</cid:end_date>
<cid:sum>200</cid:sum>
<cid:balance>200</cid:balance>
<cid:unpaid_sum>7</cid:unpaid_sum>
<cid:currency>EUR</cid:currency>
<cid:schedule_payments>
<cid:schedule_payment>
<cid:due_date>2016-10-22</cid:due_date>
<cid:sum>100.0</cid:sum>
</cid:schedule_payment>
</cid:schedule_payments>
<cid:subjects>
<cid:subject>
<cid:ident_code>00000000000</cid:ident_code>
<cid:role>
<cid:code>BRW</cid:code>
<cid:name>Krediidivõtja</cid:name>
</cid:role>
</cid:subject>
</cid:subjects>
<cid:update_datetime>2017-01-01T03:00:00</cid:update_datetime>
</rep:consumer_credit>
</rep:consumer_credits>
<rep:inquiries>
<rep:inquiry>
<cid:datetime>2017-01-02T08:17:30</cid:datetime>
</rep:inquiry>
</rep:inquiries>
</credit_report>
<posr:fault xsi:nil="true"/>
</posr:getCreditReportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Teenused =

Teenuste kasutamiseks peavad Osalejal olema õigused antud Creditinfo Eesti AS poolt.

== '''generateConsent.v1''' ==
Teenuse abil koostatakse dokument pdf formaadis, mille digiallkirjastades annab krediiditaotleja nõusoleku tema krediidikohustuste kohta andmete pärimiseks.

=== Päringu soap ümbriku keha parameetrid ===

[[File:GenerateConsentReq.png]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:GenerateConsentResp.png]]

=== Teenuse testimine ===
Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.

== '''getMembers.v1''' ==
Andmevahetussüsteemiga liitunud Osalejate nimekirja pärimine, et kasutada see nõusoleku dokumendi tekstis.

=== Päringu soap ümbriku keha parameetrid ===

[[File:GetMembersReq.png]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:GetMembersResp.png]]

== '''getCreditReport.v1''' ==

Krediiditaotleja krediidikohustuste kohta andmete pärimine Osalejate andmekogudest.

=== Päringu soap ümbriku keha parameetrid ===

[[File:GetSubjectPositiveData.png]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:GetSubjectPositiveDataResponse.png]]

=== Teenuse testimine ===
Sisendparameetri ident_code väärtus on eksisteeriva isiku isikukood.

Sisendparameetri signed_consent väärtus saab olla suvaline string kodeeritud base64-ga.

== '''insertCredit.v1''' ==

Ühe tarbijakrediidi andmete registreerimine andmevahetussüsteemi andmebaasis.

=== Päringu soap ümbriku keha parameetrid ===

[[File:AddSubjectPositiveData.png | AddSubjectPositiveData]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:AddSubjectPositiveDataResponse.png | AddSubjectPositiveDataResponse]]

=== Teenuse testimine ===
Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei uuendata andmeid andmebaasis.

== '''updateCredit.v1''' ==

Ühe tarbijakrediidi andmete uuendamine andmevahetussüsteemi andmebaasis.

=== Päringu soap ümbriku keha parameetrid ===

[[File:UpdateSubjectPositiveData.png | UpdateSubjectPositiveData]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:UpdateSubjectPositiveDataResponse.png | UpdateSubjectPositiveDataResponse]]

=== Teenuse testimine ===
Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei salvestata andmeid andmebaasi.

== '''deleteCredit.v1''' ==

Ühe tarbijakrediidi andmete kustutamine andmevahetussüsteemi andmebaasist.

=== Päringu soap ümbriku keha parameetrid ===

[[File:DeleteSubjectPositiveData.png | DeleteSubjectPositiveData]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:DeleteSubjectPositiveDataResponse.png | DeleteSubjectPositiveDataResponse]]

===Teenuse testimine===
Sisendandmed peavad vastama nõuetele.

Teenuse tulemuseks ei kustutata andmeid andmebaasist.
== '''uploadCreditsMtom.v1''' ==

Kõigi kehtivate tarbijakrediitide andmete sisse importimine andmevahetussüsteemi andmebaasi.

=== Päring ===

Päringu sõnum on MTOM/XOP formaadis, mis vastab SOAP multipart/related standardile. Sõnumi esimeses osas on SOAP ümbrik. Sõnumi teises osas on gzip-ga kokkupakkitud ja seejärel base64-ga kodeeritud tarbijakrediitide andmetega xml, mis vastab skeemile https://services.krediidiinfo.ee/schemas/positive_register/credit/v1/insert.xsd.

SOAP ümbriku parameetrid on:

[[File:UploadPositiveDataMtom.png | UploadPositiveDataMtom]]

[[File:Loaninfo debtors.png]]

Näitepäring:

<pre>
...Teised päised
Content-Type: multipart/related; type="application/xop+xml"; start="<xxx>"; start-info="text/xml"; boundary="MIME_boundary"'
MIME-Version: 1.0

--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <xxx>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystenCode>TEST</id:subsystenCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>uploadCreditsMtom</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:uploadCreditsMtom>
<positive_data>
<inc:Include href="cid:xxx"/>
</positive_data>
</posr:uploadCreditsMtom>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

--MIME_boundary
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64
Content-ID: <xxx>
Content-Disposition: attachment;

H4sIAAAAAAAAA12PsW7CQAyGd6S+Q+Q9dxeoRIkIbEx0KpXYoujOCRbEh84uyeM3abtQyfLi///kb7sf+1v2wCQUuYLCOMiQfQzEXQWfp0P+Bvvdy2LrI8tXj6n2CQOpZFOPpaRQwUX1Xlo7DIO5zkeahttoEK34C/aN2HsUUnpgnbAjUUz2F1NTQFZqaXrAjBLgDzsKPXGHlYmps0vnCnt+P378YHNi0YY9QtYhY2oU6zAtpR4rmLN5scyL9cltypUrX9cwi9j/Jrtv1xHpQQQBAAA=

--MIME_boundary--
</pre>

=== Vastuse soap ümbriku keha parameetrid ===

[[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]]

=== Teenuse testimine ===
Sõnumi teises osas oleva attachment saab olla suvaline string kodeeritud base64-ga. Andmete importimist ei toimu.

== '''getUploadStatus.v1''' ==

Faili töötlemise staatuse pärimine mis oli tekitatud kõigi kehtivate tarbijakrediitide andmete sisse importimise tulemusena andmevahetussüsteemi.

=== Päringu soap ümbriku keha parameetrid ===

[[File:UploadPositiveDataStatus.png | UploadPositiveDataStatus]]

=== Vastuse soap ümbriku keha parameetrid ===

[[File:UploadPositiveDataStatusResponse.png | UploadPositiveDataStatusResponse]]

=== Teenuse testimine ===
Sisendparameeter doc_id võib suvaline number olla.

Teenuse tulemuseks on suvaline staatus.

= Tehniline viga =

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>Internal service error</faultstring>
<faultactor/>
<detail>
<faultCode>-50200</faultCode>
<faultString>Internal service error</faultString>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Veakoodid =
<table>
<tr>
<td>'''-50200'''</td>
<td>'''Internal service error'''</td>
</tr>
<tr>
<td></td>
<td>Sisemine viga</td>
</tr>
<tr>
<td>'''-50201'''
'''-50301'''
</td>
<td>'''Invalid request'''</td>
</tr>
<tr>
<td></td>
<td>Vigane päringu formaat või sisu</td>
</tr>
<tr>
<td>'''-50202'''</td>
<td>'''Access denied'''</td>
</tr>
<tr>
<td></td>
<td>Kasutajal puudub liigipääs süsteemile</td>
</tr>
<tr>
<td>'''-50203'''</td>
<td>'''Partial data'''</td>
</tr>
<tr>
<td></td>
<td>Päringu vastus sisaldab osalisi andmeid.</td>
</tr>
<tr>
<td>'''-50250'''</td>
<td>'''Credit data sync failed'''</td>
</tr>
<tr>
<td></td>
<td>Tarbijakrediidi andmete sünkroniseerimine (sisestamine, uuendamine, kustutamine) ebaõnnestus</td>
</tr><tr><td>'''-50252'''</td><td>'''Invalid consent document'''</td></tr><tr><td></td><td>Nõusoleku dokument ei ole pre-genereeritud või on vigane digidoc konteiner.</td></tr><tr><td>'''-50300'''</td><td>'''Invalid xml'''</td></tr><tr><td></td><td>Viga xml-s</td></tr></table>

= Lingid =
[[Positiivne_register: funktsionaalne_spetsifikatsioon | Funktsionaalne spetsifikatsioon]]

File:GetMembersResp.png

2017-04-10T11:02:32Z

Julia:

File:GetMembersReq.png

2017-04-10T11:02:26Z

Julia:

Data exchange system X-road interface

2017-04-10T10:46:50Z

Julia: Undo revision 894 by Julia (talk)

{| align="right"
| [[Image:Flag_of_Estonia.svg|border|30px]] [[Andmevahetussüsteemi_X-tee_liides|eesti keeles]]
|}

= Overview =
'''POSR''' is a data exchange system, through which creditors that are members of the system are able to share information about person’s credit obligations.

This document is about services of the system provided by the X-road.

= Use of services in production environment =
For using the services it is needed to be a member of X-Road, to install and configure the Security Server and to receive the rights for using the services from Creditinfo Eesti AS.

To send the request in production environment should the parameter xRoadInstance be "EE" in the header of request. Also, the request should be sent to the production Security Server.

= Use of services in test environment =
Testing of the services is offered by the X-Road test environment. For using the services it is needed to be a member of test-X-Road, to install and configure the Test Security Server and to receive the rights for using the services from Creditinfo Eesti AS.

To send the request in test environment should the parameter xRoadInstance be "ee-test" in the header of request. Also, the request should be sent to the Test Security Server.

It is possible to test the services allowed to use or the [http://x-road.eu/docs/x-road_service_metadata_protocol.pdf X-Road metadata services] like "listMethods" or "allowedMethods". There is no need to have rights for using the metadata services.

= WSDL =
POSR system WSDL can be downloaded on link http://services.krediidiinfo.ee/posr.wsdl

= X-road message =
X-road message is corresponding to the service description
* SOAP envelope
* or is in MIME multipart/related format. First part of the message is SOAP envelope.
Response is a SOAP envelope.

SOAP envelope consists of a header and a body.

== SOAP envelope header ==
Composition of data of the SOAP envelope header responds to [http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf X-road specification].

== SOAP envelope body ==
Composition of data of the SOAP envelope body is described in the present documentation.

== Request soap envelope example ==
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr"
xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>TEST</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReport>
<rep:subject>
<rep:ident_code>00000000000</rep:ident_code>
</rep:subject>
<rep:signed_consent>TEST</rep:signed_consent>
<rep:lang>et</rep:lang>
</posr:getCreditReport>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

== Response soap envelope example==

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="MEMBER" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystemCode>Test</id:subsystemCode>
</xrd:client>
<xrd:service id:objectType="SERVICE" xmlns:xrd="http://x-road.eu/xsd/xroad.xsd" xmlns:id="http://x-road.eu/xsd/identifiers">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>getCreditReport</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">test</xrd:id>
<xrd:userId xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">EE00000000000</xrd:userId>
<xrd:issue xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"/>
<xrd:protocolVersion xmlns:xrd="http://x-road.eu/xsd/xroad.xsd">4.0</xrd:protocolVersion>
<xrd:requestHash algorithmId="http://www.w3.org/2001/04/xmlenc#sha512">Test</xrd:requestHash>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:getCreditReportResponse>
<credit_report xmlns:rep="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/report.xsd"
xmlns:cid="http://www.krediidiinfo.ee/schemas/positive_register/credit/v1/identifiers.xsd">
<rep:consumer_credits>
<rep:consumer_credit>
<cid:type>
<cid:code>CC</cid:code>
<cid:name>Krediitkaart</cid:name>
</cid:type>
<cid:begin_date>2016-07-14</cid:begin_date>
<cid:end_date>2017-07-14</cid:end_date>
<cid:sum>200</cid:sum>
<cid:balance>200</cid:balance>
<cid:unpaid_sum>7</cid:unpaid_sum>
<cid:currency>EUR</cid:currency>
<cid:schedule_payments>
<cid:schedule_payment>
<cid:due_date>2016-10-22</cid:due_date>
<cid:sum>100.0</cid:sum>
</cid:schedule_payment>
</cid:schedule_payments>
<cid:subjects>
<cid:subject>
<cid:ident_code>00000000000</cid:ident_code>
<cid:role>
<cid:code>BRW</cid:code>
<cid:name>Krediidivõtja</cid:name>
</cid:role>
</cid:subject>
</cid:subjects>
<cid:update_datetime>2017-01-01T03:00:00</cid:update_datetime>
</rep:consumer_credit>
</rep:consumer_credits>
<rep:inquiries>
<rep:inquiry>
<cid:datetime>2017-01-02T08:17:30</cid:datetime>
</rep:inquiry>
</rep:inquiries>
</credit_report>
<posr:fault xsi:nil="true"/>
</posr:getCreditReportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Services =

The member can use services if Creditinfo Eesti AS has given him the rights to use them.

== '''generateConsent.v1''' ==
Creation of the document, which provides the requester to inquire person’s credit obligations, whoes consent is given by the digital signature of the document. The consent document format is pdf.
===Request soap envelope body parameters===
[[File:GenerateConsentReq.png|link=]]
===Response soap envelope body parameters===

[[File:GenerateConsentResp.png]]

=== Testing of the service ===
The input parameter ident_code is the identity code of Estonia citizen.

=='''getCreditReport.v1'''==
The request of person’s credit obligations from data repositories of creditors that are members of the data exchange system.

=== Request soap envelope body parameters ===

[[File:GetSubjectPositiveData.png | GetSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:GetSubjectPositiveDataResponse.png | GetSubjectPositiveDataResponse]]

=== Testing of the service ===
The input parameter ident_code is the identity code of Estonia citizen.

The input parameter signed_consent could be the any string encoded by base64 encoding.

== '''insertCredit.v1''' ==

Registration of the person’s credit obligation in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:AddSubjectPositiveData.png | AddSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:AddSubjectPositiveDataResponse.png | AddSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not insert the input data to the database.

== '''updateCredit.v1''' ==
Update of the person’s credit obligation in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:UpdateSubjectPositiveData.png | UpdateSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:UpdateSubjectPositiveDataResponse.png | UpdateSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not update the data in the database.

== '''deleteCredit.v1''' ==
Deletion of the person’s credit obligation from data exchange system repository.

=== Request soap envelope body parameters ===

[[File:DeleteSubjectPositiveData.png | DeleteSubjectPositiveData]]

=== Response soap envelope body parameters ===

[[File:DeleteSubjectPositiveDataResponse.png | DeleteSubjectPositiveDataResponse]]

=== Testing of the service ===
Input parameters should meet the requirements.

As the result the service do not delete the data from the database.

== '''uploadCreditsMtom.v1''' ==
Importing of data of all current credit obligations in data exchange system repository.

=== Request ===

Request is in format MTOM/XOP, which responds to the standard SOAP multipart/related. First part of the message is SOAP envelope. Second part of the message is XML which is zipped by gzip and encoded by base64. XML should be valid according to the schema https://services.krediidiinfo.ee/schemas/positive_register/credit/v1/insert.xsd.

Soap envelope body parameters:

[[File:UploadPositiveDataMtom.png | UploadPositiveDataMtom]]

[[File:Loaninfo debtors.png]]

'''Request example:'''

<pre>
...Other headers
Content-Type: multipart/related; type="application/xop+xml"; start="<xxx>"; start-info="text/xml"; boundary="MIME_boundary"'
MIME-Version: 1.0

--MIME_boundary
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"
Content-Transfer-Encoding: 8bit
Content-ID: <xxx>

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xrd="http://x-road.eu/xsd/xroad.xsd"
xmlns:id="http://x-road.eu/xsd/identifiers"
xmlns:posr="http://www.krediidiinfo.ee/services/posr">
<SOAP-ENV:Header>
<xrd:client id:objectType="SUBSYSTEM">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>00000000</id:memberCode>
<id:subsystenCode>TEST</id:subsystenCode>
</xrd:client>
<xrd:service id:objectType="SERVICE">
<id:xRoadInstance>EE</id:xRoadInstance>
<id:memberClass>COM</id:memberClass>
<id:memberCode>10256137</id:memberCode>
<id:subsystemCode>POSR</id:subsystemCode>
<id:serviceCode>uploadCreditsMtom</id:serviceCode>
<id:serviceVersion>v1</id:serviceVersion>
</xrd:service>
<xrd:id>test</xrd:id>
<xrd:userId>EE00000000000</xrd:userId>
<xrd:protocolVersion>4.0</xrd:protocolVersion>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<posr:uploadCreditsMtom>
<positive_data>
<inc:Include href="cid:xxx"/>
</positive_data>
</posr:uploadCreditsMtom>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

--MIME_boundary
Content-Type: application/octet-stream
Content-Transfer-Encoding: base64
Content-ID: <xxx>
Content-Disposition: attachment;

H4sIAAAAAAAAA12PsW7CQAyGd6S+Q+Q9dxeoRIkIbEx0KpXYoujOCRbEh84uyeM3abtQyfLi///kb7sf+1v2wCQUuYLCOMiQfQzEXQWfp0P+Bvvdy2LrI8tXj6n2CQOpZFOPpaRQwUX1Xlo7DIO5zkeahttoEK34C/aN2HsUUnpgnbAjUUz2F1NTQFZqaXrAjBLgDzsKPXGHlYmps0vnCnt+P378YHNi0YY9QtYhY2oU6zAtpR4rmLN5scyL9cltypUrX9cwi9j/Jrtv1xHpQQQBAAA=

--MIME_boundary--
</pre>

=== Response soap envelope body parameters ===

[[File:UploadPositiveDataMtomResponse.png | UploadPositiveDataMtomResponse]]

=== Testing of the service ===
The attachment in second part of the message could be any string encoded by base64 encoding.

As the result the service do not import the input data to the database.
== '''getUploadStatus.v1''' ==
Requesting of the document status that was created by importing of data of all current credit obligations in data exchange system repository.

=== Request soap envelope body parameters ===

[[File:UploadPositiveDataStatus.png | UploadPositiveDataStatus]]

=== Response soap envelope body parameters ===

[[File:UploadPositiveDataStatusResponse.png | UploadPositiveDataStatusResponse]]

=== Testing of the service ===
The input parameter doc_id could be any number.

The result of the service is any status.

= Technical error =

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>Internal service error</faultstring>
<faultactor/>
<detail>
<faultCode>-50200</faultCode>
<faultString>Internal service error</faultString>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</pre>

= Error codes =
<table>
<tr>
<td>'''-50200'''</td>
<td>'''Internal service''' '''error'''</td>
</tr>
<tr>
<td></td>
<td>Internal service error</td>
</tr>
<tr>
<td>'''-50201'''
'''-50301'''
</td>
<td>'''Invalid request'''</td>
</tr>
<tr>
<td></td>
<td>Invalid request format or data</td>
</tr>
<tr>
<td>'''-50202'''</td>
<td>'''Access denied'''</td>
</tr>
<tr>
<td></td>
<td>User has no permission to use the system</td>
</tr>
<tr>
<td>'''-50203'''</td>
<td>'''Partial data'''</td>
</tr>
<tr>
<td></td>
<td>The data in response is partial</td>
</tr>
<tr>
<td>'''-50250'''</td>
<td>'''Credit data sync failed'''</td>
</tr>
<tr>
<td></td>
<td>Consumer credit data synchronization (insertion, updating, deletion) has failed</td>
</tr><tr><td>'''-50252'''</td><td>'''Invalid consent document'''</td></tr><tr><td></td><td>The consent document has not been pre-generated or is invalid digidoc container.</td></tr><tr><td>'''-50300'''</td><td>'''Invalid xml'''</td></tr><tr><td></td><td>Xml is invalid</td></tr></table>

= Links =
[[Positive_register: functional_specification | Functional specification]]

Data exchange system X-road interface

2017-04-10T10:46:24Z

Julia: Undo revision 895 by Julia (talk)

{| align="right"
| [[Image:Flag_of_Estonia.svg|border|30px]] [[Andmevahetussüsteemi_X-tee_liides|eesti keeles]]
|}

= Overview =
The '''Positive Register''' (Positiivne Register) is the data exchange system, through which creditors that are members of the register are able to share information about person’s credit obligations with consent of the person in question. The Positive Register allows a creditor to fulfill statutory requirements of responsible lending and to ensure a person’s ability to fulfill his or her debt obligations. Loan applicants will no longer have to collect documents from other creditors. Customer will also be better protected from the problems associated with making emotional decisions about loans and excessive debts.

= Definitions =

* '''Data''' – information about existing obligations of a private person that allows the Member to assess creditworthiness of the individual.
* '''Data exchange system''' – the IT solution used by the Member to exchange the Data;
* '''Manager of the data exchange system''' – Creditinfo Eesti AS;
* '''Codebtor''' – a private person together with whom the Applicant applies for credit and who is taken into account while making the Credit decision;
* '''Credit decision''' – the decision made by the Member with regard to concluding the Consumer credit contract with the Applicant;
* '''Borrower''' – a private person to whom the Member issues the credit based on the Consumer credit contract;
* '''Applicant''' – a private person who turns to the Member with the wish to conclude the Consumer credit contract and provides his/her Agreement for using the Data possessed by the Members;
* '''Guarantor''' – a person who assumes the obligation before the Member to be liable for performance of the Consumer credit contract obligations of the Applicant;
* '''Consent '''– consent of the Applicant for providing the Member making the inquiry with the Data of the Members being the recipients of the inquiry;
* '''Member''' – an Estonian that joins the Data exchange system and shares the Data about the Applicant with other Members;
* '''Consumer credit contract''' – the contract on the basis of which the Member issues the credit to the Applicant;
* '''Subject''' – a party to the contract;
* '''Consumer credit''' – the credit issued to the Applicant by the Member.

= Business rules =

* Users of the system are the ''Members''.
* A ''Member'' must join X-road.
* The ''Member'' inputs ''Data'' to the database of ''Data exchange system'' or provides ''Manager of the data exchange system'' with an IT-based solution to obtain the ''Data'' from him's database.
* The ''Member'' updates the ''Data'' by sending to the ''Data exchange system'' all current ''Data or Consumer credit contract data one by one''.
* The ''Member'' updates the ''Data'' every 24 hours. At least every 7 days.
* The ''Member'' requests the ''Data'' only with the ''Applicant'' prior ''Consent''. If the ''Consent'' is not assigned digitally, then the requester has no permission to request ''Data'' from databases of other Members, who has a condition of existence of digitally signed ''Consent'' for data requesting and forwarding.
* The ''Consent'' document is stored in the ''Data exchange system'' for 3 years.
* The response to the ''Data'' request does not reflect information about the ''Member''.
* Composition of the response to the ''Data'' request is described in “Data composition” chapter.
* The ''Members'' share the ''Data'' with other Members in equal data composition.

= Data composition=

# Date and time of updating data;
# Person identity code;
# Role of the person within the scope of the contract;
# Contract number;
# Type of consumer credit;
# Effective date of credit agreement – date of commencement of the Consumer credit contract;
# End date of credit – the date of repayment of the Consumer credit;
# Consumer credit sum – the maximum sum of the Consumer credit paid or payable to the Applicant;
# Currency – currency of the Consumer credit;
# Schedule payments – the sum and the due date of the next or the closest three payments;
# Balance – the amount of the obligation of the consumer before the Member;
# Overdue balance – the sum of payments overdue for more than 7 days;
# Requests – dates of requests made with regard to the Data of the Applicant made during the past three years.
'''Roles of the person'''
#Borrower
#Codebtor
#Guarantor
'''Types of credit'''
#Secured loan
#Hire-purchase
#Unsecured loan
#Lease
#Credit card
#Other

= Use cases =

[[File:Positive register use cases.jpg]]

== Members list request ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the list of other Members for using it while consent document creation.

== Consent document creation ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the consent document of the Applicant for inquiring hims/hers Data possessed by the Members;
== Credit report request ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' If the consent document is an input of the request, this should had been generated in the Data exchange system.
# Member sends a request to the Data exchange system to get Applicant's credit obligations;
# Data exchange system queries the Data from the database;
# Data exchange system responses to the requester with the Data.
Extension
* Member has a condition of existence of the digitally signed ''Consent'' for data requesting from repository and the digitally signed consent is not an input of the request
::2a. Data Exchange System does not request the Data from Member's repository;

::3a. Data Exchange System response includes information about undone request.

* Data repository of the member is stored in Member's system
::2a. Data exchange system queries the Data from Members' systems
* Quering of the Data from Member's system fails
::3a. Data exchange system responses to the requester with the Data and with the error message that includes the number of failed queries.

== Credit data management ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' The Member has concluded the authorization agreement with Data exchange system manager, under which the Member issues to Data exchange system manager the rights of authorized data processor with regard to the database held by the Member.

The Member forwards credit data from the database held by the Member to Data exchange system.

[[File:Credit data management use case.jpg]]

'''Scenarios'''

'''A)''' The Member forwards all current data on consumer credits to the Data exchange system.

'''B)''' The Member changes the consumer credit data in the Data exchange system database.

== Manager data management ==

Data exchange system manager registers information about the Member in the Data exchange system / removes such information from the Data exchange system.

= Sequence diagram =
The following diagram describes the process of credit decision when
::1. the Applicant signes the consent digitally
::[[File:Credit decision using digi consent.jpg]]

::2. the Applicant do not sign the consent digitally
::[[File:Credit decision using digi consent.jpg]]

= Links =
[[X-road interface: subsystem POSR|Data exchange system X-road interface]]

Data exchange system X-road interface

2017-04-10T10:46:12Z

Julia: Undo revision 896 by Julia (talk)

Positive register: functional specification

2017-04-10T10:45:15Z

Julia:

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

= Overview =
The '''Positive Register''' (Positiivne Register) is the data exchange system, through which creditors that are members of the register are able to share information about person’s credit obligations with consent of the person in question. The Positive Register allows a creditor to fulfill statutory requirements of responsible lending and to ensure a person’s ability to fulfill his or her debt obligations. Loan applicants will no longer have to collect documents from other creditors. Customer will also be better protected from the problems associated with making emotional decisions about loans and excessive debts.

= Definitions =

* '''Data''' – information about existing obligations of a private person that allows the Member to assess creditworthiness of the individual.
* '''Data exchange system''' – the IT solution used by the Member to exchange the Data;
* '''Manager of the data exchange system''' – Creditinfo Eesti AS;
* '''Codebtor''' – a private person together with whom the Applicant applies for credit and who is taken into account while making the Credit decision;
* '''Credit decision''' – the decision made by the Member with regard to concluding the Consumer credit contract with the Applicant;
* '''Borrower''' – a private person to whom the Member issues the credit based on the Consumer credit contract;
* '''Applicant''' – a private person who turns to the Member with the wish to conclude the Consumer credit contract and provides his/her Agreement for using the Data possessed by the Members;
* '''Guarantor''' – a person who assumes the obligation before the Member to be liable for performance of the Consumer credit contract obligations of the Applicant;
* '''Consent '''– consent of the Applicant for providing the Member making the inquiry with the Data of the Members being the recipients of the inquiry;
* '''Member''' – an Estonian that joins the Data exchange system and shares the Data about the Applicant with other Members;
* '''Consumer credit contract''' – the contract on the basis of which the Member issues the credit to the Applicant;
* '''Subject''' – a party to the contract;
* '''Consumer credit''' – the credit issued to the Applicant by the Member.

= Business rules =

* Users of the system are the ''Members''.
* A ''Member'' must join X-road.
* The ''Member'' inputs ''Data'' to the database of ''Data exchange system'' or provides ''Manager of the data exchange system'' with an IT-based solution to obtain the ''Data'' from him's database.
* The ''Member'' updates the ''Data'' by sending to the ''Data exchange system'' all current ''Data or Consumer credit contract data one by one''.
* The ''Member'' updates the ''Data'' every 24 hours. At least every 7 days.
* The ''Member'' requests the ''Data'' only with the ''Applicant'' prior ''Consent''. If the ''Consent'' is not assigned digitally, then the requester has no permission to request ''Data'' from databases of other Members, who has a condition of existence of digitally signed ''Consent'' for data requesting and forwarding.
* The ''Consent'' document is stored in the ''Data exchange system'' for 3 years.
* The response to the ''Data'' request does not reflect information about the ''Member''.
* Composition of the response to the ''Data'' request is described in “Data composition” chapter.
* The ''Members'' share the ''Data'' with other Members in equal data composition.

= Data composition=

# Date and time of updating data;
# Person identity code;
# Role of the person within the scope of the contract;
# Contract number;
# Type of consumer credit;
# Effective date of credit agreement – date of commencement of the Consumer credit contract;
# End date of credit – the date of repayment of the Consumer credit;
# Consumer credit sum – the maximum sum of the Consumer credit paid or payable to the Applicant;
# Currency – currency of the Consumer credit;
# Schedule payments – the sum and the due date of the next or the closest three payments;
# Balance – the amount of the obligation of the consumer before the Member;
# Overdue balance – the sum of payments overdue for more than 7 days;
# Requests – dates of requests made with regard to the Data of the Applicant made during the past three years.
'''Roles of the person'''
#Borrower
#Codebtor
#Guarantor
'''Types of credit'''
#Secured loan
#Hire-purchase
#Unsecured loan
#Lease
#Credit card
#Other

= Use cases =

[[File:Positive register use cases.jpg]]

== Members list request ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the list of other Members for using it while consent document creation.

== Consent document creation ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the consent document of the Applicant for inquiring hims/hers Data possessed by the Members;
== Credit report request ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' If the consent document is an input of the request, this should had been generated in the Data exchange system.
# Member sends a request to the Data exchange system to get Applicant's credit obligations;
# Data exchange system queries the Data from the database;
# Data exchange system responses to the requester with the Data.
Extension
* Member has a condition of existence of the digitally signed ''Consent'' for data requesting from repository and the digitally signed consent is not an input of the request
::2a. Data Exchange System does not request the Data from Member's repository;

::3a. Data Exchange System response includes information about undone request.

* Data repository of the member is stored in Member's system
::2a. Data exchange system queries the Data from Members' systems
* Quering of the Data from Member's system fails
::3a. Data exchange system responses to the requester with the Data and with the error message that includes the number of failed queries.

== Credit data management ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' The Member has concluded the authorization agreement with Data exchange system manager, under which the Member issues to Data exchange system manager the rights of authorized data processor with regard to the database held by the Member.

The Member forwards credit data from the database held by the Member to Data exchange system.

[[File:Credit data management use case.jpg]]

'''Scenarios'''

'''A)''' The Member forwards all current data on consumer credits to the Data exchange system.

'''B)''' The Member changes the consumer credit data in the Data exchange system database.

== Manager data management ==

Data exchange system manager registers information about the Member in the Data exchange system / removes such information from the Data exchange system.

= Sequence diagram =
The following diagram describes the process of credit decision when
::1. the Applicant signes the consent digitally
::[[File:Credit decision using digi consent.jpg]]

::2. the Applicant do not sign the consent digitally
::[[File:Credit decision using digi consent.jpg]]

= Links =
[[Data exchange system X-road interface|Data exchange system X-road interface]]

Positiivne register: funktsionaalne spetsifikatsioon

2017-04-10T10:44:13Z

Julia:

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

= Sissejuhatus =
'''Positiivne Register''' on andmevahetussüsteem, mille kaudu registri liikmeks olevad krediteerijad saavad eraisiku nõusolekul vahetada infot tema laenukohustuste kohta. Positiivne Register võimaldab laenuandjal täita seadusest tulenevat vastutustundliku laenamise nõuet ning veenduda inimese võimes täita oma laenukohustust. Laenuklient ei pea enam tooma paberkandjal väljavõtteid teiste laenuandjate juurest ning on paremini kaitstud emotsionaalsete laenuotsuste ja ülelaenamisest tekkivate probleemide eest.

= Mõisted =

* '''Andmed''' – andmed tarbija olemasolevate kohustuste kohta, mis võimaldavad Osalejal hinnata tarbija krediidivõimelisust;
* '''Andmevahetussüsteem''' (''Data exchange system '') – infotehniline rakendus, mille vahendusel Osalejad vahetavad Andmeid;
* '''Andmevahetussüteemi haldaja''' (''Data exchange system manager'') – Creditinfo Eesti AS;
* '''Krediiditaotleja''' (''consumer'') - eraisik, kes on pöördunud Osaleja poole tarbijakrediidilepingu sõlmimise sooviga.
* '''Krediidisaaja''' (''consumer'') – eraisik, kellele Osaleja on väljastanud tarbijakrediidilepingu alusel krediidi.
* '''Tarbijakrediit''' (''consumer credit'') – Osaleja poolt Krediidisaajale väljastatud krediit;
* '''Krediidiotsus''' (''credit decision'') – Osaleja poolt langetatav otsus tarbijakrediidilepingu sõlmimiseks Kreediiditaotlejaga;
* '''Tarbijakrediidileping''' (''consumer credit contract'') – leping, mille alusel on Osaleja väljastanud Krediidisaajale krediidi;
* '''Kaastaotleja''' (''codebtor'') - isik, kellega Krediiditaotleja koos krediiti taotleb ja kelle sissetulekud ning varad võetakse Krediidiotsuse tegemisel arvesse;
* '''Käendaja''' (''guarantor'') - isik, kes võtab Osaleja ees kohustuse vastutada Krediidisaaja Tarbijakrediidi kohustuse täitmise eest;
* '''Tarbijakrediidilepingu subjekt''' (''subject'')- lepingu osapool;
* '''Osaleja''' (''member'') – Andmevahetussüsteemiga liitunud Eesti, kes jagab temale teadaolevaid Andmeid Krediiditaotleja kohta samaväärses koosseisus teiste Osalejatega;
* '''Krediiditaotleja nõusolek''' (''consent'') - Krediiditaotleja nõusolek päringu adressaatideks olevatele Osalejatele Krediiditaotleja Andmete edastamiseks päringu teinud Osalejale.

= Ärireeglid =
* ''Andmevahetussüsteemi'' kasutajad on ''Osalejad''.
* ''Osaleja'' peab olema liitunud X-teega.
* ''Osaleja'' sisestab ''Andmed'' ''Andmevahetussüsteemi haldaja ''andmebaasi või tekitab ''Andmevahetussüsteemi haldajale ''tehnoloogiline võimalus ''Andmeid'' pärida oma ''Andmekogust.''
* ''Osaleja'' uuendab ''Andmed'' edastades ''Andmevahetussüsteemi haldajale ''kas kõik kehtivad ''Andmed'' või ''Tarbijakrediidilepingu'' kaupa.
* ''Osaleja'' uuendab ''Andmed'' iga 24 tunni järel. Äärmisel juhul kuni 7 päeva järel.
* ''Osaleja'' pärib ''Krediiditaotleja'' kohta ''Andmeid'' tema ''Nõusoleku'' olemaolul. Kui ''Nõusolek'' ei ole digitaalselt allkirjastatud, siis pärijal ei ole õigust saada ''Andmeid'' teistelt ''Osalejatelt'', kes on seadnud päringule vastamise ja ''Andmete'' edastamise tingimuseks digitaalselt allkirjastatud ''Nõusoleku'' olemasolu.
* ''Nõusoleku'' dokument säilib ''Andmevahetussüsteemis'' 3 aastat.
* ''Admete'' päringu vastus ei kajasta andmeid ''Osaleja'' kohta.
* ''Andmete'' päringu vastus ei sisalda päringut teinud ''Osaleja Andmekogust'' ''Andmeid''.
* ''Andmete'' päringu vastuse koosseis kirjeldatud peatükis "Andmete koosseis".
* ''Osalejad'' jagavad ''Andmeid'' samaväärses koosseisus teiste ''Osalejatega.''

== Andmete kooseis ==
#Uuendamise kuupäev ''(update date and time)''
#Isikukood ''(identity code)''
#Isiku roll ''(role)'' antud lepingu raames
#Lepingu number (''contract number'') - Osaleja ja Krediidisaaja vahel sõlmitud Tarbijakrediidilepingu number;
#Krediidi liik (''type of credit'')
#Krediidi algus (''effective date of credit agreement'') – Tarbijakrediidilepingu kehtivuse alguskuupäev
#Krediidi lõpp (end date of credit) – Kuupäev, millal Tarbijakrediit tuleb tagastada
#Krediidi summa (''credit sum'') - Krediidisaajale väljamakstud või väljamaksmisele kuuluv maksimaalne Tarbijakrediidi summa;
#Krediidi valuuta (''credit currency'') - Tarbijakrediidi valuuta;
#Maksegraafik (''schedule payments'') – Järgmise või lähima kolme väljamakse summa ja tähtaeg;
#Hetkesaldo (''balance'') - Tarbija kohustuse suurus Osaleja ees;
#Üle tähtaja saldo (''days over net balance'') – 7 päeva üle maksetähtaja hilinenud maksete summa.
#Päringud ''(inquiries)'' – Krediidisaaja kohta Andmete saamiseks viimase kolme aasta jooksul tehtud päringute kuupäevad.

'''Isiku rollid'''

# Krediidisaaja (''borrower'')
# Kaastaotleja (''codebtor'')
# Käendaja (''guarantor'')

'''Krediidi liigid'''

# Tagatisega laen (''secured loan'')
# Järelmaks (''hire-purchase'')
# Tagatiseta laen (''unsecured loan)''
# Liising (''lease'')
# Krediitkaart (''credit card'')
# Muu (''other'')

= Kasutuslood =
[[File:Positive register use cases.jpg]]

== Members list request ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja pärib teiste Osalejate nimekirja et kasutada see nõusoleku dokumendi tekstis.

== Consent document creation / Nõusoleku dokumendi koostamine ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja pärib Andmevahetussüsteemis koostatud Krediiditaotleja Nõusoleku dokumendi tema Andmete pärimiseks Osalejate andmekogudest.

== Credit report request / Andmete pärimine ==
'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

'''Eeldus''': Kui päringu sisendiks on nõusoleku dokument, siis see peab olema eelnevalt koostatud Andmevahetussüsteemis.
# Osaleja edastab päringu Andmevahetussüsteemi Krediiditaotleja krediidikohustuste pärimiseks;
# Andmevahetussüsteem kogub Andmeid andmebaasist;
# Andmevahetussüsteem edastab kogutud Andmed päringut teinud Osalejale.
Laiendused:
* Osaleja on seadnud päringule vastamise ja Andmete edastamise tingimuseks digitaalselt allkirjastatud Nõusoleku olemasolu ja seda ei ole edastatud päringuga

::2a. Andmevahetussüsteem ei edasta päringut Andmeid Osaleja andmekogusse;

::3a. Andmevahetussüsteem edastab veateadet mis sisaldab infot mitte edastatud päringu kohta.

* Andmed säilivad Osaleja peetavas andmekogus.
::2a. Andmevahetussüsteem kogub Andmeid Osalejate peetavatest andmekogudest.
* Andmete pärimine Osaleja peetavast andmekogust ebaõnnestub
::3a. Andmevahetussüsteem edastab päringu teinud Osalejale kogutud Andmeid ning ebaõnnestunud päringute arvu sisaldavat veateadet.

== Credit data management / Andmete haldus ==

Eeldus: Osaleja on sõlminud käsunduslepingu Andmevahetussüsteemi haldajaga, millega ta on andnud tema peetava andmekogu volitatud töötleja õigused Andmevahetussüsteemi haldajale.

'''Eeldus''': Osalejal on õigused antud teenuse kasutamiseks Andmevahetussüsteemi haldaja poolt.

Osaleja edastab tema peetava andmekogu andmed Andmevahetussüsteemi haldajale.

[[File:Credit data management use case.jpg]]

Stsenaariumid

A) Osaleja edastab kõik kehtivad tarbijakrediitide andmed Andmevahetussüsteemi haldajale.

B) Osaleja uuendab tarbijakrediidiandmed Andmevahetussüteemis.

== Manager data management / Osaleja andmete haldus ==
Andmevahetussüsteemi haldaja registreerib/kustutab Osaleja kohta andmeid Andmevahetussüteemis.

= Tegevusdiagrammid =

Allolevad tegevusdiagrammid ilustreerivad krediiditaotleja krediidivõimelisuse hindamise protsessi juhul kui

1. Krediiditaotleja allkirjastab Nõusolekut digitaalselt
[[File:Credit decision using digi consent.jpg]]

2. Krediiditaotleja Nõusolek ei ole digitaalselt allkirjastatud
[[File:Credit decision using digi consent.jpg]]

= Lingid =
* [[X-tee liides: alamsüsteem POSR|Andmevahetussüsteemi X-tee liides]]

Data exchange system X-road interface

2017-04-10T10:41:46Z

Julia: /* Links */

{| align="right"
| [[Image:Flag_of_Estonia.svg|border|30px]] [[Andmevahetussüsteemi_X-tee_liides|eesti keeles]]
|}

= Overview =
The '''Positive Register''' (Positiivne Register) is the data exchange system, through which creditors that are members of the register are able to share information about person’s credit obligations with consent of the person in question. The Positive Register allows a creditor to fulfill statutory requirements of responsible lending and to ensure a person’s ability to fulfill his or her debt obligations. Loan applicants will no longer have to collect documents from other creditors. Customer will also be better protected from the problems associated with making emotional decisions about loans and excessive debts.

= Definitions =

* '''Data''' – information about existing obligations of a private person that allows the Member to assess creditworthiness of the individual.
* '''Data exchange system''' – the IT solution used by the Member to exchange the Data;
* '''Manager of the data exchange system''' – Creditinfo Eesti AS;
* '''Codebtor''' – a private person together with whom the Applicant applies for credit and who is taken into account while making the Credit decision;
* '''Credit decision''' – the decision made by the Member with regard to concluding the Consumer credit contract with the Applicant;
* '''Borrower''' – a private person to whom the Member issues the credit based on the Consumer credit contract;
* '''Applicant''' – a private person who turns to the Member with the wish to conclude the Consumer credit contract and provides his/her Agreement for using the Data possessed by the Members;
* '''Guarantor''' – a person who assumes the obligation before the Member to be liable for performance of the Consumer credit contract obligations of the Applicant;
* '''Consent '''– consent of the Applicant for providing the Member making the inquiry with the Data of the Members being the recipients of the inquiry;
* '''Member''' – an Estonian that joins the Data exchange system and shares the Data about the Applicant with other Members;
* '''Consumer credit contract''' – the contract on the basis of which the Member issues the credit to the Applicant;
* '''Subject''' – a party to the contract;
* '''Consumer credit''' – the credit issued to the Applicant by the Member.

= Business rules =

* Users of the system are the ''Members''.
* A ''Member'' must join X-road.
* The ''Member'' inputs ''Data'' to the database of ''Data exchange system'' or provides ''Manager of the data exchange system'' with an IT-based solution to obtain the ''Data'' from him's database.
* The ''Member'' updates the ''Data'' by sending to the ''Data exchange system'' all current ''Data or Consumer credit contract data one by one''.
* The ''Member'' updates the ''Data'' every 24 hours. At least every 7 days.
* The ''Member'' requests the ''Data'' only with the ''Applicant'' prior ''Consent''. If the ''Consent'' is not assigned digitally, then the requester has no permission to request ''Data'' from databases of other Members, who has a condition of existence of digitally signed ''Consent'' for data requesting and forwarding.
* The ''Consent'' document is stored in the ''Data exchange system'' for 3 years.
* The response to the ''Data'' request does not reflect information about the ''Member''.
* Composition of the response to the ''Data'' request is described in “Data composition” chapter.
* The ''Members'' share the ''Data'' with other Members in equal data composition.

= Data composition=

# Date and time of updating data;
# Person identity code;
# Role of the person within the scope of the contract;
# Contract number;
# Type of consumer credit;
# Effective date of credit agreement – date of commencement of the Consumer credit contract;
# End date of credit – the date of repayment of the Consumer credit;
# Consumer credit sum – the maximum sum of the Consumer credit paid or payable to the Applicant;
# Currency – currency of the Consumer credit;
# Schedule payments – the sum and the due date of the next or the closest three payments;
# Balance – the amount of the obligation of the consumer before the Member;
# Overdue balance – the sum of payments overdue for more than 7 days;
# Requests – dates of requests made with regard to the Data of the Applicant made during the past three years.
'''Roles of the person'''
#Borrower
#Codebtor
#Guarantor
'''Types of credit'''
#Secured loan
#Hire-purchase
#Unsecured loan
#Lease
#Credit card
#Other

= Use cases =

[[File:Positive register use cases.jpg]]

== Members list request ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the list of other Members for using it while consent document creation.

== Consent document creation ==
'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

Member requests the consent document of the Applicant for inquiring hims/hers Data possessed by the Members;
== Credit report request ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' If the consent document is an input of the request, this should had been generated in the Data exchange system.
# Member sends a request to the Data exchange system to get Applicant's credit obligations;
# Data exchange system queries the Data from the database;
# Data exchange system responses to the requester with the Data.
Extension
* Member has a condition of existence of the digitally signed ''Consent'' for data requesting from repository and the digitally signed consent is not an input of the request
::2a. Data Exchange System does not request the Data from Member's repository;

::3a. Data Exchange System response includes information about undone request.

* Data repository of the member is stored in Member's system
::2a. Data exchange system queries the Data from Members' systems
* Quering of the Data from Member's system fails
::3a. Data exchange system responses to the requester with the Data and with the error message that includes the number of failed queries.

== Credit data management ==

'''Prerequisite:''' Data exchange system manager has given a permission to Member to make a request.

'''Prerequisite:''' The Member has concluded the authorization agreement with Data exchange system manager, under which the Member issues to Data exchange system manager the rights of authorized data processor with regard to the database held by the Member.

The Member forwards credit data from the database held by the Member to Data exchange system.

[[File:Credit data management use case.jpg]]

'''Scenarios'''

'''A)''' The Member forwards all current data on consumer credits to the Data exchange system.

'''B)''' The Member changes the consumer credit data in the Data exchange system database.

== Manager data management ==

Data exchange system manager registers information about the Member in the Data exchange system / removes such information from the Data exchange system.

= Sequence diagram =
The following diagram describes the process of credit decision when
::1. the Applicant signes the consent digitally
::[[File:Credit decision using digi consent.jpg]]

::2. the Applicant do not sign the consent digitally
::[[File:Credit decision using digi consent.jpg]]

= Links =
[[Data exchange system X-road interface|Data exchange system X-road interface]]