Statement PDF API для експортів акаунтів і платіжних даних
Генеруйте PDF виписок за акаунтом, оплатами й активністю з багатосторінковими рядками, підсумками, метаданими та необов’язковими архівними налаштуваннями PDF/A.
/api/v1/pdf/render Рендерити PDF клієнтських, акаунтних або платіжних виписок із даних періоду, початкових балансів, рядків активності, коригувань і підсумків, щоб користувачі могли завантажити послідовний запис для перегляду або зберігання.
Коли використовувати цю API
- Ваша система вже відповідає за баланси, періоди виписки, рядки транзакцій і підсумки.
- Потрібен PDF-експорт для історії акаунта, білінгових підсумків або фінансових процесів.
- Потрібен повторюваний багатосторінковий вивід із верхніми колонтитулами, нижніми колонтитулами й секціями підсумків.
- Може знадобитися PDF/A для архівних процесів.
Що вона не замінює
- Потрібне банківське підключення, звірка ledger або фінансова порада.
- Потрібні зашифровані виписки й PDF/A в одному запиті рендерингу. Публічний Render API розглядає security settings і PDF/A profile settings як взаємовиключні.
- Потрібне пакування e-invoice XML. Для цього використовуйте маршрут E-Invoice Render.
Який шлях API викликати
/api/v1/pdf/render
JSON Render — типовий шлях для цього сценарію.
/api/v1/template-render
Використовуйте, коли сценарію потрібен пов’язаний API-шлях, контракт шаблону або перевірка можливостей.
Мінімальний запит
POST /api/v1/pdf/render - титульна сторінка виписки з підсумками періоду.
{
"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" }
}
]
}
]
}
Що виконує gPdf
- Рендеринг DocumentRequest для сторінок виписки.
- Текстові блоки, таблиці, секції підсумків, нумерацію сторінок, метадані й налаштування PDF/A profile.
- Template Render для стабільного макета виписки й контракту полів.
- Бінарний PDF-вивід, придатний для завантаження або зберігання вашою системою.
Що контролює ваша система
- Логіку періоду виписки, баланси акаунта, дані транзакцій, правила валют і ідентичність клієнта.
- Архівну політику, контроль доступу, імена файлів і безпечну доставку.
- Будь-яку звірку, аудиторське затвердження або регульоване фінансове представлення.
Чеклист для робочого запуску
- Тестуйте довгі описи транзакцій, велику кількість рядків, порожні періоди й від’ємні баланси.
- Генеруйте request ID для кожного рендера виписки.
- Вирішіть, чи рендерити за запитом, чи зберігати кожну виписку після закриття періоду.
- Використовуйте PDF/A лише тоді, коли цього вимагає архівна політика виписки.
- Тримайте контроль доступу й автентифікацію клієнта поза render API.
Межі заявлених можливостей
- gPdf не обчислює баланси акаунтів і не звіряє ledger.
- API рендерить PDF виписок; ваша система відповідає за фінансову коректність.
- Вивід PDF/A — це налаштування рендерингу, а не заміна політики зберігання.
Виписки — це документи періоду
Сторінка виписки має починатися із закритого набору бізнес-фактів: акаунт, період, початковий баланс, рядки активності, коригування й кінцевий баланс. gPdf не вирішує ці факти. Він рендерить їх у PDF-макет, який користувачі можуть завантажити або ваша система може зберегти.
Робота з великими наборами рядків
Для великої кількості рядків проєктуйте виписку як повторюваний макет із областями таблиць, секціями підсумків і номерами сторінок. Використовуйте JSON Render під час налаштування макета. Переходьте на Template Render, коли контракт полів стабільний.
FAQ
- Чи може gPdf розрахувати баланси виписки?
- Ні. Ваша система надсилає період, баланси, рядки й підсумки. gPdf рендерить PDF.
- Чи можуть PDF виписок використовувати PDF/A?
- Так, JSON Render підтримує налаштування PDF/A profile. Ваша архівна політика визначає, чи потрібен PDF/A.
- Чи варто випискам використовувати Template Render?
- Зазвичай так після стабілізації макета. Template Render дозволяє сервісам-викликачам надсилати дані періоду без повторення координат сторінки.
- Чи зберігає gPdf виписки?
- Ні. Стандартні запити рендерингу повертають PDF-відповідь. Ваша система відповідає за зберігання й контроль доступу.