Dokumentacja protokołu BIG InfoMonitor
Raporty w formacie PDF

W ramach zamawiania raportów z BIG IM z wykorzystaniem BIG API istnieje możliwość zlecenia wygenerowania raportu w formacie PDF. Wygenerowany w wyniku takiego zamówienia plik PDF jest wizualizacją treści udostępnianej w XML. Oznacza to, że nie zawiera dodatkowych informacji w stosunku do informacji zawartych w XML. W ramach odpowiedzi na zapytanie obejmujące format PDF udostępniany jest link do unikalngeo pliku udostępnionego w systemie Biznes BIG.pl (biznes.big.pl). Dostęp do treści pliku jest zabezpieczony hasłem, które jest parametrem zapytania.

Przykładowe komunikaty

Zamówienie wersji PDF zleconego raportu wymaga dodania komponentu pdfReport do listy komponentów deklarowanych w elemencie components. Wybór komponentu obliguje do przekazania hasła, które umożliwi pobranie przygotowanego pliku PDF z raportem.

Przygotowany dokument bedzie dostępny pod adresem zapisanym w elmencie reportUrl, zapisanym w komunikacie odpowiedzi.

Próba wywołania linku w przeglądarce może zakończyć się na 3 sposoby:

  1. Pobraniem lub otworzeniem pliku PDF z raportem (przeglądarka lub czytnik PDF zażąda podania hasła przekazanego w zapytaniu);
  2. Wyświetleniem komunikatu z informacją o tym, że raport jest w trakcie przygotowywania – w takim wypadku należy odświeżyć stronę po jakimś czasie (np. po minucie);
  3. Wyświetleniem komunikatu informującego o tym, że strona o podanym adresie nie istnieje – tak będzie w przypadku kiedy podano błędny link do pliku lub jeżeli plik został usunięty po okresie udostępniania.

Zapytanie

PDF
Kopiuj 
<?xml version="1.0" encoding="UTF-8"?>
<br:getReportRequest xmlns:bc="http://api.big.pl/bimo/v1"
       xmlns:br="http://api.big.pl/bimoR/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://api.big.pl/bimoR/v1 bimoR.v1.xsd ">
    <client>
        <clientId>Identyfikator klienta</clientId>
        <unitId>identyfikator klienta</unitId>
    </client>
    <repeatedRequestMarker>false</repeatedRequestMarker>
    <reportComposition xsi:type="br:FinancialReportComposition">
             <product>entrepreneurBasic2020</product>
        <components select="custom">
            <imEntrepreneurFulfilledLiabilities>
                <componentRequestId>123</componentRequestId>
                <containRestricted>false</containRestricted>
                <searchByPesel>false</searchByPesel>
            </imEntrepreneurFulfilledLiabilities>
            <imEntrepreneurOverdueLiabilities>
                <componentRequestId>123</componentRequestId>
                <containRestricted>false</containRestricted>
                <searchByPesel>false</searchByPesel>
            </imEntrepreneurOverdueLiabilities>
            <pdfReport>
                <componentRequestId>123</componentRequestId>
                <password>BardzoMocneHaslo123</password>
            </pdfReport>
        </components>
        <reportSubject xsi:type="bc:LegalPerson">
            <fullName>JDR Sokolski</fullName>
            <shortName>JDR</shortName>
            <regon>155652248</regon>
            <nip>1212615971</nip>
        </reportSubject>
    </reportComposition>
</br:getReportRequest>

Raport

PDF
Kopiuj 
[<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns3:getReportResponse xmlns:ns2=http://api.big.pl/iasWrapper/reports/v1 xmlns:ns3=http://api.big.pl/bimoR/v1>
    <success>
        <currentRequest>
            <client>
                <clientId>1491187106</clientId>
                <unitId>1491187106</unitId>
            </client>
            <repeatedRequestMarker>false</repeatedRequestMarker>
            <reportComposition xsi:type="ns3:FinancialReportComposition" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance>
                <product>entrepreneurBasic2020</product>
                <components select="custom">
                    <imEntrepreneurOverdueLiabilities>
                        <componentRequestId>123</componentRequestId>
                        <containRestricted>false</containRestricted>
                        <searchByPesel>false</searchByPesel>
                    </imEntrepreneurOverdueLiabilities>
                    <imEntrepreneurFulfilledLiabilities>
                        <componentRequestId>123</componentRequestId>
                        <containRestricted>false</containRestricted>
                        <searchByPesel>false</searchByPesel>
                    </imEntrepreneurFulfilledLiabilities>
                    <pdfReport>
                        <componentRequestId>123</componentRequestId>
                        <password>Testbigpl9!</password>
                    </pdfReport>
                </components>
                <reportSubject xsi:type="ns5:LegalPerson" xmlns:ns5=http://api.big.pl/bimo/v1>
                    <fullName>Jednoosobowa działalność Robert Sokolski</fullName>
                    <shortName>PRINT</shortName>
                    <regon>155652248</regon>
                    <nip>1212615971</nip>
                </reportSubject>
            </reportComposition>
        </currentRequest>
        <exchangeRateTable>
            <id>128/A/NBP/2022</id>
            <date>2022-07-05</date>
        </exchangeRateTable>
        <components>
            <reportComponent>
                <componentId>BByMG0zDWV9EQ57Wzf2PisCIF6E=</componentId>
                <componentType>pdfReport</componentType>
                <validityDateTime>2022-07-05T16:25:13.368</validityDateTime>
                <processingResult>success</processingResult>
                <data xsi:type="ns3:PdfReportData" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance>
                    <reportUrl>https://stt.biznes.big.pl/public/reports/pdf-reports/bb09dfbd81134da295792297c39ed671</reportUrl>
                </data>
            </reportComponent>
            <reportComponent>
                <componentId>9YsjpPBhl+wAFKcWS6z7FeW3Vu4=</componentId>
                <componentType>imEntrepreneurOverdueLiabilities</componentType>
                <validityDateTime>2022-07-05T16:25:13.383</validityDateTime>
                <processingResult>success</processingResult>
                <data xsi:type="ns3:ImEntrepreneurOverdueLiabilitiesData" xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance>
                    <restrictedInformationsCount>0</restrictedInformationsCount>
                    <liabilitiesByCreditor>
                        <creditor>
                            <entity xsi:type="ns5:LegalPerson" xmlns:ns5=http://api.big.pl/bimo/v1>
                                <fullName>FIRMA PRINT_010</fullName>
                                <regon>377488512</regon>
                                <nip>4528121740</nip>
                                <officeAddress xsi:type="ns5:SplitAddress">
                                    <country>POL</country>
                                    <postcode>03-333</postcode>
                                    <city>WARSZAWA</city>
                                    <street>SZEROKA</street>
                                    <houselocalNumber>22</houselocalNumber>
                                </officeAddress>
                            </entity>
                            <industrySector>tvTelecom</industrySector>
                        </creditor>
                        <negativeInformation>
                            <id idType="internalId">9452615024569447621753</id>
                            <id idType="externalId">Test_0001</id>
                            <blockade status="false"/>
                            <providerRestrictedMarker>false</providerRestrictedMarker>
                            <debtor xsi:type="ns5:IndividualEntrepreneur" xmlns:ns5=http://api.big.pl/bimo/v1>
                                <fullName>Jednoosobowa działalność Robert Sokolski</fullName>
                                <regon>155652248</regon>
                                <nip>1212615971</nip>
                                <entrepreneurAdeAddress>AE:PL-12345-67890-ABCDE-12</entrepreneurAdeAddress>
                                <splitName>
                                    <forename>Robert</forename>
                                    <surname>Sokolski</surname>
                                </splitName>
                                <identity>
                                    <pesel>75013080895</pesel>
                                    <document>
                                        <id>HUN943837</id>
                                        <type>idCard</type>
                                    </document>
                                </identity>
                                <adeAddress>AE:PL-12345-67890-ABCDE-12</adeAddress>
                                <corespondenceAddress xsi:type="ns5:SplitAddress">
                                    <country>POL</country>
                                    <postcode>05-091</postcode>
                                    <city>WARSZAWA</city>
                                    <street>MORSKA</street>
                                    <houselocalNumber>2</houselocalNumber>
                                </corespondenceAddress>
                            </debtor>
                            <liability xsi:type="ns5:OverdueFinancialLiability" xmlns:ns5=http://api.big.pl/bimo/v1>
                                <id idType="internalId">5079356</id>
                                <id idType="externalId">Test_0001</id>
                                <currency>PLN</currency>
                                <amount>500.50</amount>
                                <overdueAmount>500.00</overdueAmount>
                                <objections status="notDisputed"/>
                                <creditorLimitation status="notExpired"/>
                                <limitation status="notExpired"/>
                                <dueDate>2021-07-13</dueDate>
                                <paymentCallDate>2021-07-13</paymentCallDate>
                                <type>contract</type>
                                <contractType>leasing</contractType>
                            </liability>
                            <validityDateTime>2022-07-05T16:25:13</validityDateTime>
                            <bigImBlockade status="false"/>
                            <peselBlockade status="false"/>
                            <transferedMarker>false</transferedMarker>
                            <takedOverMarker>false</takedOverMarker>
                        </negativeInformation>
                    </liabilitiesByCreditor>
                </data>
            </reportComponent>
            <reportComponent>
                <componentId>GsZvT3d0277/PSfePCYWvKje970=</componentId>
                <componentType>imEntrepreneurFulfilledLiabilities</componentType>
                <validityDateTime>2022-07-05T16:25:13.375</validityDateTime>
                <processingResult>noDataFound</processingResult>
            </reportComponent>
        </components>
    </success>
</ns3:getReportResponse>