API de extrato em PDF para exportações de conta e cobrança
Gere PDFs de extratos de conta, cobrança e atividade com linhas em várias páginas, totais, metadados e configurações PDF/A opcionais para arquivamento.
/api/v1/pdf/render Renderizar PDFs de extrato de cliente, conta ou cobrança a partir de dados de período, saldos iniciais, itens de linha, ajustes e totais, para que usuários baixem um registro consistente para revisão ou retenção.
Quando usar esta API
- Seu sistema já controla saldos, períodos de extrato, linhas de transação e totais.
- Você precisa de uma exportação em PDF para histórico de conta, resumos de cobrança ou fluxos financeiros.
- Você precisa de saída repetível em várias páginas com cabeçalhos, rodapés e seções de resumo.
- Você pode precisar de saída PDF/A para fluxos de arquivamento.
O que ela não substitui
- Você precisa de conectividade bancária, reconciliação de ledger ou aconselhamento financeiro.
- Você precisa de extratos criptografados e PDF/A na mesma requisição de renderização. A Render API pública trata configurações de segurança e configurações de perfil PDF/A como mutuamente exclusivas.
- Você precisa de empacotamento XML de e-invoice. Use o endpoint E-Invoice Render para isso.
Qual endpoint chamar
/api/v1/pdf/render
JSON Render é o caminho padrão para este fluxo.
/api/v1/template-render
Use quando o fluxo precisar da API relacionada, de um contrato de template ou de uma consulta de capacidades.
Request mínimo
POST /api/v1/pdf/render - capa de extrato com totais do período.
{
"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" }
}
]
}
]
}
O que a gPdf faz
- Renderização de DocumentRequest para páginas de extrato.
- Blocos de texto, tabelas, seções de totais, numeração de páginas, metadados e configurações de perfil PDF/A.
- Template Render para layout de extrato estável e contrato de campos.
- Saída binária em PDF adequada para download ou armazenamento pelo seu sistema.
O que seu sistema controla
- Lógica de período do extrato, saldos de conta, dados de transação, regras de moeda e identidade do cliente.
- Política de arquivamento, controle de acesso, nomes de arquivo e entrega segura.
- Qualquer reconciliação, aprovação de auditoria ou representação financeira regulada.
Checklist de produção
- Teste descrições longas de transação, altas contagens de linhas, períodos vazios e saldos negativos.
- Gere um ID de requisição para cada renderização de extrato.
- Decida se o extrato será renderizado sob demanda ou armazenado após o fechamento do período.
- Use PDF/A apenas quando a política de arquivamento do extrato exigir.
- Mantenha controle de acesso e autenticação do cliente fora da API de renderização.
Limites da promessa
- O gPdf não calcula saldos de conta nem reconcilia ledgers.
- A API renderiza PDFs de extrato; seu sistema controla a correção financeira.
- Saída PDF/A é uma configuração de renderização, não substitui uma política de retenção.
Extratos são documentos de período
Uma página de extrato deve partir de um conjunto fechado de fatos de negócio: conta, período, saldo inicial, linhas de atividade, ajustes e saldo final. O gPdf não decide esses fatos. Ele os renderiza em um layout de PDF que seus usuários podem baixar ou que seu sistema pode armazenar.
Como lidar com muitas linhas
Para altas contagens de linhas, desenhe o extrato como um layout repetível com regiões de tabela, seções de resumo e números de página. Use JSON Render enquanto ajusta o layout. Migre para Template Render quando o contrato de campos estiver estável.
FAQ
- O gPdf pode calcular saldos de extrato?
- Não. Seu sistema envia período, saldos, linhas e totais. O gPdf renderiza o PDF.
- Extratos em PDF podem usar PDF/A?
- Sim, JSON Render oferece suporte a configurações de perfil PDF/A. Sua política de arquivamento decide se PDF/A é obrigatório.
- Extratos devem usar Template Render?
- Normalmente sim, depois que o layout estiver estável. Template Render permite que chamadores enviem dados de período sem repetir coordenadas de página.
- O gPdf armazena extratos?
- Não. Requisições de renderização padrão retornam a resposta em PDF. Seu sistema controla armazenamento e controle de acesso.