pending, overdue, ou já delivered.
Por que os prazos existem
A geração de relatórios responde como e o quê. Prazos respondem quando e se foi cumprido. Sem uma camada de rastreamento, uma equipe pode produzir relatórios perfeitos e ainda perder uma janela de envio. Nada no mecanismo de geração de relatórios em si sabe que um relatório estava vencendo. Prazos resolvem um problema de compliance de entrega. Eles transformam obrigações de geração de relatórios recorrentes em compromissos rastreados e datados, para que nada escape silenciosamente:
- Obrigações de envio regulatório: muitos envios devem chegar a um regulador em um cronograma fixo. Um prazo registra essa obrigação, a recorrência dela e o estado de entrega dela, para que um envio perdido ou atrasado fique visível antes de se tornar um incidente de compliance.
- SLAs internos: relatórios de negócio recorrentes costumam carregar compromissos internos (“o financeiro recebe o pacote de fechamento mensal até o dia 5”). Prazos tornam esses compromissos explícitos e mensuráveis.
- Trilhas de auditoria para entrega: cada prazo registra
deliveredAte passa porpending→overdue→delivered. Isso deixa um histórico auditável de quando cada obrigação foi cumprida, não apenas que um relatório existe.
Quem usa os prazos
Prazos são uma ferramenta de negócio e compliance construída sobre o mecanismo de geração de relatórios. Usuários típicos incluem:
- Uma fintech que entrega relatórios regulatórios ao BACEN em cronogramas fixos mensais ou anuais. Ela usa prazos para rastrear e cumprir cada janela de envio.
- Uma equipe de tesouraria ou financeiro rastreando entregas de relatórios mensais recorrentes, usando a visualização de calendário e status para confirmar que cada saída rotineira foi enviada no prazo.
- Um profissional de compliance monitorando obrigações vencidas em toda a organização, filtrando pelo status
overduepara identificar qualquer coisa em risco antes que escale.
Como os prazos se encaixam no workflow do Reporter
Prazos envolvem relatórios e fontes de dados para adicionar uma camada de status de entrega sobre o mecanismo de geração de relatórios. Fontes de Dados fornecem os dados, Templates definem o resultado, e o ciclo de vida da geração de relatórios produz o arquivo. Um prazo fica acima de tudo isso. Ele opcionalmente se vincula ao template que cumpre a obrigação, observa a data de vencimento, e expõe um único status. O status informa ao negócio se a obrigação foi cumprida. Prazos são não intrusivos. Eles nunca disparam, geram, ou enviam um relatório. Eles observam e registram. Você ainda gera relatórios pelo ciclo de vida normal, e o prazo registra o status de entrega.
O que um prazo rastreia
Cada prazo captura a data de vencimento de uma obrigação de relatório, além dos metadados que a sua equipe precisa para gerenciá-la:
O Reporter também mantém campos somente leitura em cada prazo:
id, status (pending, overdue, ou delivered), deliveredAt, templateName, createdAt, e updatedAt.
Inclua um header
Authorization: Bearer <token> em cada requisição de prazo se o seu ambiente habilitar o Access Manager.Criando um prazo
Crie um prazo com o endpoint Criar um Prazo (
POST /v1/deadlines).
Os campos obrigatórios são name, type, frequency, dueDate, e color. Os campos restantes são opcionais. Defina templateId para vincular o prazo ao template que o cumpre, e notifyDaysBefore para controlar quando os lembretes começam.
201 Created com o prazo completo, incluindo o id gerado e um status inicial.
Listando prazos
Recupere prazos com o endpoint Recuperar Prazos (
GET /v1/deadlines). O endpoint pagina os resultados, e você pode filtrá-los por status.
Por exemplo, para listar prazos vencidos, dez por página:
items além de page, limit, e total para paginação.
Atualizando um prazo
Atualize um prazo existente com o endpoint Atualizar um Prazo (
PATCH /v1/deadlines/{id}). O endpoint altera apenas os campos no corpo da requisição, então você pode enviar um payload parcial. Por exemplo, adie uma data de vencimento ou desative um prazo:
200 OK com o prazo atualizado.
Excluindo um prazo
Remova um prazo que você não precisa mais rastrear com o endpoint Excluir um Prazo (
DELETE /v1/deadlines/{id}). Uma requisição bem-sucedida retorna 204 No Content.
Marcando um prazo como entregue
Depois de protocolar ou enviar o relatório por trás de um prazo, marque o prazo como entregue. Use o endpoint Entregar um Prazo (
PATCH /v1/deadlines/{id}/deliver). Ele move o status do prazo para delivered e registra deliveredAt.
delivered é um booleano, o mesmo endpoint também pode reverter a ação. Envie "delivered": false para reabrir um prazo que você marcou como entregue por engano. Uma requisição bem-sucedida retorna 200 OK com o prazo atualizado.
Entregar um prazo apenas rastreia a obrigação. Isso registra que a obrigação foi cumprida. Isso não gera nem envia o relatório subjacente. Gere o relatório pelo ciclo de vida da geração de relatórios, depois marque o prazo como entregue para manter o seu rastreador preciso.
Como os prazos se encaixam no workflow
Uma obrigação típica passa por estes estados:
1
Criar o prazo
Registre a obrigação com a data de vencimento, a frequência e o template opcional dela.
2
Rastrear o status dele
Aparece como
pending até a data de vencimento, depois overdue se você não entregar o relatório a tempo.3
Gerar o relatório
Produza o relatório pelo ciclo de vida da geração de relatórios normal, usando o template vinculado.
4
Marcá-lo como entregue
Chame o endpoint de entrega para definir o
status como delivered e registrar deliveredAt.Próximos passos
Primeiros passos com o Reporter
Percorra o ciclo de vida da geração de relatórios que os prazos rastreiam.
Usando o Reporter
Construa os templates que cumprem seus prazos.
Templates do BACEN
Templates prontos para uso para geração de relatórios regulatórios brasileiros.
API de Prazos
Referência completa de requisição e resposta para cada endpoint de prazo.