zadowolony mężczyzna korzystający z windykacji online

Dokumentacja

Jeśli masz jakieś pytania bądź sugestie, prosimy o kontakt.

newVindication

Parametr Typ Możliwe wartości Wymagany Opis Struktura parametru
my_data array maks. 1 element tak Dane wierzyciela (osoba fizyczna lub firma) w postaci tablicy.

Przykład:
$_POST['my_data'] = [
    'country' => 1,
    'province' => 3
];

Parametr Typ Możliwe wartości Wymagany Opis
company_type string business - firma
person - osoba fizyczna 		tak Osobowość prawna.
country integer Aktualna lista państw wraz z ich identyfikatorami są do pobrania w czasie rzeczywistym poprzez metodę getCountriesList. tak Państwo.
province integer Aktualna lista województw wraz z ich identyfikatorami są do pobrania w czasie rzeczywistym poprzez metodę getProvincesList. tak Województwo - dotyczy na aktualny moment tylko Polski. W przypadku innych Państwa przesłana wartość powinna wynosić 0.
tax_id string 2 - 32 znaków tak W przypadku firm należy podać NIP, dla osób fizycznych numer PESEL.
company_name string dla firm: 2 - 512 znaków
dla osób fizycznych: 2 - 128 znaków 		tak W przypadku firm - nazwa firmy. Dla osób fizycznych należy podać imię i nazwisko.
representing_person string 2 - 128 znaków tak Osoba reprezentująca firmę. W przypadku osób fizycznych parametr nie jest brany pod uwagę.
post_code string 2 - 32 znaków tak Kod pocztowy (kod).
post_city string 2 - 128 znaków tak Kod pocztowy (miasto).
address string 2 - 512 znaków tak Adres.
phone string 2 - 64 znaków tak Numer telefonu.
email string 2 - 256 znaków tak Adres e-mail.
nrb string 2 - 64 znaków tak Numer konta bankowego na który dłużnik ma uiścić pieniądze.


debtor_data array maks. 1 element tak Dane dłużnika (osoba fizyczna lub firma) w postaci tablicy.

Przykład:
$_POST['debtor_data'] = [
    'country' => 1,
    'province' => 3
];

Parametr Typ Możliwe wartości Wymagany Opis
company_type string business - firma
person - osoba fizyczna 		tak Osobowość prawna.
country integer Aktualna lista państw wraz z ich identyfikatorami są do pobrania w czasie rzeczywistym poprzez metodę getCountriesList. tak Państwo.
province integer Aktualna lista województw wraz z ich identyfikatorami są do pobrania w czasie rzeczywistym poprzez metodę getProvincesList. tak Województwo - dotyczy na aktualny moment tylko Polski. W przypadku innych Państwa przesłana wartość powinna wynosić 0.
tax_id string 2 - 32 znaków tak W przypadku firm należy podać NIP, dla osób fizycznych numer PESEL.
company_name string dla firm: 2 - 512 znaków
dla osób fizycznych: 2 - 128 znaków 		tak W przypadku firm - nazwa firmy. Dla osób fizycznych należy podać imię i nazwisko.
representing_person string 2 - 128 znaków tak Osoba reprezentująca firmę (opcjonalnie). W przypadku osób fizycznych parametr nie jest brany pod uwagę.
post_code string 2 - 32 znaków tak Kod pocztowy (kod).
post_city string 2 - 128 znaków tak Kod pocztowy (miasto).
address string 2 - 512 znaków tak Adres.
phone string 2 - 64 znaków tak Numer telefonu. Jeśli nie zostanie podany adres e-mail, pole wymagane, w przeciwnym razie - opcjonalne.
email string 2 - 256 znaków tak Adres e-mail. Jeśli numer telefonu nie został podany, pole wymagane.


debts array maks. 100 elementów tak Dług w postaci tablicy.

Przykład:
$_POST['debts'] = [
    [
        'amount' => 1,
        'amount_paid' => 3,
        'invoice_file' => [
            'name' => 'faktura.pdf',
            'base64' => 'U2llbWE6RA=='
        ],
        'documents' => [
            [
                'name' => 'umowa.pdf',
                'base64' => 'U2lA=='
            ],
            [
                'name' => 'umowa-2.pdf',
                'base64' => 'U2lA=='
            ]
        ],
    ],
    [
        'amount' => 1,
        'amount_paid' => 3
        'invoice_file' => [
            'name' => 'faktura.pdf',
            'base64' => 'U2llbWE6RA=='
        ]
    ],
];

Parametr Typ Możliwe wartości Wymagany Opis
document_name string 2 - 128 znaków tak Numer faktury.
amount float 0.01 - 100000000 tak Kwota faktury.
currency string pln, eur, gbp, usd, chf, rub, byn tak Waluta.
issue_date string W formacie dd.mm.yyyy, np. 01.03.2021 tak Data wystawienia faktury.
payment_date string W formacie dd.mm.yyyy, np. 11.03.2021 tak Termin płatności za fakturę.
documents_status string yes, no tak Czy dokumenty (faktura, dokumenty potwierdzające dług) zostały podpisane/potwierdzone przez dłużnika?
invoice_file array maks. 1 element tak
Parametr Typ Możliwe wartości Wymagany Opis
name string 2 - 128 znaków tak Nazwa pliku (zaleca się podanie nazwy z rozszerzeniem np. test.png)
base64 string 2 - 0 znaków tak Zawartość pliku zakodowana w base64.
documents array maks. 50 elementów nie
Parametr Typ Możliwe wartości Wymagany Opis
name string 2 - 128 znaków tak Nazwa pliku (zaleca się podanie nazwy z rozszerzeniem np. test.png)
base64 string 2 - 0 znaków tak Zawartość pliku zakodowana w base64.
interest_type string no - brak
statutory - ustawowe
contractual - umowne 		nie Typ odsetek. Jeśli brak - parametr nie musi zostać przesłany. Odsetki ustawowe posiadają domyślnie stawkę w wysokości 11.75%.
interest float 0.01 - 10000 nie Procent odsetek w skali roku. Parametr używany w przypadku kiedy zostały wybrane odsetki umowne.
partially_paid string yes, no nie Czy faktura została już częściowo zapłacona?
amount_paid float 0.01 - 100000000 nie Kwota która została dotychczasowo wpłacona. Uwzględniane, jeśli parametr partially_paid=yes.
comments string 0 - 4096 znaków nie Uwagi.


user_key string 64 - 256 znaków nie Unikalny klucz identyfikujący klienta serwisu. Wymagany jeśli chcemy utworzyć windykację dla konkretnego klienta (można użyć jedynie konta utworzonego za pomocą identyfikatora API z którego zostało ono utworzone).
email string 4 - 250 znaków nie Adres e-mail klienta. Parametr wymagany, jeśli klient dla którego zlecamy windykacje nie posiada konta w serwisie.
password string 12 - 128 znaków nie Hasło klienta (plaintext). Parametr wymagany, jeśli klient dla którego zlecamy windykacje nie posiada konta w serwisie.
x

Ładowanie
danych...

Windykacja została zakończona
odnotowanie wpłaty jest niemożliwe

x

Ładowanie
danych...

x

Wybierz akcję

Czy na pewno chcesz zakończyć windykację?
x

Wyślij wiadomość odnośnie windykacji #XXXX-XXXX-XXXX




x

Wyślij sugestię, uwagi lub zadaj pytanie dotyczące serwisu, a nie Twojej sprawy