billing.read
Visualiza faturas, histórico financeiro de contratos e status de pagamentos.
Rota /billing
Faturamento & Faturas.
O módulo de faturamento gerencia o carregamento de mensalidades das operadoras de saúde e odontológicas, auxiliando a corretora e os clientes corporativos nas conciliações de pagamentos e auditoria atuarial.
billing.manage
Efetua uploads de faturas, edita metadados, marca conciliações e remove registros.
Upload & Conciliação
Processo de Gestão Financeira
1. Upload Direto (Até 4 MB)
Arquivos menores ou demonstrativos simples podem ser carregados instantaneamente direto para a API em uma única requisição.
2. Upload em Lote (Chunked - Até 15 MB)
Faturas de grandes corporações (com milhares de vidas) devem ser fatiadas em partes (chunks) de 2 MB até o limite máximo de 15 MB.
3. Fluxo de Conciliação
Permite que operadores marquem faturas como verificadas. Isso sinaliza para os dashboards gerenciais que a base de sinistro bate com o faturamento real.
Campos estruturais
Campos do Lote de Faturamento
| Campo | API / Payload | Finalidade |
|---|---|---|
| Título da Fatura | title | Obrigatorio. Identificação administrativa do lote ou fatura do mês. |
| Categoria Financeira | category | Obrigatorio. Tipo do documento (INVOICE, PAYMENT_SLIP, TAX_INVOICE, etc.). |
| Cliente | customerId | Opcional. Vincula a fatura ao cliente contratante correspondente. |
| Contrato Vinculado | contractId | Opcional. Associa o lote de faturamento a um contrato operacional. |
| Operadora / Seguradora | operator | Opcional. Nome ou código da operadora emitente do faturamento. |
| Competência | competence | Opcional. Mês e ano de referência do faturamento (MM/AAAA). |
| Valor da Fatura | amount | Opcional. Valor financeiro consolidado em reais (BRL). |
| Status de Pagamento | paid | Boolean. Flag que indica se a fatura foi marcada como Paga (paid = true). |
| Status de Conciliação | checked | Boolean. Indica se o lote foi auditado e verificado (checked = true). |
| Layout do Arquivo | processingType | Opcional. Tipo de importação técnica (OMINT_STYLE, BRADESCO_STYLE, etc.). |
Regras de integridade
Validações e Limites
Faturas com Contratos
Não é permitido excluir faturas que possuam vínculos comerciais ativos ou que façam parte de históricos consolidados de auditorias financeiras.
Segregação de Alçada
Apenas usuários com a permissão billing.manage podem alterar o status de faturas para 'Conciliado' (checked) ou 'Pago' (paid).
Tratamento de Multi-Linhas
Alguns contratos aceitam faturamento por dependentes (multi-line billing). O processador consolida os valores automaticamente.
Checklist Atuarial
Antes de consolidar no histórico
A operadora e o contrato foram selecionados corretamente antes de enviar o arquivo.
O valor monetário (BRL) bate exatamente com a soma consolidada na capa da fatura física.
A competência (mês e ano) foi preenchida de acordo com a vigência cobrada.
Para faturas pesadas, a barra de progresso do upload em chunks (lote) foi concluída.
A marcação de pago ou conciliado foi auditada e bate com o status do financeiro.