documents.read
Visualiza a lista de arquivos e efetua o download dos documentos permitidos.
Rota /documents
Repositório de Documentos.
A central de documentos funciona como um cofre digital seguro para gerenciar e compartilhar faturas, relatórios analíticos, termos, apólices e relatórios de sinistro associados a clientes e contratos.
documents.manage
Efetua uploads, altera metadados, ajusta a visibilidade e exclui documentos.
Segurança & Auditoria
Rastreabilidade de Arquivos
1. Controle de Sensibilidade
Arquivos com dados pessoais sensíveis (como folhas de pagamento e CIDs) são isolados e exigem permissões explícitas no RBAC.
2. Log de Auditoria (AccessLog)
Rastreamento completo de downloads. O sistema grava o autor do download (nome/e-mail), endereço de IP e horário exato da ação.
3. Status de Expiração
Alerta visual dinâmico com três estágios: 'Válido' (ok), 'Expira em breve' (soon, em até 7 dias) ou 'Expirado' (expired).
Campos principais
Upload e Metadados
| Campo | API / DB | Descrição |
|---|---|---|
| Título do Arquivo | title | Obrigatorio. Nome gerencial exibido nas listagens do sistema. |
| Descrição | description | Opcional. Texto informativo sobre o conteúdo ou instruções do documento. |
| Categoria | category | Obrigatorio. Tipo do documento (Fatura, Boleto, Contrato, Sinistro, RH, etc.). |
| Categoria Customizada | customCategory | Opcional. Permite criar uma categoria nova digitando o nome livremente. |
| Cliente | customerId | Opcional. Vincula o documento a uma empresa cliente específica do tenant. |
| Contrato | contractId | Opcional. Vincula o documento a um contrato específico para fácil localização. |
| Competência | competence | Opcional. Mês e ano de referência (MM/AAAA) para competências mensais. |
| Data de Expiração | expiresAt | Opcional. Data limite de vigência; o sistema alerta quando expirar. |
| Visível no Portal | isVisible | Obrigatorio (default true). Se ativo, o beneficiário visualiza o arquivo no portal. |
Organização
Categorias de Documentos do Sistema
| Código da Categoria | Nome Amigável | Finalidade Prática |
|---|---|---|
| INVOICE / PAYMENT_SLIP | Fatura de Cobrança / Boleto | Controle de guias de pagamento e mensalidades. |
| BILLING_STATEMENT | Demonstrativo de Faturamento | Relatório analítico de cobrança com vidas detalhadas. |
| TAX_INVOICE | Nota Fiscal | Documentos fiscais emitidos pelas operadoras ou corretoras. |
| ANALYTICAL_REPORT / CLAIMS | Relatório Analítico / Sinistro | Estudos de sinistralidade e ofensores de custo. |
| CONTRACT / POLICY / ENDORSEMENT | Contrato / Apólice / Endosso | Documentação legal do seguro e termos assinados. |
| RENEWAL / PROPOSAL | Renovação / Proposta | Estudos de reajuste técnico anual e cotações de mercado. |
| PAYROLL / HR | Folha de Pagamento / RH | Documentos corporativos confidenciais de colaboradores. |
Checklist Operacional
Revisão antes de salvar o upload
A categoria do documento foi selecionada corretamente para organizar o painel.
Caso seja um documento sensível, a sensibilidade foi marcada e a visibilidade revisada.
O arquivo foi associado ao cliente e ao contrato correspondente, se houver.
A competência (MM/AAAA) e a data de expiração foram inseridas para documentos periódicos.
O botão de visibilidade no portal ('isVisible') foi marcado como inativo para arquivos internos do RH/Corretora.