Dokumentacja

Jak korzystać z ESGraport

Przewodnik po wszystkich funkcjach platformy — od wypełnienia ankiety po eksport danych i API.

Krok 1

Ankieta ESG

Ankieta to podstawa raportu. Dane, które wprowadzisz, są przetwarzane przez AI i przekształcane w pełny dokument ESG zgodny z wybranym standardem.

Kwalifikacja

Podajesz liczbę pracowników, przychód, czy firma jest notowana i czy duży klient wymaga raportu. System automatycznie dobiera standard: VSME Podstawowy, VSME Rozszerzony lub CSRD/ESRS.

Krok 1 — Dane firmy

Podstawowe informacje: nazwa, NIP, branża, rok raportowania, opis działalności, strategia ESG.

Krok 2 — Środowisko (E)

Energia, emisje GHG (Zakres 1, 2, 3), gospodarka odpadami, woda, bioróżnorodność. Zakres pytań zależy od wybranego standardu.

Krok 3 — Społeczeństwo (S)

Pracownicy, BHP, szkolenia, różnorodność i równość wynagrodzeń, prawa człowieka w łańcuchu dostaw.

Krok 4 — Ład korporacyjny (G)

Kodeks etyki, polityka antykorupcyjna, audyty, zarządzanie danymi, struktura własnościowa.

Ankieta zapisuje się automatycznie po każdej zmianie pola. Możesz wrócić do niej w dowolnym momencie — dane nie zginą.
Generowanie AI

Generowanie raportu

Po wypełnieniu wszystkich 4 kroków ankiety pojawia się przycisk "Generuj raport ESG przez AI". Kliknięcie go wysyła dane do modelu Claude (Anthropic) i generuje pełny raport w formacie Markdown, który jest następnie konwertowany do PDF.

Czas generowania
  • VSME Podstawowy — ok. 30–45 sekund
  • VSME Rozszerzony — ok. 45–75 sekund
  • CSRD/ESRS Pełny — ok. 60–120 sekund

Nie zamykaj okna przeglądarki w trakcie generowania.

Raport generowany przez AI należy zweryfikować przed przekazaniem do banku lub kontrahenta. Dane są oparte wyłącznie na tym, co wprowadziłeś w ankiecie.
Eksport

Eksport PDF

Każdy wygenerowany raport jest automatycznie zapisywany jako plik PDF. Możesz pobrać go z panelu klikając ikonę PDF obok raportu lub z widoku raportu przyciskiem "Pobierz PDF".

Co zawiera PDF
  • Logo firmy (jeśli wgrane) lub nazwa firmy w nagłówku
  • Metadane: firma, NIP, standard, data wygenerowania
  • Pełna treść raportu ESG (5 000–12 000 słów)
  • Tabele KPI z danymi ze wszystkich obszarów E, S, G
  • Sekcja oświadczeń i rekomendacji
CSV

Eksport CSV

Z każdego raportu możesz wyeksportować wskaźniki KPI jako plik CSV gotowy do otwarcia w Excelu, Google Sheets lub zaimportowania do systemu finansowego.

Plik zawiera kolumny: Wskaźnik · Wartość · Jednostka · Standard VSME. Obejmuje wszystkie wypełnione wskaźniki z obszarów E, S i G.

# przykładowe wiersze pliku CSV Wskaźnik;Wartość;Jednostka;Standard Zużycie energii;120000;kWh/rok;E-B4 Udział OZE;25;%;E-B4 Emisje Zakres 1;12.5;tCO2e/rok;E-B4 Emisje Zakres 2;55.0;tCO2e/rok;E-B4 Pracownicy ogółem;48;os.;S-B1 Kobiety w zatrudnieniu;42;%;S-B1
Plik CSV jest kodowany w UTF-8 z BOM, dzięki czemu polskie znaki poprawnie wyświetlają się po otworzeniu w Excelu.

Link do pobrania: Panel → lista raportów → ikona CSV przy wybranym raporcie, lub bezpośrednio pod adresem /panel/raport/{id}/csv.

XBRL

Eksport XBRL

XBRL (eXtensible Business Reporting Language) to ustandaryzowany format XML używany przez instytucje finansowe, audytorów i regulatorów. ESGraport generuje plik XBRL ze wskaźnikami VSME otagowanymi zgodnie z taksonomią EFRAG.

Struktura pliku XBRL
  • Kontekst (xbrli:context) z datami okresu raportowania
  • Identyfikator firmy (NIP) w schemacie http://www.nip.pl
  • Wskaźniki środowiskowe: vsme:GHGEmissionsScope1, vsme:TotalEnergyConsumption i inne
  • Wskaźniki społeczne: vsme:TotalEmployees, vsme:GenderPayGap i inne
  • Wskaźniki ładu: vsme:CodeOfConductExists, vsme:AntiCorruptionPolicyExists
Plik XBRL ESGraport używa przestrzeni nazw EFRAG VSME 2024. Przed złożeniem do regulatora upewnij się, że wymagana jest ta konkretna wersja taksonomii.

Link do pobrania: Panel → lista raportów → ikona XBRL przy wybranym raporcie.

Logo

Logo firmy w PDF

Możesz wgrać logo swojej firmy, które będzie wyświetlane w nagłówku każdego wygenerowanego PDF zamiast nazwy tekstowej.

Wymagania pliku
FormatPNG, JPG, SVG, WebP
RozmiarMaks. 500 KB
WymiaryZalecane: min. 200 px szerokości, maks. 160 × 48 px w PDF

Wgraj logo w sekcji Panel → "Logo firmy". Logo jest od razu aktywne dla wszystkich nowych raportów PDF.

Logo jest wyświetlane w nagłówku PDF obok metadanych raportu. Wcześniej wygenerowane PDF nie zmieniają się — nowe logo obowiązuje od następnego raportu.
Analiza trendu

Historia i porównanie YoY

Strona Historia (/panel/historia) pokazuje wszystkie raporty firmy uszeregowane według roku raportowania. Dla każdego roku wyświetlana jest tabela KPI, dzięki czemu możesz śledzić zmianę wskaźników ESG rok do roku (Year-over-Year).

Co widać na stronie historii
  • Wszystkie raporty firmy pogrupowane według roku
  • Kluczowe wskaźniki E, S, G dla każdego roku w tabeli porównawczej
  • Linki do podglądu i pobrania PDF dla każdego raportu
  • Szybkie linki eksportu CSV i XBRL
Rok wyświetlany w historii to rok raportowania podany w kroku 1 ankiety (pole "Rok raportowania"), a nie data wygenerowania raportu w systemie.
REST API

REST API

ESGraport udostępnia REST API w formacie JSON umożliwiające programatyczny dostęp do raportów. Przydatne do integracji z wewnętrznymi systemami, dashboardami BI czy automatycznym raportowaniem.

Autoryzacja

API używa Bearer Token. Token generujesz w panelu w sekcji "Token API". Wygenerowany token jednorazowo wyświetli się w panelu — skopiuj go i zapisz.

# Nagłówek do każdego żądania: Authorization: Bearer twoj_token_api_tutaj

Endpointy

MetodaEndpointOpis
GET /api/v1/reports Lista wszystkich raportów firmy
GET /api/v1/reports/{id} Szczegóły raportu + dane KPI (E, S, G)

Przykład — lista raportów

# Żądanie curl -H "Authorization: Bearer twój_token" \ https://esgraport.com/api/v1/reports # Odpowiedź { "data": [ { "id": 42, "status": "approved", "report_type": "vsme_basic", "generated_at": "2025-03-15T14:22:00Z" } ] }

Przykład — dane KPI raportu

curl -H "Authorization: Bearer twój_token" \ https://esgraport.com/api/v1/reports/42 # W odpowiedzi pole kpi zawiera surowe dane ze wszystkich kroków ankiety: { "data": { "id": 42, "kpi": { "environment": { "energy_kwh": "120000", "ghg_scope1_est": "12.5", ... }, "social": { "emp_total": "48", "emp_women_pct": "42", ... }, "governance": { "ethics_code": "tak", ... } } } }

Kody odpowiedzi

KodZnaczenie
200Sukces
401Brak tokenu lub nieprawidłowy token
404Raport nie istnieje lub należy do innego użytkownika
Standardy

Standardy raportowania VSME / CSRD

ESGraport automatycznie dobiera standard na podstawie kwalifikacji firmy. Możesz też zmienić go ręcznie klikając baner standardu w górnej części ankiety.

StandardDla kogoZakres
VSME Podstawowy
Moduł A
Mikro i małe MŚP
< 50 pracowników, < 10M PLN przychodu
Energia, emisje Scope 1+2, pracownicy, BHP, ład podstawowy
VSME Rozszerzony
Moduł A+B
Średnie MŚP lub wymagane przez klienta
50–249 pracowników lub > 10M PLN
+ Scope 3, woda, bioróżnorodność, luka płacowa K/M, łańcuch dostaw
CSRD / ESRS Pełny Duże firmy i spółki giełdowe
≥ 250 pracowników lub ≥ 170M PLN przychodu
Pełne ESRS E1–E5, S1–S4, G1 — wymagany przez prawo UE
Kwalifikacja

Jak działa kwalifikacja firmy

Kwalifikacja to pierwsza część ankiety — na jej podstawie system wybiera odpowiedni standard raportowania. Możesz ją zmienić w dowolnym momencie klikając badge standardu na górze ankiety.

Drzewo decyzyjne
  • Firma notowana na giełdzie lub ≥ 250 pracowników lub ≥ 170M PLN przychodu → CSRD/ESRS
  • Duży klient wymaga raportu lub ≥ 50 pracowników lub ≥ 10M PLN → VSME Rozszerzony
  • Pozostałe → VSME Podstawowy

Gotowy do pierwszego raportu?

Wypełnij ankietę i wygeneruj raport ESG w kilkanaście minut.

Zacznij bezpłatnie Masz pytania? Napisz