# Nomenclaturas No contexto do sistema **Siprov**, existem várias entidades principais que podem estar vinculadas, conforme o que existe no processo de uma pessoa jurídica usuária do sistema. Abaixo, descreveremos essas principais entidades para as quais será necessária ter uma compreensão mínima para um entendimento melhor da nossa API. ### Siprov É o nome do sistema com o qual essa API interage para consulta, inserção ou edição de dados. Esse sistema é desenvolvido pela empresa [Rumo Tecnologia](https://www.rumotecnologia.com.br). ### Cliente Siprov É a entidade principal do sistema, que é a pessoa jurídica que contrata o sistema para uso em sua operação. Essa entidade é sempre única em todo o sistema e estará ativa junto à Rumo Tecnologia conforme critérios administrativos, comerciais, contratuais e financeiros. ### Cliente (Associado) O consumidor padrão do negócio pode ser referenciado como **Associado** ou **Cliente** dependendo do contexto do respectivo [Cliente Siprov](#cliente-siprov). Podem-se adotar outros nomes também, considerando que essa entidade é apelidada no sistema. Esse cliente certamente vai estar vinculado a outra entidade, que é a [**Unidade**](#unidade-loja-ou-regional). ### Unidade (Loja ou Regional) Tal entidade, que também pode ser referenciada como **Loja**, é basicamente uma subdivisão do [Cliente Siprov](#cliente-siprov). Logo, essa entidade vai ser a filial ou regional da pessoa jurídica principal do sistema. ### Benefício (Contrato) O [Cliente](#associado) enquanto consumidor de algum serviço, vai ter vinculado em seu cadastro a entidade **Benefício**, que é um registro no sistema que podemos entender, de forma genérica, como um contrato. Nesse caso, o benefício terá informações e controles conforme o seu tipo. O tipo determina campos específicos e até módulos adicionais no sistema para prover a operação ideal do negócio diretamente relacionado. Os tipos podem ser de: * Assinatura * *Benefícios que demandam controle de saldo com cobrança recorrente.* * Assistência 24h * *Benefícios com a especifidade de controle de atendimento e acompanhamento imediato, como em serviços de assistência 24 horas, rastreamento, dentre outros.* * Consórcio * *Benefício específico para empresas de consórcio e que usam tabela de preço e grupos de consórcio.* * Diversos * *Benefício que contempla uma operação genérica de venda, contrato, financeiro, dentre outros, na empresa.* * Proteção Veicular * *Benefício específico para contratos que tem como item o veículo do cliente, com a opção de controle de eventos, rateios, etc.* * Saúde * *Benefício específico para empresas que operacionalizam serviços na área de saúde ou controlam marcação de consultas em rede credenciada (clínica ou médico).* ### Adesão (Cliente com Contrato) Nada mais é que a entidade conjunta de [Cliente](#associado) com seus respectivos [Benefícios](#beneficio). Chamamos dessa forma simplesmente por quê o cliente aderiu a algum benefício, então ele fez uma adesão. ### Plano (Produto) É o item que faz parte do benefício (contrato) do cliente (ou associado). Os planos (ou produtos) definem a cobertura ou vantagens que aquele benefício/cliente possuem, como uma cobertura contra incêndios, proteção residencial, plano de carro reserva, de assistência 24h com 200Km, clube de descontos, acesso a rede de clínicas médicas, etc. Cada benefício possui no mínimo um plano principal, o qual define algumas regras gerais no respectivo benefício. E de forma completar, pode-se ter planos adicionais que agregam mais serviços ou acessos para o contratante. Cada plano possui um valor e a soma desses vão ser justamente o valor da mensalidade. Esse valor também pode variar conforme existência de descontos/acréscimo, e pelo valor de rateio no caso de benefício do tipo "proteção veicular". ### Empresa É uma entidade que também é um cliente da pessoa jurídica contratante do sistema ([Cliente Siprov](#cliente-siprov)). Por exemplo, uma empresa no mercado que contrata um plano de saúde, vai ser cadastrada no sistema para nela ser listada seus beneficiários, que são os funcionários que usarão o benefício de plano de saúde. A empresa pagará uma mensalidade proporcional à quantidade de benefícios vendidos ou beneficiários atendidos. A saber, esses beneficiários são [associados](#associado) que ficam então, dentro da empresa. ### Documentação (Vistoria) É um processo que visa a coleta de dados e arquivos. Esse processo pode ter outros nomes conforme o cenário da empresa que o aplica. Em organizações de proteção veicular por exemplo, esse processo geralmente é chamado **Vistoria**. Essa entidade sempre se relaciona a alguma outra, como [benefício](#beneficio-contrato), [evento](#evento), dentre outros, para definir o que deverá ser recolhido de dados e arquivos, como dados de documentos, fotos, assinatura, etc. Por exemplo, ao acrescentar um novo benefício, o usuário poderá requerer que o cliente leia um contrato e o assine em seguida, além de confirmar alguns dados cadastrais e comerciais. Em alguns casos, pode querer que ele envie uma selfie. Outro exemplo: no cenário de um benefício do tipo "proteção veicular" é comum requisitar as fotos do veículo. ### Evento É o registro relacionado à intervenção feita em veículos ou outros equipamentos diretamente relacionados ao benefício. No negócio de proteção veicular, por exemplo, quando na ocorrência de um acidente ou na demanda da instalação de rastreador. ### Rede Credenciada Basicamente é o agrupamento das entidades Clínica, Médico ou Parceiro, que são prestadores de serviço. Clínicas e médicos são específicas para os benefícios de saúde. Já os parceiros são prestadores genéricos, nos quais podem constar os serviços ou descontos que oferecem.