API PDF zestawień dla eksportów konta i billingowych
Generuj PDF zestawień konta, rozliczeń i aktywności z wielostronicowymi wierszami, sumami, metadanymi i opcjonalnymi ustawieniami archiwalnymi PDF/A.
/api/v1/pdf/render Renderuj PDF zestawień klienta, konta albo rozliczeń z danych okresu, sald otwarcia, pozycji, korekt i sum, aby użytkownicy mogli pobrać spójny zapis do przeglądu albo retencji.
Kiedy użyć tej API
- Twój system odpowiada już za salda, okresy zestawień, wiersze transakcji i sumy.
- Potrzebujesz eksportu PDF dla historii konta, podsumowań billingowych albo procesów finansowych.
- Potrzebujesz powtarzalnego, wielostronicowego wyjścia z nagłówkami, stopkami i sekcjami podsumowań.
- Możesz potrzebować wyjścia PDF/A dla procesów archiwizacji.
Czego nie zastępuje
- Potrzebujesz łączności bankowej, uzgadniania ksiąg albo porad finansowych.
- Potrzebujesz szyfrowanych zestawień i PDF/A w tym samym żądaniu renderowania. Publiczne Render API traktuje ustawienia zabezpieczeń i profilu PDF/A jako wzajemnie wykluczające się.
- Potrzebujesz pakowania XML e-faktury. Do tego użyj endpointu E-Invoice Render.
Który endpoint wywołać
/api/v1/pdf/render
JSON Render to domyślna ścieżka dla tego procesu.
/api/v1/template-render
Użyj, gdy proces wymaga powiązanej ścieżki API, kontraktu szablonu albo sprawdzenia capabilities.
Minimalny request
POST /api/v1/pdf/render - strona tytułowa zestawienia z sumami okresu.
{
"settings": {
"profile": "pdfa-2b"
},
"pages": [
{
"size": "letter",
"elements": [
{
"type": "text",
"x": 18,
"y": 20,
"content": "Account Statement",
"style": { "font_size": 18, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 18,
"y": 38,
"content": "Period: 2026-05-01 to 2026-05-31\nOpening balance: $1,240.00\nClosing balance: $1,890.25",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
}
]
}
]
}
Co obsługuje gPdf
- Renderowanie DocumentRequest dla stron zestawienia.
- Bloki tekstu, tabele, sekcje sum, numerację stron, metadane i ustawienia profilu PDF/A.
- Template Render dla stabilnego układu zestawienia i kontraktu pól.
- Binarne wyjście PDF odpowiednie do pobrania albo przechowywania przez Twój system.
Co kontroluje Twój system
- Logikę okresu zestawienia, salda kont, dane transakcji, reguły walutowe i tożsamość klienta.
- Politykę archiwizacji, kontrolę dostępu, nazewnictwo plików i bezpieczne dostarczanie.
- Każde uzgodnienie, zatwierdzenie audytowe albo regulowaną reprezentację finansową.
Checklist produkcyjny
- Przetestuj długie opisy transakcji, dużą liczbę wierszy, puste okresy i salda ujemne.
- Generuj request ID dla każdego renderowania zestawienia.
- Zdecyduj, czy renderować na żądanie, czy przechowywać każde zestawienie po zamknięciu okresu.
- Używaj PDF/A tylko wtedy, gdy wymaga tego polityka archiwizacji zestawienia.
- Trzymaj kontrolę dostępu i uwierzytelnianie klienta poza Render API.
Granice deklaracji
- gPdf nie oblicza sald kont ani nie uzgadnia ksiąg.
- API renderuje PDF zestawień; Twój system odpowiada za poprawność finansową.
- Wyjście PDF/A jest ustawieniem renderowania, a nie zamiennikiem polityki retencji.
Zestawienia są dokumentami okresowymi
Strona zestawienia powinna zaczynać się od zamkniętego zestawu faktów biznesowych: konta, okresu, salda otwarcia, wierszy aktywności, korekt i salda zamknięcia. gPdf nie decyduje o tych faktach. Renderuje je w układzie PDF, który użytkownicy mogą pobrać albo Twój system może przechować.
Obsługa dużej liczby wierszy
Dla dużej liczby wierszy zaprojektuj zestawienie jako powtarzalny układ z obszarami tabel, sekcjami podsumowań i numeracją stron. Używaj JSON Render podczas dopracowywania układu. Przejdź na Template Render, gdy kontrakt pól jest stabilny.
FAQ
- Czy gPdf może obliczać salda zestawień?
- Nie. Twój system wysyła okres, salda, wiersze i sumy. gPdf renderuje PDF.
- Czy PDF zestawień mogą używać PDF/A?
- Tak, JSON Render obsługuje ustawienia profilu PDF/A. O tym, czy PDF/A jest wymagany, decyduje Twoja polityka archiwizacji.
- Czy zestawienia powinny używać Template Render?
- Zwykle tak po ustabilizowaniu układu. Template Render pozwala systemom wywołującym wysyłać dane okresu bez powtarzania współrzędnych stron.
- Czy gPdf przechowuje zestawienia?
- Nie. Standardowe żądania renderowania zwracają odpowiedź PDF. Twój system odpowiada za przechowywanie i kontrolę dostępu.