services.krediidiinfo.ee - User contributions [en]

KiCreditRegister en

2025-05-06T14:18:03Z

Annika:

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

= Introduction =

KiCreditRegister is a Web Service based on SOAP protocol for updating payment defaults information in the Payment Defaults Register.

= WSDL =

The WSDL for KiCreditRegister is available at: https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Methods=

== add==

Add a payment default to the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| debtSum
| xs:int
| Amount of the payment default
|-
|
| beginDate
| xs:date
| Start date of the payment default
|-
|
| endDate
| xs:date
| End date of the payment default. If not ended, value is NULL
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the addition was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Error Codes | listed here]].
|}

== updateDebtSum ==

Update the amount of a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| newDebtSum
| xs:int
| New amount of the payment default
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the update was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Error Codes | listed here]].
|}

== end ==

End a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| endDate
| xs:date
| End date of the payment default
|-
| Väljundparameeter:
| resultCode
| xs:int
| 0 if the ending was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Error Codes | listed here]].
|}

== remove==

Submit a request to delete a payment default from the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the request was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Error Codes | listed here]].
|}

== getOwnedDebtorPaymentDefaults ==

Retrieve payment defaults submitted by the owner for a debtor.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
| Output parameter:
| xml
| xs:string
| List of payment defaults submitted by the owner for this debtor. XML schema available at: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Error Codes=
{| style="border-style: solid; border-width: 1px;"
!
! Code
! Description
|-
|
| -13110
| Unknown error
|-
|
| -13111
| Error in personal ID/business code
|-
|
| -13112
| Error in payment default amount
|-
|
| -13113
| Payment default amount below the minimum allowed
|-
|
| -13114
| Error in start date
|-
|
| -13115
| Error in start date, payment default is too recent
|-
|
| -13116
| Error in end date
|-
|
| -13117
| Error in end date, start date must be before end date
|-
|
| -13118
| Error in end date, payment default too old to register
|-
|
| -13119
| Error in end date, end date cannot be in the future
|-
|
| -13122
| Error in contract number
|-
|
| -13123
| Error in contract number, number too long
|-
|
| -13124
| Error in payment default number
|-
|
| -13125
| Error in payment default number, number too long
|-
|
| -13126
| Error in default currency
|-
|
| -13131
| Payment default not found
|-
|
| -13133
| Payment default already exists
|-
|
| -13135
| No permission to add/edit payment defaults for the company
|-
|
| -13136
| No permission to add/edit payment defaults for the individual
|-
|
| -13137
| Operation not allowed, payment default already deleted
|-
|
| -13138
| Operation not allowed, payment default is disputed
|-
|
| -13139
| No permission to modify this payment default
|}

KiCreditRegister

2025-05-06T14:16:56Z

Annika:

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

= Tutvustus =

KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris.

= WSDL =

KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Meetodid =

== add==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| debtSum
| xs:int
| Maksehäire summa.
|-
|
| beginDate
| xs:date
| Maksehäire tekkimise kuupäev
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev. Kui maksehäire ei ole lõppenud, siis on parameetri väärtuseks NULL.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lisamine õnnestus. Negatiivsete väärtuste korral maksehäire lisamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== updateDebtSum ==

Maksehäire summa muutmine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| newDebtSum
| xs:int
| Maksehäire uus summa.
|-
| Väljundparameeter:
| resultCode
| xs:int
|Kui 0, siis maksehäire summa muutmine õnnestus. Negatiivse väärtuse korral maksehäire summa muutmine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== end ==

Maksehäire lõpetamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lõpetamine õnnestus. Negatiivse väärtuse korral maksehäire lõpetamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== remove==

Maksehäire registrist kustutamise soovi edastamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire kustutamise soovi edastamine õnnestus. Negatiivse väärtuse korral maksehäire kustutamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== getOwnedDebtorPaymentDefaults ==

Maksehäire omaniku poolt lisatud võlgniku maksehäirete info pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
| Väljundparameeter:
| xml
| xs:string
| Maksehäire omaniku poolt võlgniku kohta registrisse kantud maksehäired. XML on skeemiga: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Veakoodid =
{| style="border-style: solid; border-width: 1px;"
!
! Kood
! Kirjeldus
|-
|
| -13110
| Tundmatu viga
|-
|
| -13111
| Viga võlgniku isikukoodis/äriregistri koodis.
|-
|
| -13112
| Viga maksehäire summas
|-
|
| -13113
| Viga maksehäire summas. Summa on alla kehtestatud miinimumi.
|-
|
| -13114
| Viga maksehäire alguse kuupäevas.
|-
|
| -13115
| Viga maksehäire alguse kuupäevas. Maksehäire ei ole piisavalt vana.
|-
|
| -13116
| Viga maksehäire lõpu kuupäevas.
|-
|
| -13117
| Viga maksehäire lõpetamise kuupäevas. Algus peab olema enne lõppu.
|-
|
| -13118
| Viga maksehäire lõpetamise kuupäevas. Liiga vana maksehäire registrisse sisestamiseks.
|-
|
| -13119
| Viga maksehäire lõpetamise kuupäevas. Lõpukuupäev ei saa olla tulevikus.
|-
|
| -13122
| Viga lepingu numbris.
|-
|
| -13123
| Viga lepingu numbris. Number on liiga pikk.
|-
|
| -13124
| Viga maksehäire numbris.
|-
|
| -13125
| Viga maksehäire numbris. Number on liiga pikk.
|-
|
| -13126
| Viga maksehäire summa valuutas.
|-
|
| -13131
| Antud andmetega maksehäire ei ole sisestatud.
|-
|
| -13133
| Maksehäire juba sisestatud.
|-
|
| -13135
| Puuduvad õigused ettevõtte maksehäire sisestamiseks/muutmiseks.
|-
|
| -13136
| Puuduvad õigused eraisiku maksehäire sisestamiseks/muutmiseks.
|-
|
| -13137
| Toiming ei ole lubatud, sest maksehäire on (juba) kustutatud.
|-
|
| -13138
| Toiming ei ole lubatud, sest maksehäire on vaidlustatud.
|-
|
| -13139
| Puuduvad õigused antud maksehäire muutmiseks.
|}

KiCreditRegister en

2025-05-06T14:16:20Z

Annika:

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

= Introduction =

KiCreditRegister is a Web Service based on SOAP protocol for updating payment defaults information in the Payment Defaults Register.

= WSDL =

The WSDL for KiCreditRegister is available at: https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Methods=

== add==

Add a payment default to the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| debtSum
| xs:int
| Amount of the payment default
|-
|
| beginDate
| xs:date
| Start date of the payment default
|-
|
| endDate
| xs:date
| End date of the payment default. If not ended, value is NULL
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the addition was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== updateDebtSum ==

Update the amount of a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| newDebtSum
| xs:int
| New amount of the payment default
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the update was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== end ==

End a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| endDate
| xs:date
| End date of the payment default
|-
| Väljundparameeter:
| resultCode
| xs:int
| 0 if the ending was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== remove==

Submit a request to delete a payment default from the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the request was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== getOwnedDebtorPaymentDefaults ==

Retrieve payment defaults submitted by the owner for a debtor.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
| Output parameter:
| xml
| xs:string
| List of payment defaults submitted by the owner for this debtor. XML schema available at: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Error Codes=
{| style="border-style: solid; border-width: 1px;"
!
! Code
! Description
|-
|
| -13110
| Unknown error
|-
|
| -13111
| Error in personal ID/business code
|-
|
| -13112
| Error in payment default amount
|-
|
| -13113
| Payment default amount below the minimum allowed
|-
|
| -13114
| Error in start date
|-
|
| -13115
| Error in start date, payment default is too recent
|-
|
| -13116
| Error in end date
|-
|
| -13117
| Error in end date, start date must be before end date
|-
|
| -13118
| Error in end date, payment default too old to register
|-
|
| -13119
| Error in end date, end date cannot be in the future
|-
|
| -13122
| Error in contract number
|-
|
| -13123
| Error in contract number, number too long
|-
|
| -13124
| Error in payment default number
|-
|
| -13125
| Error in payment default number, number too long
|-
|
| -13126
| Error in default currency
|-
|
| -13131
| Payment default not found
|-
|
| -13133
| Payment default already exists
|-
|
| -13135
| No permission to add/edit payment defaults for the company
|-
|
| -13136
| No permission to add/edit payment defaults for the individual
|-
|
| -13137
| Operation not allowed, payment default already deleted
|-
|
| -13138
| Operation not allowed, payment default is disputed
|-
|
| -13139
| No permission to modify this payment default
|}

KiCreditRegister en

2025-05-06T14:15:05Z

Annika:

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

= Introduction =

KiCreditRegister is a Web Service based on SOAP protocol for updating payment defaults information in the Payment Defaults Register.

= WSDL =

The WSDL for KiCreditRegister is available at: //services.krediidiinfo.ee/KiCreditRegister.wsdl

= Methods=

== add==

Add a payment default to the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| debtSum
| xs:int
| Amount of the payment default
|-
|
| beginDate
| xs:date
| Start date of the payment default
|-
|
| endDate
| xs:date
| End date of the payment default. If not ended, value is NULL
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the addition was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== updateDebtSum ==

Update the amount of a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| newDebtSum
| xs:int
| New amount of the payment default
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the update was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== end ==

End a payment default.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
|
| endDate
| xs:date
| End date of the payment default
|-
| Väljundparameeter:
| resultCode
| xs:int
| 0 if the ending was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== remove==

Submit a request to delete a payment default from the register.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameters:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
|
| contractNo
| xs:string
| Contract number under which the obligation was breached
|-
|
| defaultNo
| xs:string
| Payment default number within the contract (a contract may generate multiple payment defaults)
|-
| Output parameter:
| resultCode
| xs:int
| 0 if the request was successful. Negative values indicate failure and correspond to an error code. Possible values [[#Veakoodid | listed here]].
|}

== getOwnedDebtorPaymentDefaults ==

Retrieve payment defaults submitted by the owner for a debtor.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input parameter:
| debtorCode
| xs:string
| Personal ID code (for individuals) or registration code (for companies) of the debtor
|-
| Output parameter:
| xml
| xs:string
| List of payment defaults submitted by the owner for this debtor. XML schema available at: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Error Codes=
{| style="border-style: solid; border-width: 1px;"
!
! Code
! Description
|-
|
| -13110
| Unknown error
|-
|
| -13111
| Error in personal ID/business code
|-
|
| -13112
| Error in payment default amount
|-
|
| -13113
| Payment default amount below the minimum allowed
|-
|
| -13114
| Error in start date
|-
|
| -13115
| Error in start date, payment default is too recent
|-
|
| -13116
| Error in end date
|-
|
| -13117
| Error in end date, start date must be before end date
|-
|
| -13118
| Error in end date, payment default too old to register
|-
|
| -13119
| Error in end date, end date cannot be in the future
|-
|
| -13122
| Error in contract number
|-
|
| -13123
| Error in contract number, number too long
|-
|
| -13124
| Error in payment default number
|-
|
| -13125
| Error in payment default number, number too long
|-
|
| -13126
| Error in default currency
|-
|
| -13131
| Payment default not found
|-
|
| -13133
| Payment default already exists
|-
|
| -13135
| No permission to add/edit payment defaults for the company
|-
|
| -13136
| No permission to add/edit payment defaults for the individual
|-
|
| -13137
| Operation not allowed, payment default already deleted
|-
|
| -13138
| Operation not allowed, payment default is disputed
|-
|
| -13139
| No permission to modify this payment default
|}

KiCreditRegister

2025-05-06T13:42:51Z

Annika: /* getDebtorPaymentDefaults */

KiCreditRegister

2025-05-06T13:42:02Z

Annika: /* Veakoodid */

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

= Tutvustus =

KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris.

= WSDL =

KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Meetodid =

== add==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| debtSum
| xs:int
| Maksehäire summa.
|-
|
| beginDate
| xs:date
| Maksehäire tekkimise kuupäev
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev. Kui maksehäire ei ole lõppenud, siis on parameetri väärtuseks NULL.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lisamine õnnestus. Negatiivsete väärtuste korral maksehäire lisamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== updateDebtSum ==

Maksehäire summa muutmine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| newDebtSum
| xs:int
| Maksehäire uus summa.
|-
| Väljundparameeter:
| resultCode
| xs:int
|Kui 0, siis maksehäire summa muutmine õnnestus. Negatiivse väärtuse korral maksehäire summa muutmine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== end ==

Maksehäire lõpetamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lõpetamine õnnestus. Negatiivse väärtuse korral maksehäire lõpetamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== remove==

Maksehäire registrist kustutamise soovi edastamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire kustutamise soovi edastamine õnnestus. Negatiivse väärtuse korral maksehäire kustutamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== getDebtorPaymentDefaults ==

Maksehäire omaniku poolt lisatud võlgniku maksehäirete info pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
| Väljundparameeter:
| xml
| xs:string
| Maksehäire omaniku poolt võlgniku kohta registrisse kantud maksehäired. XML on skeemiga: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Veakoodid =
{| style="border-style: solid; border-width: 1px;"
!
! Kood
! Kirjeldus
|-
|
| -13110
| Tundmatu viga
|-
|
| -13111
| Viga võlgniku isikukoodis/äriregistri koodis.
|-
|
| -13112
| Viga maksehäire summas
|-
|
| -13113
| Viga maksehäire summas. Summa on alla kehtestatud miinimumi.
|-
|
| -13114
| Viga maksehäire alguse kuupäevas.
|-
|
| -13115
| Viga maksehäire alguse kuupäevas. Maksehäire ei ole piisavalt vana.
|-
|
| -13116
| Viga maksehäire lõpu kuupäevas.
|-
|
| -13117
| Viga maksehäire lõpetamise kuupäevas. Algus peab olema enne lõppu.
|-
|
| -13118
| Viga maksehäire lõpetamise kuupäevas. Liiga vana maksehäire registrisse sisestamiseks.
|-
|
| -13119
| Viga maksehäire lõpetamise kuupäevas. Lõpukuupäev ei saa olla tulevikus.
|-
|
| -13122
| Viga lepingu numbris.
|-
|
| -13123
| Viga lepingu numbris. Number on liiga pikk.
|-
|
| -13124
| Viga maksehäire numbris.
|-
|
| -13125
| Viga maksehäire numbris. Number on liiga pikk.
|-
|
| -13126
| Viga maksehäire summa valuutas.
|-
|
| -13131
| Antud andmetega maksehäire ei ole sisestatud.
|-
|
| -13133
| Maksehäire juba sisestatud.
|-
|
| -13135
| Puuduvad õigused ettevõtte maksehäire sisestamiseks/muutmiseks.
|-
|
| -13136
| Puuduvad õigused eraisiku maksehäire sisestamiseks/muutmiseks.
|-
|
| -13137
| Toiming ei ole lubatud, sest maksehäire on (juba) kustutatud.
|-
|
| -13138
| Toiming ei ole lubatud, sest maksehäire on vaidlustatud.
|-
|
| -13139
| Puuduvad õigused antud maksehäire muutmiseks.
|}

KiCreditRegister

2025-05-06T12:26:34Z

Annika:

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

= Tutvustus =

KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris.

= WSDL =

KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Meetodid =

== add==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| debtSum
| xs:int
| Maksehäire summa.
|-
|
| beginDate
| xs:date
| Maksehäire tekkimise kuupäev
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev. Kui maksehäire ei ole lõppenud, siis on parameetri väärtuseks NULL.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lisamine õnnestus. Negatiivsete väärtuste korral maksehäire lisamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== updateDebtSum ==

Maksehäire summa muutmine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| newDebtSum
| xs:int
| Maksehäire uus summa.
|-
| Väljundparameeter:
| resultCode
| xs:int
|Kui 0, siis maksehäire summa muutmine õnnestus. Negatiivse väärtuse korral maksehäire summa muutmine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== end ==

Maksehäire lõpetamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire lõpetamine õnnestus. Negatiivse väärtuse korral maksehäire lõpetamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== remove==

Maksehäire registrist kustutamise soovi edastamine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number, mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0, siis maksehäire kustutamise soovi edastamine õnnestus. Negatiivse väärtuse korral maksehäire kustutamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== getDebtorPaymentDefaults ==

Maksehäire omaniku poolt lisatud võlgniku maksehäirete info pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistri kood (ettevõtte korral)
|-
| Väljundparameeter:
| xml
| xs:string
| Maksehäire omaniku poolt võlgniku kohta registrisse kantud maksehäired. XML on skeemiga: https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd.
|}

= Veakoodid =
{| style="border-style: solid; border-width: 1px;"
!
! Kood
! Kirjeldus
|-
|
| -13110
| Tundmatu viga
|-
|
| -13111
| Viga võlgniku isikukoodis/äriregistri koodis.
|-
|
| -13112
| Viga maksehäire summas
|-
|
| -13113
| Viga maksehäire summas. Summa on alla kehtestatud miinimumi.
|-
|
| -13114
| Viga maksehäire alguse kuupäevas.
|-
|
| -13115
| Viga maksehäire alguse kuupäevas. Maksehäire ei ole piisavalt vana.
|-
|
| -13116
| Viga maksehäire lõpu kuupäevas.
|-
|
| -13117
| Viga maksehäire lõpetamise kuupäevas. Algus peab olema enne lõppu.
|-
|
| -13118
| Viga maksehäire lõpetamise kuupäevas. Liiga vana maksehäire registrisse sisestamiseks.
|-
|
| -13119
| Viga maksehäire lõpetamise kuupäevas. Lõpukuupäev ei saa olla tulevikus.
|-
|
| -13122
| Viga lepingu numbris.
|-
|
| -13123
| Viga lepingu numbris. Number on liiga pikk.
|-
|
| -13124
| Viga maksehäire numbris.
|-
|
| -13125
| Viga maksehäire numbris. Number on liiga pikk.
|-
|
| -13126
| Viga maksehäire summa valuutas.
|-
|
| -13131
| Antud andmetega maksehäire ei ole sisestatud.
|-
|
| -13133
| Maksehäire juba sisestatud.
|-
|
| -13135
| Puuduvad õigused ettevõtte maksehäire sisestamiseks/muutmiseks.
|-
|
| -13136
| Puuduvad õigused eraisiku maksehäire sisestamiseks/muutmiseks.
|-
|
| -13137
| Toiming ei ole lubatud, sest maksehäire on (juba) kustutatud.
|-
|
| -13138
| Toiming ei ole lubatud, sest maksehäire on vaidlustatud.
|-
|
| -13139
| Puuduvad õigused maksehäire muutmiseks. Maksehäire haldamise õigus on üleantud Krediidiinfole.
|}

KiCreditRegister en

2025-04-14T06:33:04Z

Annika: Created page with "{| align="right" | 30px eesti keeles |} = Introduction = KiCreditRegister is a Web Service based on SOAP protocol for updating payment defaults information in Payment Defaults Register."

KiCreditRegister

2025-04-14T06:31:04Z

Annika:

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

= Tutvustus =

KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris.

= WSDL =

KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Meetodid =

== add==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| debtSum
| xs:int
| Maksehäire summa.
|-
|
| beginDate
| xs:date
| Maksehäire tekkimise kuupäev
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev. Kui maksehäire ei ole lõppenud, siis on parameetri väärtuseks NULL.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire lisamine õnnestus. Negatiivsete väärtuste korral maksehäire lisamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== updateDebtSum ==

Maksehäire summa muutmine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| newDebtSum
| xs:int
| Maksehäire uus summa.
|-
| Väljundparameeter:
| resultCode
| xs:int
|Kui 0 siis maksehäire summa muutmine õnnestus. Negatiivse väärtuse korral maksehäire summa muutmine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== end ==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire lõpetamine õnnestus. Negatiivse väärtuse korral maksehäire lõpetamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== remove==

Maksehäire kustutamine registrist.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire kustutamine õnnestus. Negatiivse väärtuse korral maksehäire kustutamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== getDebtorPaymentDefaults ==

Maksehäire omaniku poolt lisatud võlgniku maksehäirete info pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
| Väljundparameeter:
| xml
| xs:string
| Maksehäire omaniku poolt võlgniku kohta registrisse kantud maksehäired. XML on skeemiga: http://www.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd. NB! Meetodi tulemuseks saadud string tuleb enne kasutamist teisendada kliendi kodeeringust ümber UTF-8-sse. Näiteks kui kliendi keskkonnas kasutatakse kodeeringut ISO-8859-13, siis on ka SOAP kliendi poolt tagastatavad stringid selles kodeeringus. Selle meetodi tulemuseks on aga XML fail, mille päises on märgitud, et fail peab olema UTF-8 kodeeringus.
|}

Skeem https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd:

Skeemi pilt

= Veakoodid =
{| style="border-style: solid; border-width: 1px;"
!
! Kood
! Kirjeldus
|-
|
| -13110
| Tundmatu viga
|-
|
| -13111
| Viga võlgniku isikukoodis/äriregistri koodis.
|-
|
| -13112
| Viga maksehäire summas
|-
|
| -13113
| Viga maksehäire summas. Summa on alla kehtestatud miinimumi.
|-
|
| -13114
| Viga maksehäire alguse kuupäevas.
|-
|
| -13115
| Viga maksehäire alguse kuupäevas. Maksehäire ei ole piisavalt vana.
|-
|
| -13116
| Viga maksehäire lõpu kuupäevas.
|-
|
| -13117
| Viga maksehäire lõpetamise kuupäevas. Algus peab olema enne lõppu.
|-
|
| -13118
| Viga maksehäire lõpetamise kuupäevas. Liiga vana maksehäire registrisse sisestamiseks.
|-
|
| -13119
| Viga maksehäire lõpetamise kuupäevas. Lõpukuupäev ei saa olla tulevikus.
|-
|
| -13122
| Viga lepingu numbris.
|-
|
| -13123
| Viga lepingu numbris. Number on liiga pikk.
|-
|
| -13124
| Viga maksehäire numbris.
|-
|
| -13125
| Viga maksehäire numbris. Number on liiga pikk.
|-
|
| -13126
| Viga maksehäire summa valuutas.
|-
|
| -13131
| Antud andmetega maksehäire ei ole sisestatud.
|-
|
| -13133
| Maksehäire juba sisestatud.
|-
|
| -13135
| Puuduvad õigused ettevõtte maksehäire sisestamiseks/muutmiseks.
|-
|
| -13136
| Puuduvad õigused eraisiku maksehäire sisestamiseks/muutmiseks.
|-
|
| -13137
| Toiming ei ole lubatud, sest maksehäire on (juba) kustutatud.
|-
|
| -13138
| Toiming ei ole lubatud, sest maksehäire on vaidlustatud.
|-
|
| -13139
| Puuduvad õigused maksehäire muutmiseks. Maksehäire haldamise õigus on üleantud Krediidiinfole.
|}

KiCreditRegister

2025-04-14T06:29:28Z

Annika: Created page with "= Tutvustus = KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris. = WSDL = KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl = Meetodid = == add== Maksehäire lisamine registrisse. {| style="border-style: solid; border-width: 1px;" ! ! Nimi ! Tüüp ! Kirjeldus |- | Sisendparameetrid: | debtorCode | xs:string | Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte..."

= Tutvustus =

KiCreditRegister on liides maksehäirete haldamiseks Maksehäireregistris.

= WSDL =

KiCreditRegister WSDL asub aadressil https://services.krediidiinfo.ee/KiCreditRegister.wsdl

= Meetodid =

== add==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| debtSum
| xs:int
| Maksehäire summa.
|-
|
| beginDate
| xs:date
| Maksehäire tekkimise kuupäev
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev. Kui maksehäire ei ole lõppenud, siis on parameetri väärtuseks NULL.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire lisamine õnnestus. Negatiivsete väärtuste korral maksehäire lisamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== updateDebtSum ==

Maksehäire summa muutmine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| newDebtSum
| xs:int
| Maksehäire uus summa.
|-
| Väljundparameeter:
| resultCode
| xs:int
|Kui 0 siis maksehäire summa muutmine õnnestus. Negatiivse väärtuse korral maksehäire summa muutmine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== end ==

Maksehäire lisamine registrisse.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
|
| endDate
| xs:date
| Maksehäire lõppemise kuupäev.
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire lõpetamine õnnestus. Negatiivse väärtuse korral maksehäire lõpetamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== remove==

Maksehäire kustutamine registrist.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
|
| contractNo
| xs:string
| Lepingu number mille kohustuste mittetäitmisel võlgnevus tekkis
|-
|
| defaultNo
| xs:string
| Maksehäire number lepingu piires (ühest lepingust võib tuleneda rohkem kui üks maksehäiret)
|-
| Väljundparameeter:
| resultCode
| xs:int
| Kui 0 siis maksehäire kustutamine õnnestus. Negatiivse väärtuse korral maksehäire kustutamine ebaõnnestus ning tegemist on veakoodiga. Veakoodi võimalikud väärtused [[#Veakoodid | siin]].
|}

== getDebtorPaymentDefaults ==

Maksehäire omaniku poolt lisatud võlgniku maksehäirete info pärimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameetrid:
| debtorCode
| xs:string
| Võlgniku isikukood (eraisiku korral) või äriregistrikood (ettevõtte korral)
|-
| Väljundparameeter:
| xml
| xs:string
| Maksehäire omaniku poolt võlgniku kohta registrisse kantud maksehäired. XML on skeemiga: http://www.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd. NB! Meetodi tulemuseks saadud string tuleb enne kasutamist teisendada kliendi kodeeringust ümber UTF-8-sse. Näiteks kui kliendi keskkonnas kasutatakse kodeeringut ISO-8859-13, siis on ka SOAP kliendi poolt tagastatavad stringid selles kodeeringus. Selle meetodi tulemuseks on aga XML fail, mille päises on märgitud, et fail peab olema UTF-8 kodeeringus.
|}

Skeem https://services.krediidiinfo.ee/schemas/services/KiCreditRegister__getOwnedDebtorPaymentDefaults.xsd:

Skeemi pilt

= Veakoodid =
{| style="border-style: solid; border-width: 1px;"
!
! Kood
! Kirjeldus
|-
|
| -13110
| Tundmatu viga
|-
|
| -13111
| Viga võlgniku isikukoodis/äriregistri koodis.
|-
|
| -13112
| Viga maksehäire summas
|-
|
| -13113
| Viga maksehäire summas. Summa on alla kehtestatud miinimumi.
|-
|
| -13114
| Viga maksehäire alguse kuupäevas.
|-
|
| -13115
| Viga maksehäire alguse kuupäevas. Maksehäire ei ole piisavalt vana.
|-
|
| -13116
| Viga maksehäire lõpu kuupäevas.
|-
|
| -13117
| Viga maksehäire lõpetamise kuupäevas. Algus peab olema enne lõppu.
|-
|
| -13118
| Viga maksehäire lõpetamise kuupäevas. Liiga vana maksehäire registrisse sisestamiseks.
|-
|
| -13119
| Viga maksehäire lõpetamise kuupäevas. Lõpukuupäev ei saa olla tulevikus.
|-
|
| -13122
| Viga lepingu numbris.
|-
|
| -13123
| Viga lepingu numbris. Number on liiga pikk.
|-
|
| -13124
| Viga maksehäire numbris.
|-
|
| -13125
| Viga maksehäire numbris. Number on liiga pikk.
|-
|
| -13126
| Viga maksehäire summa valuutas.
|-
|
| -13131
| Antud andmetega maksehäire ei ole sisestatud.
|-
|
| -13133
| Maksehäire juba sisestatud.
|-
|
| -13135
| Puuduvad õigused ettevõtte maksehäire sisestamiseks/muutmiseks.
|-
|
| -13136
| Puuduvad õigused eraisiku maksehäire sisestamiseks/muutmiseks.
|-
|
| -13137
| Toiming ei ole lubatud, sest maksehäire on (juba) kustutatud.
|-
|
| -13138
| Toiming ei ole lubatud, sest maksehäire on vaidlustatud.
|-
|
| -13139
| Puuduvad õigused maksehäire muutmiseks. Maksehäire haldamise õigus on üleantud Krediidiinfole.
|}

KiDocExchange en

2024-02-05T19:16:39Z

Annika: /* Example in pseudo code */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadFile ===

File upload to Creditinfo server in a single request. Recommended to use instead of uploadChunk and finishUpload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number.
|-
|
| fileContent
| xs:base64Binary
| File content.
|-
| Output parameters:
| md5
| xs:string
| md5 hash of uploaded file.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== downloadFile ===

Download an entire file from the Creditinfo server in a single request.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| fileContent
| xs:base64Binary
| File content
|}

=== downloadChunk ===

Download file as chunks from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| start
| xs:integer
| Position in file from which the data will be downloaded (counting starts from zero)
|-
|
| count
| xs:integer
| The size of the download chunk in bytes
|-
| Output Parameters:
| chunk
| xs:base64Binary
| File chunk
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** FILE TRANSFER */
$fileId = $client->startUpload($testFileName);
$md5Actual = $client->uploadFIle($fileId, $testFileContent);
$md5Expected = md5($testFileContent); // md5 checksum to verify data integrity is optional
if ($md5Expected != $md5Actual) {
// content upload failed, md5 returned does not match expected content md5
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange en

2024-02-05T19:16:17Z

Annika: /* Methods */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadFile ===

File upload to Creditinfo server in a single request. Recommended to use instead of uploadChunk and finishUpload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number.
|-
|
| fileContent
| xs:base64Binary
| File content.
|-
| Output parameters:
| md5
| xs:string
| md5 hash of uploaded file.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== downloadFile ===

Download an entire file from the Creditinfo server in a single request.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| fileContent
| xs:base64Binary
| File content
|}

=== downloadChunk ===

Download file as chunks from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| start
| xs:integer
| Position in file from which the data will be downloaded (counting starts from zero)
|-
|
| count
| xs:integer
| The size of the download chunk in bytes
|-
| Output Parameters:
| chunk
| xs:base64Binary
| File chunk
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode != 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2024-02-05T19:11:22Z

Annika: /* Näidis pseudokoodina */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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.
|}

=== uploadFile ===

Faili üleslaadimine Creditinfo failiserverisse ühe päringuga. Soovituslik kasutada meetodite uploadChunk ja finishUpload asemel.

{| 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.
|-
|
| fileContent
| xs:base64Binary
| Üles laetava faili sisu.
|-
| Väljundparameeter:
| md5
| xs:string
| Üles laetud faili md5 hash.
|}

=== 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).
|}

=== downloadFile ===

Terve faili allalaadimine Creditinfo failiserverist ühe päringuga.

{| 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
|-
| Väljundparameeter:
| fileContent
| xs:base64Binary
| Faili sisu
|}

=== 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** FILE TRANSFER */
$fileId = $client->startUpload($testFileName);
$md5Actual = $client->uploadFIle($fileId, $testFileContent);
$md5Expected = md5($testFileContent); // md5 checksum to verify data integrity is optional
if ($md5Expected != $md5Actual) {
// content upload failed, md5 returned does not match expected content md5
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2024-02-05T19:04:08Z

Annika: /* Meetodid */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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.
|}

=== uploadFile ===

Faili üleslaadimine Creditinfo failiserverisse ühe päringuga. Soovituslik kasutada meetodite uploadChunk ja finishUpload asemel.

{| 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.
|-
|
| fileContent
| xs:base64Binary
| Üles laetava faili sisu.
|-
| Väljundparameeter:
| md5
| xs:string
| Üles laetud faili md5 hash.
|}

=== 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).
|}

=== downloadFile ===

Terve faili allalaadimine Creditinfo failiserverist ühe päringuga.

{| 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
|-
| Väljundparameeter:
| fileContent
| xs:base64Binary
| Faili sisu
|}

=== 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode != 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

Credit management input files with payment default closing info

2024-01-30T08:55:30Z

Annika: /* The bank_debtors_payments_ver4 format */

{| align="right"
| [[Image:Flag of Estonia.svg|border|30px]] [[Krediidihalduse_sisendfailid_maksehäire_lõpetamise_infoga|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 - The ''debtors_info_ver3
* A separate XML schema has been created for banks - bank_debtors_payments_ver4'

Files described below are the latest versions for the delivery of payment defaults information.
Existing customers may be using different alternative versions.

= The ''debtors_info_ver3'' format =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver3.xsd XML schema]
* [[debtors_info_ver3_example.xml]] - sample debtor data file. 
* [[Debtors info ver3.png | debtors info ver3.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.

= The ''bank_debtors_payments_ver4'' format =

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

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

= Forwarding the files =

==File name==

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

<pre>
req_<customer code>_<service>_<date+time>.<extension>
</pre>
* <customer code> - customer code in Creditinfo system
* <service> - for payment defaults use "mhr"
* <date+time> - date format YmdHis
* <extension> - file extension, we recommend compressing the files to be sent

Example: a file sent by AS CREDITINFO EESTI

<pre>
req_1_mhr_20210311111744.xml.gz
</pre>

== File delivery method==

[[KiDocExchange]] is a web services based on SOAP protocol for delivering files to Creditinfo.

To use KiDocExchange, you need username, password and respective access rights granted by Creditinfo.

Krediidihalduse sisendfailid maksehäire lõpetamise infoga

2024-01-30T08:53:27Z

Annika: /* Formaat bank_debtors_payments_ver4 */

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

= Sissejuhatus =

Maksehäireid on võimalik uuendada Creditinfo krediidihalduse teenuse kaudu. Selleks tuleb krediidihaldusesse saata regulaarselt (lepitakse iga kliendiga eraldi kokku) faili võlgnevuste andmetega.
Fail peab olema XML formaadis ja võimalik on valida kahe erineva skeemi vahel.

Allpool on kirjeldatud kõige uuemate failiversioonide struktuurid.
Olemasolevatel klientidel võib olla kasutusel ka vanemaid alternatiivseid versioone.

= Formaat ''debtors_info_ver3'' =

* [https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver3.xsd XML skeem]
* [[debtors_info_ver3_example.xml]] - näidisfail deebitoride andmetega. 
* [[Debtors_info_ver3_diagram.png | debtors info ver3.png]] - deebitoride andmete XML faili struktuuri diagramm.

Märgendi ''/debtors/debtor/add_debtor_data'' atribuudiga ''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.

= Formaat ''bank_debtors_payments_ver4'' =

Formaat on mõeldud krediidiasutustele andmete edastamiseks krediidihaldusesse. ''bank_debtors_payments_ver4'' erineb ''debtors_info_ver3'' formaadist selle poolest, et ei ole arvepõhine.

* [https://services.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver4.xsd XML skeem]
* [[Bank_debtors_payments_ver4_example.xml]] - näidisfail deebitoride andmetega. 
* [[Bank_debtors_payments_ver4_diagram.png| bank_debtors_payments_ver4.png]] - deebitoride andmete XML faili struktuuri diagramm.

= Failide edastamine =

== Faili nimi==

Creditinfosse saadetava faili nimi peab olema kujul:

<pre>
req_<kliendikood>_<teenus>_<kuupäev+kellaaeg>.<laiend>
</pre>

* <kliendikood> - kliendikood Creditinfo süsteemis
* <teenus> - maksehäire andmete edastamise puhul "mhr"
* <kuupäev+kellaaeg> - kuupäev formaadis YmdHis
* <laiend> - faili laiend, saadetud faile on soovitatav pakkida

Näide: AS CREDITINFO EESTI saadetav fail

<pre>
req_1_mhr_20210311111744.xml.gz
</pre>

== Faili edastamise liides==

Failide edastamine toimub Creditinfo SOAP liidese [[KiDocExchange]] vahendusel.

Liidest on võimalik integreerida infosüsteemidesse. Liidese kasutamiseks on vaja kasutajanime ja parooli ning KiDocExchange liidese kasutamise õiguseid.

KiDocExchange en

2024-01-03T11:35:56Z

Annika: /* Methods */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== downloadFile ===

Download an entire file from the Creditinfo server in a single request.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| fileContent
| xs:base64Binary
| File content
|}

=== downloadChunk ===

Download file as chunks from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| start
| xs:integer
| Position in file from which the data will be downloaded (counting starts from zero)
|-
|
| count
| xs:integer
| The size of the download chunk in bytes
|-
| Output Parameters:
| chunk
| xs:base64Binary
| File chunk
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode != 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange en

2024-01-03T11:27:21Z

Annika: /* Example in pseudo code */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== downloadFile ===

Download an entire file from the Creditinfo server in a single request.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| fileContent
| xs:base64Binary
| File content
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode != 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2024-01-03T11:26:28Z

Annika: /* Näidis pseudokoodina */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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).
|}

=== downloadFile ===

Terve faili allalaadimine Creditinfo failiserverist ühe päringuga.

{| 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
|-
| Väljundparameeter:
| fileContent
| xs:base64Binary
| Faili sisu
|}

=== 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode != 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$fileContent = $client->downloadFile($fileId);
saveFile($fileName, $fileContent);

/** DOWNLOAD FILE AS CHUNKS */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2024-01-03T11:20:51Z

Annika: /* downloadFile */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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).
|}

=== downloadFile ===

Terve faili allalaadimine Creditinfo failiserverist ühe päringuga.

{| 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
|-
| Väljundparameeter:
| fileContent
| xs:base64Binary
| Faili sisu
|}

=== 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange en

2024-01-03T11:20:42Z

Annika: /* Methods */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== downloadFile ===

Download an entire file from the Creditinfo server in a single request.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| fileContent
| xs:base64Binary
| File content
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2024-01-03T11:09:37Z

Annika: /* Meetodid */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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).
|}

=== downloadFile ===

Terve faili allalaadimine Creditinfo failiserverist ühe päringuga.

{| 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
|-
| Väljundparameeter:
| fileContent
| xs:base64Binary
| Faili alamosa
|}

=== 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiCreditRiskManagement en

2023-12-01T06:25:50Z

Annika: /* end */

{| 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. The end date of the service is set to the last day of the following month, if the service has been started in the current month, and in the case of a previously started service, the last day of the current month.

{| 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

2023-12-01T06:24:43Z

Annika: /* end */

{| 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. Teenuse lõpukuupäevaks määratakse järgneva kuu viimane päev, kui teenus on alustatud käesoleval kuul ning varem alustatud teenuse puhul käesoleva kuu viimane päev.

{| 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>

KiCreditRiskManagement en

2023-12-01T06:24:04Z

Annika: /* end */

{| 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. The last day of the following month is added as the end date of the service, if the service was started in the current month, and the last day of the current month in the case of a previously started service.

{| 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

2023-12-01T06:23:18Z

Annika: /* end */

{| 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. Teenuse lõpukuupäevaks lisatakse järgneva kuu viimane päev, kui teenus on alustatud käesoleval kuul ning varem alustatud teenuse puhul käesoleva kuu viimane päev.

{| 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>

RAXPENSK

2023-10-23T16:29:39Z

Annika: /* Testing */

== 1. Short description ==

Purpose of the report is to give an estimation of the private persons’ bruto income. Income is calculated from the pension payments. Pension payment makes up certain percent of the bruto income of the person.
Pension registry offers a paid service for querying pension payments of the private persons from last six months. We calculate bruto income estimation about last five full months.
There can be cases when there will be no estimation of the income:

# Person has no active pension account.
# Person has active pension account but has no pension payment obligation permanently.
# Person has active pension account but has no pension payment obligation temporarily.

Pension Registry has created a free web query to request this information. We use this query to determine if the person has payment obligation before the query of the pension payments will be made. We also put the payment obligation change information to the report, if the change happened during last six months.

== 2. Pension Registry’s payment obligation query ==

The information, what can be read out from the Pension Registry’s payment obligation query response:

# The status of the private person’s pension account.
# Information about the periods person have had active pension account.
# Information about the periods person have had pension payment obligation.
# Information about the periods person have paused pension payment obligation.

'''''Example 1:'''''
<code><pre>
<FIND_PAYMENT_DUTIES xmlns="http://corporate.epis.ee/producer/">
<PERSON PERSON_CODE="3870430xxxx" CONTRIBUTION_BEGIN_DATE="20060101" Y_2010="N" Y_2014_2017="N" Y_2020="Y" PENSION_ACCOUNT_STATUS="A">
<PAYMENT_DUTY START_DATE="20060101" DUTY="T"/>
<PAYMENT_DUTY START_DATE="20090601" DUTY="K" END_DATE="20101231"/>
<PAYMENT_DUTY START_DATE="20201201" DUTY="K" END_DATE="20210831"/>
</PERSON>
</FIND_PAYMENT_DUTIES>
</pre></code>

'''''Example 1 explanation:'''''
* Person has active pension account:
''PENSION_ACCOUNT_STATUS="A"''

* Person has active payment obligation from 01.01.2006:
''<PAYMENT_DUTY START_DATE="20060101" DUTY="T"/>''

* Payment obligation was paused two times for this person:
''<PAYMENT_DUTY START_DATE="20090601" DUTY="K" END_DATE="20101231"/>''

''<PAYMENT_DUTY START_DATE="20201201" DUTY="K" END_DATE="20210831"/>
''

'''''Example 2:'''''

<code><pre>
<FIND_PAYMENT_DUTIES xmlns="http://corporate.epis.ee/producer/">
<PERSON PERSON_CODE="4530624xxxx" CONTRIBUTION_BEGIN_DATE="20030101" CONTRIBUTION_END_DATE="20140101" Y_2010="Y" Y_2014_2017="N" Y_2020="N" PENSION_ACCOUNT_STATUS="A">
<PAYMENT_DUTY START_DATE="20030101" DUTY="T" END_DATE="20140101"/>
<PAYMENT_DUTY START_DATE="20090601" DUTY="K" END_DATE="20091231"/>
<PAYMENT_DUTY START_DATE="20140101" DUTY="M"/>
</PERSON>
</FIND_PAYMENT_DUTIES>
</pre></code>

'''''Example 2 explanation:'''''

* Person has active pension account:
PENSION_ACCOUNT_STATUS="A"

* Person has active payment obligation from 01.01.2003 to 01.01.2014 :
<PAYMENT_DUTY START_DATE="20030101" DUTY="T" END_DATE="20140101"/>

* Payment obligation was paused fro this person:
<PAYMENT_DUTY START_DATE="20090601" DUTY="K" END_DATE="20091231"/>

* Person has no payment obligation since 01.01.2014:
<PAYMENT_DUTY START_DATE="20140101" DUTY="M"/>

== 3. Pension registry's pension payments query ==

When we receive information from payment obligation query that person had payment obligation in at least one month during last 6 month, the payment obligation query is made. Query response includes all payments to pension registry during last six months. The first payment, which can appear to the response, can be from the query date minus 6 months.

'''''Example of the query response:'''''

<code><pre>
<laekumisedBody>
<ns3:laekumised_maksuametistResponse
xmlns:ns3="http://producers.kpr.x-road.eu/producer/kpr">
<ISIKUKOOD>XXXXXXXXXXX</ISIKUKOOD>
<EESNIMI>XXXXXXX</EESNIMI>
<PEREKONNANIMI>XXXXXX</PEREKONNANIMI>
<LAEKUMINE>
<KUUPAEV>2021-06-14</KUUPAEV>
<SUMMA>32.70</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-06-14</KUUPAEV>
<SUMMA>7.12</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-07-14</KUUPAEV>
<SUMMA>32.70</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-07-15</KUUPAEV>
<SUMMA>7.44</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-08-12</KUUPAEV>
<SUMMA>32.03</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-08-12</KUUPAEV>
<SUMMA>14.73</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-09-13</KUUPAEV>
<SUMMA>11.73</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
<LAEKUMINE>
<KUUPAEV>2021-09-13</KUUPAEV>
<SUMMA>35.30</SUMMA>
<VALUUTA>EUR</VALUUTA>
</LAEKUMINE>
</ns3:laekumised_maksuametistResponse>
</laekumisedBody>
</pre></code>

== 4. RAXPENSK xml report from Creditinfo ==

All the detailed information about the report structure can be found in the xml schema RAXPENSK.xsd [https://services.krediidiinfo.ee/schemas/report/RAXPENSK.xsd].

'''''Report contents:'''''

* Report includes the responses from the Pension Registry payment obligation query and pension payment query.

* For better readability of the payment obligation query, we have added payment obligation descriptions:

<code><pre>
<payment_duties>
<payment_duty>
<start_date>2004-01-01</start_date>
<end_date>2021-08-31</end_date>
<meaning>maksekohustus on / sissemaksete tegemine</meaning>
</payment_duty>
<payment_duty>
<start_date>2021-09-01</start_date>
<end_date xsi:nil="true"/>
<meaning>maksekohustust ei ole / maksete mittetegemine</meaning>
</payment_duty>
</payment_duties>
</pre></code>

* If there is error with querying data from Pension Registry or the payment query was not made, the explanation is added to the report. If the comment explains error, then is_error attribute is equal to True:
<code><pre>
<comment is_error="false">Ei tehtud maksuametisse toimunud laekumiste päringut, sest maksete kohustus puudub.</comment>
</pre></code>

* It is possible for the parent to receive parent pension to pension account. In that case we cannot include the sum in bruto wage calculation. If this is the case a warning will be shown in the report:

<code><pre>
"warning": "Isikul võib Pensionikeskuse laekumiste hulgas olla vanemapensioni makseid!"
</pre></code>

* Report includes Bruto wages section with attributes start_date and end_date for showing the period of the wages calculation period. The wages calculation period is different from the pension payments period as there might not be shown all monthly payments from the first and last month of the payments.
Monthly wage will be calculated from the sum of the monthly payments to the pension account. If there is a record about pension registry payment for the person in the Pension Registry’s response the bruto wage will be calculated.

<code><pre>
<gross_salaries start_date="2021-06-01"
end_date="2021-10-31">
<gross_salary>
<year>2021</year>
<month>6</month>
<salary>1991</salary>
</gross_salary>
<gross_salary>
<year>2021</year>
<month>7</month>
<salary>2007</salary>
</gross_salary>
<gross_salary>
<year>2021</year>
<month>8</month>
<salary>2338</salary>
</gross_salary>
<gross_salary>
<year>2021</year>
<month>9</month>
<salary>2352</salary>
</gross_salary>
</gross_salaries>
</pre></code>

* Average bruto wage will be calculated from the monthly wages, which in turn are calculated from pension payments.

<code><pre>
<average_bruto_wage>1561</average_bruto_wage>
</pre></code>

== Testing ==

Testing should be agreed with Creditinfo Estonia

'''Testcodes in pension registry:'''

37804020009, 35604220000, 50106090002, 46201080006, 35612010008, 45402070008, 37407100004, 48408301152, 46508303070

KiDocExchange

2023-05-05T12:01:20Z

Annika:

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange en

2023-05-05T11:57:14Z

Annika: /* Example in PHP */

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in pseudo code =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange

2023-05-05T11:56:37Z

Annika: /* Näidis PHP-s */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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 pseudokoodina =

<pre>
/** DEFINE PARAMETERS */
$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
$username = ''; // provided by Creditinfo
$password = ''; // provided by creditinfo
$connectionParameters = [
'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
'login' => 'username',
'password' => 'password'
];
$testFileContent = 'test file content';
$testFileName = 'test_file_name.txt';

/** INIT CLIENT */
$client = new SoapClient(
$wsdl,
[
'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
'login' => $username,
'password' => $password
]
);

/** INIT FILE TRANSFER */
$fileId = $client->startUpload($testFileName);

/** SEND FILE CONTENT */
$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

/** FINISH UPLOAD */
$md5 = md5($testFileContent); // md5 checksum to verify data integrity
$reponseCode = $client->finishUpload($fileId, $md5);
if ($reponseCode == 0) {
// upload failed, check response code for reason
}

/** DOWNLOAD FILE */
$fileId = 12345; // actual ID is aquired via getDownloadQueue response
$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
$start = 0;
$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
$fileContent = '';
while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
$start += $chunkSize;
$fileContent .= $chunk;
}

saveFile($fileName, $fileContent);
</pre>

KiDocExchange en

2023-05-05T11:53:53Z

Annika:

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

= KiDocExchange Web Service =

== Introduction ==

KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

== Filename guide for sending and receiving ==

Creditinfo file transfer file name guide for request file:
<pre>
req_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo file name for request file (if necessary for product):
<pre>
resp_<client_code>_<product_code>_<date+time>.<file_extension>
nt. req_123456_mhr_20230505124518.xml
</pre>

* <client_code> - Supplied by Creditinfo.
* <product_code> - Supplied by Creditinfo.
* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

and to download

[[Image:Download_diagram.png]]

List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Creditinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== getDownloadQueue ===

The list of files waiting for client to download them from Creditinfo server.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Output parameter:
| queue
| DownloadQueueArray
| array of DownloadQueueType type
|}

DownloadQueueType is an associative array with following elements:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| docID
| xs:integer
| file id
|-
| fileName
| xs:string
| file name
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

= Debugging =

Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.

= Example in PHP =

<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>

KiDocExchange

2023-05-05T11:49:17Z

Annika: /* Failide edastamine ja vastuvõtmine */

{| 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=

Creditinfosse saadetava faili nimi peab olema kujul:
<pre>
req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. req_123456_mhr_20230505124518.xml
</pre>

Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
<pre>
resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
nt. resp_123456_mhr_20230505124518.xml
</pre>

* <kliendikood> - Creditinfoga poolt jagatav väärtus.
* <toote_kood> - Creditinfoga poolt jagatav väärtus.
* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

= 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>

Bank debtors payments ver4 example.xml

2022-08-23T13:25:15Z

Annika:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<debtors xmlns="https://services.krediidiinfo.ee/schemas/kh/bank_debtors_payments_ver4.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" generated="2020-10-28">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<contract_no>123</contract_no>
<client_code>456</client_code>
<id>00000000</id>
<client_classes>
<client_class>VIP</client_class>
</client_classes>
<mail_address>
<street>Kuusiku 10-2</street>
<postal_code>10001</postal_code>
<city>Nuustaku</city>
<country>EST</country>
</mail_address>
<emails>
<email>ohk@pohk.ee</email>
<email>info@pohk.ee</email>
</emails>
<phones>
<phone>2349082</phone>
<phone>+3722349082</phone>
</phones>
<bank_ref_no>00000000000000</bank_ref_no>
<bank_account_numbers>
<bank_account_number>EE000000000000000000</bank_account_number>
<bank_account_number>EE110000000000000000</bank_account_number>
</bank_account_numbers>
<overdue_payments>
<overdue_payment>
<pay_due_dt>2020-08-01</pay_due_dt>
<date_pd_limit_exceeded>2020-08-01</date_pd_limit_exceeded>
<currency>EUR</currency>
<exchange_rate>1</exchange_rate>
<primary_debt>100.23</primary_debt>
<interest>4.77</interest>
<fine>1.20</fine>
</overdue_payment>
<overdue_payment>
<pay_due_dt>2020-09-01</pay_due_dt>
<date_pd_limit_exceeded>2020-09-01</date_pd_limit_exceeded>
<currency>EUR</currency>
<exchange_rate>1</exchange_rate>
<primary_debt>101.23</primary_debt>
<interest>3.77</interest>
<fine>0</fine>
</overdue_payment>
</overdue_payments>
<add_debtor_data name="client_manager_comment">14.10.2020 promised to pay in two days</add_debtor_data>
</debtor>
<debtor>
<name>ÕHK JA PÕHK AS</name>
<contract_no>999</contract_no>
<client_code>456</client_code>
<id>00000000</id>
<client_classes>
<client_class>v1</client_class>
</client_classes>
<mail_address>
<street>Kuusiku 10-2</street>
<postal_code>10001</postal_code>
<city>Nuustaku</city>
<country>EST</country>
</mail_address>
<emails>
<email>ohk@pohk.ee</email>
<email>info@pohk.ee</email>
</emails>
<phones>
<phone>2349082</phone>
<phone>+3722349082</phone>
</phones>
<bank_ref_no>00000000000000</bank_ref_no>
<bank_account_numbers>
<bank_account_number>EE000000000000000000</bank_account_number>
<bank_account_number>EE110000000000000000</bank_account_number>
</bank_account_numbers>
<overdue_payments>
<overdue_payment>
<pay_due_dt>2020-09-01</pay_due_dt>
<currency>EUR</currency>
<primary_debt>25</primary_debt>
<interest>1.5</interest>
<fine>0.50</fine>
</overdue_payment>
<overdue_payment>
<pay_due_dt>2020-11-01</pay_due_dt>
<currency>EUR</currency>
<primary_debt>25</primary_debt>
<interest>1.47</interest>
<fine>0</fine>
</overdue_payment>
</overdue_payments>
<add_debtor_data name="client_manager_comment">14.12.2020 comment</add_debtor_data>
</debtor>
<debtor>
<name>MATI MINIMAALNE</name>
<contract_no>456</contract_no>
<client_code>789</client_code>
<id>00000000000</id>
<overdue_payments>
<overdue_payment>
<pay_due_dt>2020-08-01</pay_due_dt>
<currency>EUR</currency>
<primary_debt>150.02</primary_debt>
<interest>6.22</interest>
<fine>1.50</fine>
</overdue_payment>
<overdue_payment>
<pay_due_dt>2020-09-01</pay_due_dt>
<currency>EUR</currency>
<primary_debt>151.02</primary_debt>
<interest>5.22</interest>
<fine>0</fine>
</overdue_payment>
</overdue_payments>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<contract_no>321</contract_no>
<client_code>654</client_code>
<id>00000000000</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>2</end_reason_id>
<assign_info>
<assignee_country_code>EST</assignee_country_code>
<assignee_id>11111111</assignee_id>
<assignee_name>KOKKUOSTJA OÜ</assignee_name>
</assign_info>
<additional_info>Võlgnevus loovutatud lepingu nr 7 alusel</additional_info>
</end_info>
</payment_default>
</debtor>
<debtor>
<name>OSKAR OHAKAS</name>
<contract_no>555</contract_no>
<client_code>666</client_code>
<id>00000000000</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>1</end_reason_id>
</end_info>
</payment_default>
</debtor>
<debtor>
<name>MARI MAASIKAS</name>
<contract_no>777</contract_no>
<client_code>777</client_code>
<id>00000000000</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>3</end_reason_id>
<additional_info>Kohtulahend nr XXX</additional_info>
</end_info>
<publish_end_date>2020-10-28</publish_end_date>
</payment_default>
</debtor>
</debtors>
</pre>

Debtors info ver3 example.xml

2022-08-23T13:24:33Z

Annika:

<pre>
<?xml version="1.0" encoding="utf-8"?>
<debtors xmlns="https://services.krediidiinfo.ee/schemas/kh/debtors_info_ver3.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" generated="2020-10-28">
<debtor>
<name>ÕHK JA PÕHK AS</name>
<client_code>123</client_code>
<id>00000000</id>
<client_classes>
<client_class>VIP</client_class>
</client_classes>
<mail_address>
<street>Kuusiku 10-2</street>
<postal_code>10001</postal_code>
<city>Nuustaku</city>
<country>EST</country>
</mail_address>
<emails>
<email>ohk@pohk.ee</email>
<email>info@pohk.ee</email>
</emails>
<phones>
<phone>2349082</phone>
<phone>+3722349082</phone>
</phones>
<bank_ref_no>00000000000000</bank_ref_no>
<bank_account_numbers>
<bank_account_number>EE000000000000000000</bank_account_number>
<bank_account_number>EE110000000000000000</bank_account_number>
</bank_account_numbers>
<invoices>
<invoice>
<invoice_date>2020-09-01</invoice_date>
<invoice_no>A-003231</invoice_no>
<payment_term>2020-09-12</payment_term>
<date_pd_limit_exceeded>2020-09-12</date_pd_limit_exceeded>
<invoice_sum>3092.23</invoice_sum>
<unpaid_sum>3092.23</unpaid_sum>
<currency>EUR</currency>
<add_invoice_data name="comment">a comment about invoice</add_invoice_data>
</invoice>
<invoice>
<invoice_date>2020-07-13</invoice_date>
<invoice_no>23422</invoice_no>
<payment_term>2020-07-27</payment_term>
<date_pd_limit_exceeded>2020-09-01</date_pd_limit_exceeded>
<invoice_sum>40.45</invoice_sum>
<unpaid_sum>40.45</unpaid_sum>
<currency>EUR</currency>
<add_invoice_data name="comment">a comment about invoice</add_invoice_data>
</invoice>
</invoices>
<add_debtor_data name="client_manager_comment">14.10.2020 promised to pay in two days</add_debtor_data>
<add_debtor_data name="contract_no">984932342</add_debtor_data>
</debtor>
<debtor>
<name>MATI MINIMAALNE</name>
<client_code>456</client_code>
<id>00000000000</id>
<invoices>
<invoice>
<invoice_date>2020-09-01</invoice_date>
<invoice_no>L-003231</invoice_no>
<payment_term>2020-09-12</payment_term>
<invoice_sum>592.55</invoice_sum>
<unpaid_sum>592.55</unpaid_sum>
<currency>EUR</currency>
</invoice>
<invoice>
<invoice_date>2020-07-13</invoice_date>
<invoice_no>P234255</invoice_no>
<payment_term>2020-07-27</payment_term>
<invoice_sum>150.45</invoice_sum>
<unpaid_sum>150.45</unpaid_sum>
<currency>EUR</currency>
</invoice>
</invoices>
</debtor>
<debtor>
<name>JAAN JALGRATAS</name>
<client_code>321</client_code>
<id>00000000000</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>2</end_reason_id>
<assign_info>
<assignee_country_code>EST</assignee_country_code>
<assignee_id>11111111</assignee_id>
<assignee_name>KOKKUOSTJA OÜ</assignee_name>
</assign_info>
<additional_info>Võlgnevus loovutatud lepingu nr 7 alusel</additional_info>
</end_info>
</payment_default>
</debtor>
<debtor>
<name>OSKAR OHAKAS</name>
<client_code>555</client_code>
<id>11111111111</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>1</end_reason_id>
</end_info>
</payment_default>
</debtor>
<debtor>
<name>MARI MAASIKAS</name>
<client_code>777</client_code>
<id>22222222222</id>
<payment_default>
<end_date>2020-10-27</end_date>
<end_info>
<end_reason_id>3</end_reason_id>
<additional_info>Kohtulahend nr XXX</additional_info>
</end_info>
<publish_end_date>2020-10-28</publish_end_date>
</payment_default>
</debtor>
</debtors>
</pre>

Payment defaults

2022-03-10T10:18:05Z

Annika: /* Number of disputed payment defaults */

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

XSD schema: https://services.krediidiinfo.ee/schemas/report/payment_defaults_ver4.xsd

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults.

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the output was always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults is be published. In case person does not have disputed payment defaults, the output value is 0.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

Sample 1: person does not have disputed payment defaults:
<pre>
<disputed_payment_defaults_count>0</disputed_payment_defaults_count>
</pre>

Sample 2: person has 2 disputed payment defaults:
<pre>
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2022-03-10T10:16:27Z

Annika: /* Ready-to-use XML reports */

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

XSD schema: https://services.krediidiinfo.ee/schemas/report/payment_defaults_ver4.xsd

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults.

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

Sample 1: person does not have disputed payment defaults:
<pre>
<disputed_payment_defaults_count>0</disputed_payment_defaults_count>
</pre>

Sample 2: person has 2 disputed payment defaults:
<pre>
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2022-03-10T10:15:09Z

Annika: /* Number of disputed payment defaults */

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

XSD schema: https://services.krediidiinfo.ee/schemas/report/payment_defaults_ver4.xsd

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults.

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

Sample 1: person does not have disputed payment defaults:
<pre>
<disputed_payment_defaults_count>0</disputed_payment_defaults_count>
</pre>

Sample 2: person has 2 disputed payment defaults:
<pre>
<disputed_payment_defaults_count>2</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2021-12-01T09:00:20Z

Annika: /* Detail information about valid and settled payment defaults */

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

XSD schema: https://services.krediidiinfo.ee/schemas/report/payment_defaults_ver4.xsd

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults.

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2021-11-29T20:27:45Z

Annika:

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults.

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2021-11-29T17:42:45Z

Annika: /* Ready-to-use reports */

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= Ready-to-use XML reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2021-11-29T17:35:40Z

Annika:

= Introduction =

The purpose of this page is to describe ready-to-use XML reports about payment defaults and data structures used in these reports.

= Data structures =

== Detail information about valid and settled payment defaults ==

A payment default is a violation of the debtor's monetary obligation for more than 45 days from the day following the due date and when the amount exceeds 30 euros. The information published in the Credit Register derives from legal persons who have entered into a contract with AS CREDITINFO EESTI, as the administrator of the Credit Register, for inputting and updating the payment default data.

'''Payment defaults information explanations:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about legal entity who has entered the payment default into the Credit Register
(creditor or a person acting on creditor's behalf)
|
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

'''Sample response:'''

<pre>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

The disputed payment defaults indicate a situation in which the circumstances related to the debt are being clarified, i.e. the payment default dispute has not been completed or it is not certain whether the publication of the payment default data is justified.
Starting from February 1st 2022 Creditinfo will start publishing the number of disputed payment defaults

'''Information structure explanation:'''

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|disputed_payment_defaults_count||element||Number of disputed payment defaults|| Until February 2022 the value is always ''xsi:nil="true"''
Starting from February 1st 2022 the number of disputed payment defaults will be published.
|}

'''Sample response until February 2022:'''

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

'''Sample response from February 1st, 2022:'''

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired (RAXLEPDRE) ==

Report provides information about company payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRE.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

== Private person payment defaults (RAXPPPDRI) ==

Report provides information about private person payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd

'''Sample response:'''

<pre>
<report language="en" created="2021-11-29T11:03:33" code="RAXPPPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRI.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Company payment defaults (RAXLEPDRI)==

Report provides information about company payment defaults.

Language: english

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd

'''Sample response:'''

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXLEPDRI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXLEPDRI.xsd">
<company registry_code="00000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Public mobile telephone services</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Activities of collection agencies and credit bureaus</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</company>
</report>
</pre>

Payment defaults

2021-11-29T16:59:55Z

Annika: /* Detail information about valid and settled payment defaults */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Payment defaults' information explanations:

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|payment_defaults||element||Information about subject's payment defaults|| ''xsi:nil="true"'' in case subject does't have payment defaults
|-
|payment_defaults/@currency||attribute||Payment defaults' currency||
|-
|payment_defaults/payment_default||element||Information about a payment default||
|-
|payment_defaults/payment_default/owner||element||Information about company who has entered the payment default into the Credit Register (creditor or a person acting on creditor's behalf)||
|-
|payment_defaults/payment_default/owner/@is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
|payment_defaults/payment_default/owner/@registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/@owner_id||attribute||Owner's unique ID||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/name||element||Owner's name||Missing in case company is registry member or is not Estonian company
|-
|payment_defaults/payment_default/owner/activity||element||Owner's field of activity||
|-
|payment_defaults/payment_default/owner/activity/@code||attribute||Activity code according to EMTAK2008||
|-
|payment_defaults/payment_default/owner/activity/@classification||attribute||Field of activity classification||EMTAK2008
|-
|payment_defaults/payment_default/debt_range||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/max_debt_range||element||Payment default's maximum amount range||
|-
|payment_defaults/payment_default/begin_date||element||Payment defaults begin date||
|-
|payment_defaults/payment_default/end_date||element||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|-
|payment_defaults/payment_default/end_reason/@code||attribute||Payment default end reason code||
|}

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T16:13:29Z

Annika: /* Detail information about valid and settled payment defaults */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

{| class="wikitable"
|+
!Name!!Type!!Description!!Additional info
|-
|<owner>||element||Information about company who has entered this payment default info the Credit Register (creditor or a person acting on creditor's behalf)||
|-
| is_registry_member||attribute||Indicates if owner is registry member ||boolean
|-
| registry_code||attribute||Estonian company registry code||Missing in case company is registry member or is not Estonian company
|-
| owner_id||attribute||Owner's unique ID||Missing in case company is registry member or is not Estonian company
|-
|<name>||element||Owner's name||Missing in case company is registry member or is not Estonian company
|-
|<activity>||element||Owner's field of activity||
|-
|code||attribute||Activity code||
|-
|classification||attribute||Field of activity classification||EMTAK2008
|-
|<debt_range>||element||Valid payment default's current amount range||For settled payment defaults ''xsi:nil="true"''
|-
|max_debt_range||element||Payment default's maximum amount range||
|-
|<begin_date>||element||Payment defaults begin date||
|-
|<end_date>||elemnt||Payment defaults end date|| For valid payment defaults ''xsi:nil="true"''
|-
|<end reason>||element||Payment default end reason||Element is intended for future use. Until further notice, the value is always ''xsi:nil="true"''
|}

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T14:58:42Z

Annika: /* Eraisiku maksehäired (RAXPPPDRE) */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.

Language: estonian

XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T14:58:14Z

Annika: /* Eraisiku maksehäired (RAXPPPDRE) */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report provides information about private person payment defaults.
Language: estonian
XSD schema: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T14:55:42Z

Annika: /* Eraisiku maksehäired */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired (RAXPPPDRE) ==

Report sxd structure: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T14:51:48Z

Annika: /* Eraisiku maksehäired */

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired ==

Report sxd structure: https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd

Sample reponse:

<pre>
<report language="et" created="2021-11-29T11:03:33" code="RAXPPPDRE" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://services.krediidiinfo.ee/schemas/report/RAXPPPDRE.xsd">
<person person_code="00000000000">
<disputed_payment_defaults_count xsi:nil="true"/>
<payment_defaults currency="EUR">
<payment_default>
<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
<payment_default>
<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</person>
</report>
</pre>

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T14:42:01Z

Annika:

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

Sample response:

<pre>
-<payment_defaults currency="EUR">
-<payment_default>
-<owner is_registry_member="true">
<activity code="61201" classification="EMTAK2008">Mobiilsideteenus</activity>
</owner>
<debt_range xsi:nil="true"/>
<max_debt_range>65-320</max_debt_range>
<begin_date>2019-08-19</begin_date>
<end_date>2021-02-02</end_date>
<end_reason xsi:nil="true"/>
</payment_default>
-<payment_default>
-<owner is_registry_member="false" registry_code="00000000" owner_id="11111">
<name>ETTEVÕTE AS</name>
<activity code="82911" classification="EMTAK2008">Inkassoteenus ja krediidiinfo</activity>
</owner>
<debt_range>640-3200</debt_range>
<max_debt_range>640-3200</max_debt_range>
<begin_date>2019-08-15</begin_date>
<end_date xsi:nil="true"/>
<end_reason xsi:nil="true"/>
</payment_default>
</payment_defaults>
</pre>

== Number of disputed payment defaults ==

Sample response until February 2022:

<pre>
<disputed_payment_defaults_count xsi:nil="true"/>
</pre>

Sample response from February 1st, 2022:

<pre>
<disputed_payment_defaults_count>1</disputed_payment_defaults_count>
</pre>

= 3. Ready-to-use reports =

== Eraisiku maksehäired ==

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T08:26:20Z

Annika:

= 1. Short description =

Purpose of this page is to describe Payment defaults reports and information structures.

= 2. Data structures =

== Detail information about valid and settled payment defaults ==

== Number of disputed payment defaults ==

= 3. Ready-to-use reports =

== Eraisiku maksehäired ==

== Ettevõtte maksehäired ==

== Private person payment defaults ==

== Company payment defaults==

Payment defaults

2021-11-29T07:40:22Z

Annika:

== 1. Short description ==

Purpose of this page is to describe Payment defaults reports and information structures.

== 2. Data structures ==

Detail information about valid and settled payment defaults

Number of disputed payment defaults

== 3. Ready-to-use reports ==

Eraisiku maksehäired
Ettevõtte maksehäired
Private person payment defaults
Company payment defaults

== 4. test ==

test

== info ==

info