Dokumentacja protokołu BIG InfoMonitor
Obsługa wysyłki wezwania do zapłaty

Protokół bimoL pozwala na zlecanie i weryfikowanie statusu przetwarzania wysyłki wezwań do zapłaty. Zlecenia te są przetwarzane w SIBIG asynchronicznie, tzn. system klienta nie otrzymuje natychmiast potwierdzenia realziacji wysyłki, lecz weryfikuje status jego przetwarzania po pewnym czasie od zlecenia.

Dostępne dla subskrybentów operacje na zleceniach wysyłki wezwania są wymienione i opisane w specyfikacji BIG API .

Lista komunikatów wejściowych dla operacji na wysyłkach wezwań do zapłaty

 

Nazwa operacji Komunikat wejściowy
Rejestracja zlecenia wysyłki wezwania do zapłaty Element addPaymentSummonOrder
Pobranie listy zleconych wysyłek Element getPaymentSummonList
Anulowanie zlecenia wysyłki Element withdrawPaymentSummonOrder
Pobranie dokumentu wezwania Element getPaymentSummonDocument

Rejestracja zlecenia wysyłki wezwania do zapłaty

Zlecenie wysyłki wezwania do zapłaty odbywa się za pośrednictwem operacji addPaymentSummonOrder udostępnionej w ramach metody updatePaymentSummonRequest protokołu bimoL

Zamówienie wymaga posiadania limitu na produkt "Wezwanie do zapłaty" w aktualnym okresie rozliczeniowym oferty głównej. Użytkownik który składa zamówienie musi mieć przypisane uprawnienie "Uprawnienie do wysyłki wezwania listem poleconym".

Brak limitu na produkt lub wskazanego uprawnienia zakończy się zwróceniem błędu autoryzacji.


Zakres danych przekazanych w poprawnym zamówieniu opisuje typ złożony AddPaymentSummonOrder:

configuredTemplate - atrybut wykorzystywany do deklaracji szablonu dokumentu, który zostanie wykorzystania do wygenerowania wysyłanego dokumentu.

notificationEmail - atrybut opcjonalny, który przyjmuje adres email na który będą wysyłane wiadomości email z informacją o stanie realizacji zlecenia wysyłki (jeżeli email zostanie przekazany)

id - numer identyfikacyjny zlecenia ustalony przez klienta  (zalecane jest przekazywanie unikalnych identyfikatorów zleceń)

debtorName - imię i nazwisko lub nazwa firmy, która jest wzywana do zapłaty zobowiązań wykazanych w dokumencie

liability - lista zobowiązań stwierdzonych tytułem wykonawczym, lub dotyczących niespełnionych zobowiązań finansowych. Wszystkie zobowiązania przekazane w zleceniu, muszą być z tego samego tytułu (wykonawczy lub finansowe) a ich kwoty zaległości wyrażone w tej samej walucie

deliveryAdress - dane opisujące adres na który ma być wysłany zlecony dokument.

accountNumber - numer konta bankowego na który mają być przelane środki z tytułu spłaty zobowiązań wykazanych na zleconym wezwaniu 

 

Potwierdzenie przyjęcia zlecenia wysyłki wezwania, zawiera identyfikator zlecenia nadany przez system. Identyfikator może zostać użyty przy zleceniu usuniecia wysyłki lub pobrania dokumentu wezwania.

Szablony używane do wygenerowania dokumentu wezwania do zapłaty

Z uwagi na zakres danych, który musi zawierać poprawny dokument wezwania, utrzymywane są niezależne szablony wezwań do spłaty zobowiązań stwierdzonych tytułem wykonawczym i zobowiązań finansowych. Usługa umożliwia zlecenie wezwania w szablonie domyślnym, który został przygotowany przez BIG InfoMonitor oraz w szablonie dedykowanym, który został skonfigurowany w systemie biznes.big.pl. Deklaracja wersji szablonu (domyślny/dedykowany) dokonywana jest za pomocą atrybutu configuredTemplate. 

configuredTemplate = 'false' - system zleci wysyłkę w oparciu o szablon domyślny, dla rodzaju zobowiązania (finansowe lub stwierdzonego tytułem wykonawczym) przekazanym w zleceniu. Dokument zostanie wysłany w szablonie domyślnie również w przypadku gdy atrybut configuredTemplate nie zostanie przekazany w zleceniu.

configuredTemplate = 'true' - system zleci wysyłkę w oparciu o konfigurację szablonu zapisaną w profilu klienta w systemie biznes.big.pl. Zlecenie zostanie odrzucone, jeżeli nie został skonfigurowany szablon dla wskazanego w żądaniu rodzaju zobowiązania (finansowe lub z tytułu wykonawczego)

Przykład zapytania

Zapytanie

addPaymentSummonOrder
Kopiuj 
<?xml version="1.0" encoding="UTF-8"?>
<bl:updatePaymentSummonRequest xmlns:bl="http://api.big.pl/bimoL/v1" xmlns:bc="http://api.big.pl/bimo/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <client>
      <clientId>XXXXXX</clientId>
      <unitId>XXXXXX</unitId>
   </client>
   <repeatedRequestMarker>false</repeatedRequestMarker>
   <addPaymentSummonOrder configuredTemplate="false" notificationEmail="email@email.pl">
      <id>381003</id>
      <debtorName>Anna Testowa</debtorName>
      <liability xsi:type="bl:FinancialPaymentSummonLiability">
         <overdueAmount>123,44</overdueAmount>
         <currency />
         <financialDocumentNumber>dokument12/20.2222</financialDocumentNumber>
         <financialDocumentIssueDate>2024-05-20</financialDocumentIssueDate>
         <!-- opcjonalne -->
         <maturityDate>2024-05-20</maturityDate>
      </liability>
      <deliveryAddress xsi:type="bc:ConcatenatedAddress">
         <country>POL</country>
         <address>ul. jasna 1/2, 00-123 Warszawa</address>
      </deliveryAddress>
      <accountNumber>67203000030002000111111001</accountNumber>
   </addPaymentSummonOrder>
</bl:updatePaymentSummonRequest>

Odpowiedź

addPaymentSummonOrder
Kopiuj 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:updatePaymentSummonResponse xmlns:ns2="http://api.big.pl/iasWrapper/liabilities/v1" xmlns:ns3="http://api.big.pl/bimoL/v1">
    <success>
        <operationType>addPaymentSummonOrder</operationType>
        <orderId idType="internalId">381008</orderId>
        <orderId idType="externalId">381003</orderId>
    </success>
</ns3:updatePaymentSummonResponse>

 

Pobranie listy zleconych wezwań do zapłaty

Zlecenie udostępnienia listy zleconych wezwań, odbywa się za pośrednictwem operacji getPaymentSummonList udostępnionej w ramach metody getPaymentSummonRequest protokołu bimoL. Lista zawiera zlecenia, które zostały zamówione za pośrednictwem BIG API. 

 Lista może być filtrowana na podstawie niżej wymienionych atrybutów:

ordersScope - Zakres zleceń udostępnionych na liście

id - Identyfikator zlecenia ustalony w trakcie zamówienia wysyłki i/lub ustalony przez BIG InfoMonitor, który został zwrócony w odpowiedzi na zamówienie wysyłki

debtorName - Nazwa podmiotu któremu ma być doręczone wezwanie

status - aktualny status wysyłki

proxyClientId - identyfikator subskrybenta w imieniu którego zlecono wysyłki (operacja dostępna dla partnerów handlowych BIG)

shipmentNumber - numer nadania listu poleconego ustalony przez pocztę

orderDateCriterion - okres w którym zlecono wysyłkę

sentDateCriterion - okres w którym wysyłka została zrealizowana

Przykład zapytania

Zapytanie

getPaymentSummonList
Kopiuj 
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bl:getPaymentSummonRequest xmlns:bc="http://api.big.pl/bimo/v1" xmlns:bl="http://api.big.pl/bimoL/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <client>
            <clientId>XXXXXX</clientId>
            <unitId>XXXXXX</unitId>
        </client>
        <repeatedRequestMarker>false</repeatedRequestMarker>
        <getPaymentSummonList start="1" limit="10" counting="true" ordersScope="allOrders">
        </getPaymentSummonList>
</bl:getPaymentSummonRequest>

Odpowiedź

getPaymentSummonList
Kopiuj 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:getPaymentSummonResponse xmlns:ns2="http://api.big.pl/iasWrapper/liabilities/v1" xmlns:ns3="http://api.big.pl/bimoL/v1">
    <success ordersCount="2">
        <operationType>getPaymentSummonList</operationType>
        <paymentSummonOrder>
            <id idType="internalId">381532</id>
            <id idType="externalId">przeglad30306_033</id>
            <debtorName>Anna Testówka</debtorName>
            <liability xsi:type="ns3:FinancialPaymentSummonLiability" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <overdueAmount>123,44</overdueAmount>
                <currency>PLN</currency>
                <financialDocumentNumber>dokument12/20.2222</financialDocumentNumber>
                <financialDocumentIssueDate>2024-05-20</financialDocumentIssueDate>
                <maturityDate>2024-05-20</maturityDate>
            </liability>
            <deliveryAddress xsi:type="ns5:SplitAddress" xmlns:ns5="http://api.big.pl/bimo/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <country>POL</country>
                <postcode>00-123</postcode>
                <city>WARSZAWA</city>
                <street>JASNA</street>
                <houselocalNumber>1/2</houselocalNumber>
            </deliveryAddress>
            <accountNumber>67203000030002000111111001</accountNumber>
            <orderDate>2025-05-21T09:46:41</orderDate>
            <status>new</status>
            <clientId>1834192985</clientId>
        </paymentSummonOrder>
        <paymentSummonOrder>
            <id idType="internalId">381531</id>
            <id idType="externalId">przeglad30306_033</id>
            <debtorName>Anna Testówka</debtorName>
            <liability xsi:type="ns3:FinancialPaymentSummonLiability" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <overdueAmount>123,44</overdueAmount>
                <currency>PLN</currency>
                <financialDocumentNumber>dokument12/20.2222</financialDocumentNumber>
                <financialDocumentIssueDate>2024-05-20</financialDocumentIssueDate>
                <maturityDate>2024-05-20</maturityDate>
            </liability>
            <deliveryAddress xsi:type="ns5:SplitAddress" xmlns:ns5="http://api.big.pl/bimo/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <country>POL</country>
                <postcode>00-123</postcode>
                <city>WARSZAWA</city>
                <street>JASNA</street>
                <houselocalNumber>1/2</houselocalNumber>
            </deliveryAddress>
            <accountNumber>67203000030002000111111001</accountNumber>
            <orderDate>2025-05-21T09:40:06</orderDate>
            <status>canceled</status>
            <clientId>1834192985</clientId>
        </paymentSummonOrder>
    </success>
</ns3:getPaymentSummonResponse>

 

Anulowanie zlecenia wysyłki

Zlecenie anulowania wysyłki zleconego wezwania, odbywa się za pośrednictwem operacji withdrawPaymentSummonOrder udostępnionej w ramach metody updatePaymentSummonRequest  protokołu bimoL. Zlecenie anulowania wysyłki jest możliwe wyłącznie dla zleceń które oczekują na przyjęcie do realizacji przez BIG (status new). Zlecenie anulowania, wymaga przekazania identyfiktora zlecenia które ma zostać anulowane (identyfikator nadany w trakcie zlecenia lub ustalony przez system BIG)

Przykład zapytania

Zapytanie

withdrawPaymentSummonOrder
Kopiuj 
 <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bl:updatePaymentSummonRequest xmlns:bc="http://api.big.pl/bimo/v1" xmlns:bl="http://api.big.pl/bimoL/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <client>
            <clientId>XXXXXX</clientId>
            <unitId>XXXXXX</unitId>
        </client>
        <repeatedRequestMarker>false</repeatedRequestMarker>
        <withdrawPaymentSummonOrder>
            <id idType="externalId">wezwanie2714444</id>
        </withdrawPaymentSummonOrder>
</bl:updatePaymentSummonRequest>

Odpowiedź

withdrawPaymentSummonOrder
Kopiuj 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:updatePaymentSummonResponse xmlns:ns2="http://api.big.pl/iasWrapper/liabilities/v1" xmlns:ns3="http://api.big.pl/bimoL/v1">
    <success>
        <operationType>withdrawPaymentSummonOrder</operationType>
        <orderId idType="internalId">381531</orderId>
        <orderId idType="externalId">wezwanie2714444</orderId>
    </success>
</ns3:updatePaymentSummonResponse>

 

Pobranie dokumentu wezwania

Zlecenie udostępnienie pliku z dokumentem wysłanym w wyniku zlecenia wysyłki wezwania do zapłaty, odbywa się za pośrednictwem operacji getPaymentSummonDocument udostępnionej w ramach metody getPaymentSummonRequest protokołu bimoL. Zlecenie udostępnienia dokumentu jest możliwe wyłącznie dla zrealizowanych zleceń (status sent). Zlecenie udostępnienia obrazu wymaga przekazania identyfikatora zlecenia, który został ustalony w trakcie zamówienia wysyłki lub identyfikatora zlecenia, który został nadany przez BIG.

Przykład zapytania

Zapytanie

getPaymentSummonDocument
Kopiuj 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bl:getPaymentSummonRequest xmlns:bc="http://api.big.pl/bimo/v1" xmlns:bl="http://api.big.pl/bimoL/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <client>
            <clientId>XXXXXX</clientId>
            <unitId>XXXXXX</unitId>
        </client>
        <repeatedRequestMarker>false</repeatedRequestMarker>
        <getPaymentSummonDocument>
      <id>dokument_001</id>
        </getPaymentSummonDocument>
</bl:getPaymentSummonRequest>

Odpowiedź

getPaymentSummonDocument
Kopiuj 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:getPaymentSummonResponse xmlns:ns2="http://api.big.pl/iasWrapper/liabilities/v1" xmlns:ns3="http://api.big.pl/bimoL/v1">
    <success>
        <operationType>getPaymentSummonDocument</operationType>
        <paymentSummonOrder>
            <id idType="internalId">381533</id>
            <id idType="externalId">dokument_001</id>
            <debtorName>Anna Testówka</debtorName>
            <liability xsi:type="ns3:FinancialPaymentSummonLiability" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <overdueAmount>123,44</overdueAmount>
                <currency>PLN</currency>
                <financialDocumentNumber>dokument12/20.2222</financialDocumentNumber>
                <financialDocumentIssueDate>2024-05-20</financialDocumentIssueDate>
                <maturityDate>2024-05-20</maturityDate>
            </liability>
            <deliveryAddress xsi:type="ns5:SplitAddress" xmlns:ns5="http://api.big.pl/bimo/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                <country>POL</country>
                <postcode>00-123</postcode>
                <city>WARSZAWA</city>
                <street>JASNA</street>
                <houselocalNumber>1/2</houselocalNumber>
            </deliveryAddress>
            <accountNumber>67203000030002000111111001</accountNumber>
            <orderDate>2025-05-21T09:50:05</orderDate>
            <status>sent</status>
            <sentDate>2025-05-21</sentDate>
            <clientId>1834192985</clientId>
            <pdf>plik zakodowany w base64</pdf>
            </paymentSummonOrder>
      </success>
</ns3:getPaymentSummonResponse>