Specyfikacja formatu Tovi 3.0

T O V I 3. 0
UPROSZCZONE
ODPYTYWANIE KRD
SPECYFIKACJA PLIKU
Wersja 1.0 Z dnia 2013.05.09
Numer dokumentu
2007/IT-P/01
Kategoria dokumentu
Projekt
Status dokumentu
Opracowanie zewnętrzne
Słowa kluczowe
Biuro Informacji Gospodarczej, BIG, Rahl, Nicci, Siddin, Transza, Web Service
Spis treści
SPIS TREŚCI ....................................................................................................... 2
SPIS TABEL ........................................................................................................ 3
WSTĘP ................................................................................................................ 4
1. DANE POZYSKIWANE Z BIURA, INFORMACJE NIEZBEDNE DO PRAWIDŁOWEGO
ODPYTYWANIA ................................................................................................... 5
2.
POBIERANE INFORMACJE GOSPODARCZE .................................................... 5
Spis tabel
Tabela 1 : Dane merytoryczne transzy z zapytaniami ................................................. 5
Tabela 2 : Pobierane informacje gospodarcze ............................................................ 6
Wstęp
Protokół Tovi jest odpowiedzią na potrzeby tych klientów, którzy chcą pobierać
informacje gospodarcze z Krajowego Rejestru długów w sposób masowy i w uproszczonej
formie wymiany danych, posługując się plikami tekstowymi formatu CSV. W związku z
zastosowaniem powyższej, uproszczonej formy wysyłania zapytań oraz otrzymywania
odpowiedzi informacje przekazywane klientowi poprzez protokół Tovi są ograniczone w
stosunku do pełnych danych, jakie można pozyskać za pomocą pliku XML (przy
zastosowaniu protokołu NICCI). W pliku zwrotnym protokołu Tovi przekazywane są
informacje o ilości zobowiązań, ilości wszystkich informacji gospodarczych, razem z
pozytywnymi oraz z podrobionymi dokumentami, ilości odnalezionych wierzycieli oraz o
całkowitej kwocie zadłużenia.
Ograniczenia powyższe zostały nałożone w związku z konstrukcją pliku tekstowego CSV,
która uniemożliwia przekazanie pełnych danych, jakie można odnaleźć w raporcie
pozyskanym poprzez protokół NICCI (plik XML)
Dokument ten opisuje strukturę pliku CSV, który jest zgodny z protokołem Tovi.
Komunikację z serwisem KRD zapewnia dla protokołu Tovi program Kliencki Sabar.
1. Dane pozyskiwane z biura, informacje niezbędne do
prawidłowego odpytywania
Zgodnie z ustawą o udostępnianiu informacji gospodarczej protokół Tovi 3.0 umożliwia
pobieranie informacji gospodarczej zarówno o osobach fizycznych jak i o firmach.
Równocześnie użycie powyższego protokołu jest ograniczone ustawowymi obostrzeniami.
Aby poprawnie pobrać informację gospodarczą należy w przygotowywanym pliku transzy
wprowadzić poza kodem operacji inne informacje niezbędne do prawidłowego odpytania
bazy KRD. W pierwszej kolumnie należy podać typ wyszukiwania, zgodny z tabelą
poniżej. Druga, trzecia i czwarta kolumna zostają puste, gdyż w nich znajdują się
odpowiedzi systemowe. Gdy pożądana informacja ma dotyczyć konsumenta wymaganym
jest również uzupełnienie kolumny nr 7. Przy pytaniu o sobie kolumna 6 i 7 pozostaje
pusta.
Tabela 1: Dane merytoryczne transzy z zapytaniami
Nr
Nazwa
Code
Opis
Typ operacji
2
Extensions
Status
Status
przetwarzania
Liczba
całkowita
1
Error
Opis błędu,
jeżeli status: 2
Kod błędu
Tekst
512
ErrorCode
Liczba
całkowita
3
Kryteria
wyszukiwania
Tekst
16
5
SearchCriteria

6
AuthorizationDate
7
Długość

3
4
Typ
danych
Liczba
całkowita
1
2
W
Data
upoważnienia
konsumenta
Data
Uwagi
1 – wyszukanie konsumenta z Polski
2 – wyszukanie konsumenta z innego kraju
3 – wyszukanie firmy lub instytucji z Unii Europejskiej
4 – wyszukanie firmy lub instytucji spoza Unii
Europejskiej
5 – wyszukanie siebie
6 – wyszukiwanie informacji o podrobionym
dokumencie
Pole zarezerwowane dla przyszłego użycia
Kod wyniku przetwarzania zwracany po
przetworzeniu zlecenia:
1 – zlecenie przetworzone poprawnie
0 – błąd podczas przetwarzania zlecenia
Pełny opis błędu, jeżeli wystąpił
0 – Nieznany błąd
1 – Brak uprawnień do wykonania danej operacji
23 – Błąd walidacji
Numer identyfikacyjny dłużnika, którego chcemy
wyszukać.
Dla pola Code = 1 – będzie to numer PESEL.
Dla pola Code = 2 – będzie to inny numer
identyfikacyjny.
Dla pola Code = 3 – będzie to numer NIP.
Dla pola Code = 4 – będzie to inny numer
identyfikacyjny.
Dla pola Code = 5 – pole jest ignorowane.
Dla pole Code = 6 – imię i nazwisko właściciela
dokumentu.
Wymagane, gdy pole Code jest równe 1 lub 2. W
przeciwnym wypadku puste.
Format: rrrr-MM-dd
Przykład: 2011-04-01 (1 kwietnia 2011 roku)
2. Pobierane informacje gospodarcze
Transza Tovi, która jest wysyłana za pomocą programu Sabar do KRD poza kolumnami z
punktu 1 poniższego dokumentu, zawiera 5 kolumn, które zostaną uzupełnione o
odpowiednie informacje przez system, jeśli zapytanie będzie trafne.
Zwracane informację stanowią sumaryczny wynik przeszukania bazy KRD.
W wyniku odnalezienia w bazie numeru identyfikacyjnego transza zwrotna zawiera liczbę
zobowiązań, liczbę wszystkich informacji gospodarczych, liczbę wierzycieli, całkowitą
kwotę zadłużenia, ilość poszczególnych rodzajów zobowiązań (negatywne, pozytywne
oraz o dokumencie), średnią wartość spłaty zobowiązania, średni czas spłaty
zobowiązania (w dniach) oraz opcjonalnie sumaryczną wartość spłaconych zobowiązań.
Wszystkie kwoty podawane są w walucie polskiej (PLN).
Tabela 2: Pobierane informacje gospodarcze
Nr
Nazwa
8
9
10
CreditorCount
ObligationCount
TotalArrears
PaidObligationCreditorCount
11
12
13
14
15
16
17
PaidObligationCount
AveragePaidDebt
AveragePaymentTimeInDays
SumPaidDebt
MaxOverdueDays
DocumentInformationCount
Opis
Ilość wierzycieli dłużnika
Ilość zobowiązań w raporcie
Całkowita kwota zadłużenia
Ilość wierzycieli dłużnika dla
spłaconych zobowiązań
Ilość pozytywnych zobowiązań
Średnia wartość spłaty zobowiązania
Średni czas spłaty zobowiązań
Suma spłaconych zobowiązań
Maksymalna ilość dni opóźnienia
Ilość informacji o posłużeniu się
cudzym lub podrobionym
dokumentem
Typ danych
Długość
Liczba całkowita
Liczba całkowita
Liczba rzeczywista
Liczba całkowita
10
10
18
10
Liczba całkowita
Liczba rzeczywista
Liczba całkowita
Liczba rzeczywista
Liczba całkowita
Liczba całkowita
10
18
10
18
10
10
KONIEC DOKUMENTU
Uwagi