KiCreditRegister en
Jump to navigation
Jump to search
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.
| 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 listed here. |
updateDebtSum
Update the amount of a payment default.
| 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 listed here. |
end
End a payment default.
| 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 listed here. |
remove
Submit a request to delete a payment default from the register.
| 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 listed here. |
getOwnedDebtorPaymentDefaults
Retrieve payment defaults submitted by the owner for a debtor.
| 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
| 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 |