contracts.read
Lista e visualiza contratos.
Rota /contracts
Cadastro de contratos.
Contrato e o vinculo operacional entre cliente, operadora, vigencia, linhas contratadas, regras comerciais, faturamento, beneficiarios, auditoria e analises.
contracts.manage
Cria, edita e exclui contratos.
billing.read / billing.manage
Consulta e administra configuracoes de faturamento.
claims.read
Acessa recursos de sinistralidade relacionados ao contrato.
Fluxos de criacao
Cliente existente ou cadastro completo
Novo Contrato
Use quando o cliente ja existe. Selecione cliente, operadora, dominio e parametros principais.
Novo Cliente + Contrato
Cria cliente e contrato em uma unica transacao quando a implantacao ainda nao tem cadastro.
Editar
Atualiza dados cadastrais, dominio, vigencia, faturamento, healthTerms e historico de renovacao.
Excluir
Operacao critica e permanente. Evite excluir contratos com historico operacional.
Campos principais
Dados que estruturam o contrato
| Campo | API | Uso |
|---|---|---|
| Cliente | customerId ou newCustomer | Cliente existente ou novo cliente criado no mesmo fluxo. |
| Operadora / Seguradora | providerId / provider | Obrigatoria para salvar o contrato. |
| Nome do contrato | name | Pode ser sugerido automaticamente se ficar em branco. |
| Dominio | productDomain | HEALTH, DENTAL, LIFE ou MULTI. |
| Ramo de seguro | insuranceLineId | Opcional; recomendado para contratos de Vida. |
| Codigo externo | externalCode | Codigo da operadora, apolice ou integracao. |
| Vidas estimadas | estimatedLives | Se vazio, vira 0. |
| Vigencia | startDate / endDate | Inicio e fim do periodo contratual. |
HEALTH
Saude, planos medicos e odontologicos. Pode criar healthTerms e regras atuariais.
LIFE
Seguro de vida, apolice, coberturas e capital segurado. Oculta parametros de saude.
MULTI
Estrutura combinada para contratos multibeneficios ou linhas contratadas mistas.
Estipulante e subestipulante
Estrutura comercial
Estipulante
Concentra planos, precos, regra de cobranca e premissas comerciais.
Subestipulante
Mantem beneficiarios e faturas proprios, mas herda a base comercial do estipulante.
Validacoes
Subestipulante exige parentContractId, mesmo tenant e mesmo dominio. Um contrato nao pode ser estipulante dele mesmo.
Faturamento
Configuracoes operacionais
layoutDetectedType: CUSTOM, OMINT_STYLE, BRADESCO_STYLE ou SULAMERICA_STYLE.
supportsMultiLineBilling: multiplas linhas de fatura por beneficiario.
hasFinancialEventsPerLife: eventos financeiros por vida.
hasMultipleEntriesPerBeneficiary: multiplos lancamentos por beneficiario.
usesCostCenter e usesDependentsStructure: centro de custo e estrutura titular/dependentes.
billingCutoffDay, proRataStrategy e ageChangeStrategy: corte, pro-rata e mudanca de faixa.
Renovacao e parametros atuariais
O que sustenta os relatorios executivos
Vigencia e aniversario
contractAnniversaryDate, startDate, endDate e renewalWindowDays orientam alertas de renovacao.
Breakeven e sinistro
breakevenPercent, revenueBasis, claimsBasis e coparticipacao melhoram as projecoes.
Historico anual
renewalHistory guarda periodos, notas e registros por ano; cada ano deve ser unico por contrato.
Checklist antes de salvar
Revisao operacional
Cliente e operadora foram selecionados corretamente.
Dominio do contrato esta correto antes de criar subestipulantes.
Codigo externo foi preenchido quando existe apolice, contrato da operadora ou integracao.
Vigencia, aniversario e janela de renovacao foram revisados.
Breakeven, pool de risco e bases de receita/sinistro foram preenchidos quando aplicavel.
Subestipulante foi marcado apenas quando herda planos, precos e regra comercial do estipulante.
Para LIFE, parametros de saude foram evitados e o ramo Vida em Grupo foi considerado.