{ "openapi" : "3.0.1", "info" : { "contact" : { "email" : "atendimento@rumotecnologia.com.br", "name" : "Rumo Tecnologia", "url" : "https://rumotecnologia.com.br" }, "description" : "API para integração ao sistema Siprov.\n\nPara testes, solicite usuário e senha à Rumo Tecnologia através do chat em nosso site ou por email.\n\nPara uso em produção, informe um email para o administrador da base criar seu usuário. A senha de acesso chegará no email informado.\nUse o método /ext/autenticacao para gerar o token a ser usado nos demais métodos da API.\n\nA qualquer momento você pode resetar a senha desse usuário no endereço do sistema Siprov em [https://acesso.siprov.com.br](https://acesso.siprov.com.br).\n\nEndpoint: https://acesso.siprov.com.br/siprov-api\n\nQualquer dúvida, nosso atendimento está disponível de segunda à sexta de 9h às 18h através dos seguintes canais.\n\nContato:\n\n ", "title" : "Siprov API", "version" : "1.81" }, "externalDocs" : { "description" : "Veja documentação detalhada em: https://doc.siprov.com.br", "url" : "https://doc.siprov.com.br" }, "servers" : [ { "url" : "https://acesso.siprov.com.br/siprov-api" } ], "tags" : [ { "name" : "Segurança" }, { "name" : "Empresa" }, { "name" : "Administração" }, { "name" : "Associado" }, { "name" : "Benefício" }, { "name" : "Vistoria/Documentação" }, { "name" : "Financeiro" }, { "name" : "Evento" }, { "name" : "Rede Credenciada" }, { "name" : "Saúde" }, { "name" : "CRM" }, { "name" : "Relatório" }, { "name" : "Integração Especial" } ], "paths" : { "/ext/administracao/campos/{codigo}" : { "get" : { "description" : "Retorna a lista de campos adicionais por tipo de benefício.\n\nCódigos válidos:\n0 — Veicular\n1 — Saúde\n2 — Diversos\n3 — Consórcio\n4 — Assistência 24H", "operationId" : "listarCampos", "parameters" : [ { "in" : "path", "name" : "codigo", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CampoAdicionalOutputTO" } } }, "description" : "Lista de campos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Campos Adicionais", "tags" : [ "Administração" ] } }, "/ext/administracao/loja" : { "get" : { "description" : "Lista as unidades (lojas) às quais o usuário tem acesso.", "operationId" : "listarLoja", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de unidades (lojas)" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Unidade (Loja)", "tags" : [ "Administração" ] } }, "/ext/administracao/vendedor" : { "get" : { "description" : "Retorna a lista de vendedores, que são consultores ou representantes ativos.", "operationId" : "listarParceiro", "parameters" : [ { "in" : "query", "name" : "tipo", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "bairro", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "uf", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaVendedorOutputTO" } } }, "description" : "Lista de vendedores" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Vendedores", "tags" : [ "Administração" ] } }, "/ext/associado" : { "get" : { "description" : "Retorna a lista de associados conforme parâmetros.\n\n *O associado poderá se repetir na lista em virtude de possuir mais de um benefício.* \n\n Necessário informar um dos seguintes parâmetros:\n\n- 'codPessoa'\n - 'nome'\n - 'cpf' ou 'cnpj'\n - 'dataCadastroInicial' e 'dataCadastroFinal'\n - 'dataNascimento'\n - 'situacaoBeneficio'\n- 'placa' ou 'chassi'", "operationId" : "pesquisarAssociado", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpf", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cnpjEmpresa", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codPessoa", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codLoja", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codConsultor", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codRepresentante", "schema" : { "type" : "integer", "format" : "int32" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataCadastroInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataCadastroFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataNascimento", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "in" : "query", "name" : "situacaoBeneficio", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "placa", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "chassi", "schema" : { "type" : "string", "maxLength" : 20, "minLength" : 0 } }, { "in" : "query", "name" : "codPlano", "schema" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 0 } }, { "in" : "query", "name" : "uf", "schema" : { "type" : "string" } }, { "description" : "Data referente a última atualização do associado ou benefício.", "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataAtualizacao", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "in" : "query", "name" : "pagina", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListaPesquisaAssociadoOutputTO" } } }, "description" : "Lista de benefícios" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Associado", "tags" : [ "Associado" ] }, "post" : { "description" : "Grava os dados básicos da pessoa, vinculando o cadastro pelo CPF/CNPJ.\n\n Atente-se para os seguintes campos, que tem opções fixas:\n\n- 'natureza':\n 'F' ou 'J'\n - 'sexo': 'Feminino' ou 'Masculino'\n- 'telefones' -> 'tipo': 'Fixo' ou 'Celular'\n", "operationId" : "gravarAssociado", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PessoaInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PessoaOutputTO" } } }, "description" : "Cadastro gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Associado", "tags" : [ "Associado" ] } }, "/ext/associado/{codPessoa}/cartaoCredito" : { "get" : { "description" : "Lista os cartões de crédito vinculados ao associado.", "operationId" : "listarCartaoCredito", "parameters" : [ { "in" : "path", "name" : "codPessoa", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartaoCreditoTO" } } }, "description" : "Lista de cartões" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar cartões de crédito", "tags" : [ "Associado" ] } }, "/ext/autenticacao" : { "post" : { "description" : "Valida usuário e senha pelo método Basic. Retorna os dados de acesso. O token gerado tem validade de 12 horas.", "operationId" : "autenticar", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AcessoOutputTO" } } }, "description" : "Dados do acesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "basic" : [ ] } ], "summary" : "Autenticar", "tags" : [ "Segurança" ] } }, "/ext/beneficio" : { "get" : { "description" : "Retorna a lista de benefícios conforme parâmetros.\n\nNecessário informar um parâmetro de benefício ('placa', 'chassi', 'sequencial' ou 'numeroCartaoDesconto').", "operationId" : "pesquisarBeneficio", "parameters" : [ { "in" : "query", "name" : "cpf", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "placa", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "chassi", "schema" : { "type" : "string", "maxLength" : 20, "minLength" : 0 } }, { "in" : "query", "name" : "sequencial", "schema" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 0 } }, { "in" : "query", "name" : "numeroCartaoDesconto", "schema" : { "type" : "string", "pattern" : "^\\d{4} ?\\d{2} ?\\d ?\\d{3} ?\\d{3}$" } }, { "in" : "query", "name" : "situacaoBeneficio", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codPlano", "schema" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 0 } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaBeneficioOutputTO" } } }, "description" : "Lista de benefícios" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Benefício", "tags" : [ "Benefício" ] }, "post" : { "description" : "Grava o benefício, vinculando-o ao CPF/CNPJ indicado.\n O 'codPlano' deve ser obtido na lista de negociação.\n Envie a situação pelo nome ou simplesmente ativo como verdadeiro ou falso.", "operationId" : "gravarBeneficioBasico", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioOutputTO" } } }, "description" : "Benefício gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Benefício Básico", "tags" : [ "Benefício" ] } }, "/ext/beneficio/dependente" : { "get" : { "description" : "Retorna a lista de dependentes conforme parâmetros.\n\nNecessário informar um dos seguintes parâmetros:\n\n- 'nome'\n - 'cpf'\n - 'numeroCartaoDesconto'", "operationId" : "pesquisarDependente", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpf", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "numeroCartaoDesconto", "schema" : { "type" : "string", "pattern" : "^\\d{4} ?\\d{2} ?\\d ?\\d{3} ?\\d{3}$" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaDependenteOutputTO" } } }, "description" : "Lista de dependentes" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Dependente", "tags" : [ "Benefício" ] }, "post" : { "description" : "Grava o dependente, vinculando-o ao benefício indicado.\n\n Atente-se para os seguintes campos, que tem opções fixas: \n\n * 'parentesco': CONJUGE | PAI | FILHO | IRMAO | AVO | TIO | SOBRINHO | PRIMO | NETO | SOGRO | OUTRO | PET_CANINO | PET_FELINO | PET_OUTROS | CUNHADO | GENRO | ENTEADO | PADRASTO \n\n- 'sexo':\n 'Feminino' ou 'Masculino'", "operationId" : "gravarDependente", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DependenteInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DependenteBasicoOutputTO" } } }, "description" : "Dependente gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Dependente", "tags" : [ "Benefício" ] } }, "/ext/beneficio/situacaoBeneficio" : { "get" : { "description" : "Lista as situações de benefício com respectivos tipos. As situações são cadastradas pelo usuário, enquanto o tipo é fixo no sistema.", "operationId" : "listarSituacaoBeneficio", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SituacaoBeneficioTO" } } }, "description" : "Lista de situações de benefício" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "summary" : "Listar Situações de Benefício", "tags" : [ "Benefício" ] } }, "/ext/beneficio/tipoVeiculo" : { "get" : { "description" : "Lista os tipos de veículo que podem ser atribuídos ao benefício veicular.\n\n O item abaixo é fixo conforme a respectiva lista: \n\n- 'categoria': Bicicleta | Caminhao | Leve | Motocicleta | Pickup | Utilitario | Onibus | Outro", "operationId" : "listarTipoVeiculo", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TipoVeiculoBean" } } }, "description" : "Lista de tipos de veículo" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "summary" : "Listar Tipos de Veículo", "tags" : [ "Benefício" ] } }, "/ext/beneficio/validacao" : { "post" : { "description" : "Pesquisa um benefício por CPF/CNPJ do beneficiário ou número do cartão de benefício informado no campo matrícula ou pelo sequencial. Retorna o status do benefício e dados básicos do beneficiário.", "operationId" : "validarBeneficio", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ValidacaoBeneficioInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ValidacaoBeneficioOutputTO" } } }, "description" : "Dados do benefício" }, "400" : { "content" : { "text/plain" : { } }, "description" : "Benefício não localizado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "summary" : "Validar Benefício", "tags" : [ "Benefício" ] } }, "/ext/beneficio/veicular" : { "post" : { "description" : "Grava o benefício, vinculando-o ao CPF/CNPJ indicado.\n Envie a situação pelo nome ou simplesmente ativo como verdadeiro ou falso.\nAtente-se para os seguintes campos, que tem opções fixas: \n * 'categoria': BICICLETA | CAMINHAO | LEVE | MOTOCICLETA | PICKUP | UTILITARIO | ONIBUS | OUTRO \n - 'combustivel': GASOLINA | ETANOL | FLEX | DIESEL | GNV | ELETRICO | OUTRO", "operationId" : "gravarBeneficioVeicular", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioVeiculoInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioOutputTO" } } }, "description" : "Benefício gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Benefício Veicular", "tags" : [ "Benefício" ] } }, "/ext/beneficio/vencimento" : { "get" : { "description" : "Lista os dias de vencimento que podem ser atribuídos ao benefício.", "operationId" : "listarDiaVencimento", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListaDiaVencimentoTO" } } }, "description" : "Lista de dias" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "summary" : "Listar Dias de Vencimento", "tags" : [ "Benefício" ] } }, "/ext/beneficio/{codBeneficio}/cancelar" : { "put" : { "description" : "Cancela o benefício indicado pelo seu respectivo código.", "operationId" : "cancelarBeneficio", "parameters" : [ { "in" : "path", "name" : "codBeneficio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { } }, "description" : "Benefício cancelado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Cancelar Benefício", "tags" : [ "Benefício" ] } }, "/ext/beneficio/{codBeneficio}/dadosAdicionais" : { "put" : { "description" : "Grava dados adicionais do benefício.", "operationId" : "gravarDadosAdicionais", "parameters" : [ { "in" : "path", "name" : "codBeneficio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CampoAdicionalInputTO" } } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { } }, "description" : "Dados gravados" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Dados Adicionais", "tags" : [ "Benefício" ] } }, "/ext/beneficio/{codBeneficio}/dependentes" : { "get" : { "description" : "Lista os dependentes do benefício indicado.", "operationId" : "listarDependentes", "parameters" : [ { "in" : "path", "name" : "codBeneficio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DependenteCompletoOutputTO" } } }, "description" : "Lista de dependentes" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Dependentes", "tags" : [ "Benefício" ] } }, "/ext/beneficio/{codBeneficio}/equipamentos" : { "get" : { "description" : "Lista os equipamentos instalados no benefício de veículo.", "operationId" : "listarEquipamentos", "parameters" : [ { "in" : "path", "name" : "codBeneficio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RastreadorInstalacaoTO" } } }, "description" : "Lista de itens" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Equipamentos Instalados", "tags" : [ "Benefício" ] } }, "/ext/beneficio/{codBeneficio}/itens" : { "get" : { "description" : "Lista os itens do benefício indicado.", "operationId" : "listarItens", "parameters" : [ { "in" : "path", "name" : "codBeneficio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemBeneficioOutputTO" } } }, "description" : "Lista de itens" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Itens", "tags" : [ "Benefício" ] } }, "/ext/crm/lead" : { "get" : { "description" : "Retorna a lista de leads ativos.", "operationId" : "listarLeads", "parameters" : [ { "description" : "Aceita informar nome, CPF, CNPJ, telefone ou email.", "in" : "query", "name" : "filtro", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LeadOutputTO" } } }, "description" : "Lista de leads" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Lista Leads", "tags" : [ "CRM" ] }, "post" : { "description" : "Grava um lead com dados básicos do contato.", "operationId" : "gravarLead", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LeadInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PessoaOutputTO" } } }, "description" : "Cadastro gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Lead", "tags" : [ "CRM" ] } }, "/ext/crm/negocio" : { "get" : { "description" : "Retorna a lista de negócios abertos.", "operationId" : "listarNegocios", "parameters" : [ { "in" : "query", "name" : "codLead", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "filtro", "schema" : { "type" : "string", "description" : "nome/cpf/cnpj/telefone/email/sequencial" } }, { "in" : "query", "name" : "dataInicial", "schema" : { "type" : "string", "maxLength" : 10, "minLength" : 0, "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" } }, { "in" : "query", "name" : "dataFinal", "schema" : { "type" : "string", "maxLength" : 10, "minLength" : 0, "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" } }, { "in" : "query", "name" : "codLoja", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codUsuarioResponsavel", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaNegocioOutputTO" } } }, "description" : "Lista de negócios" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Lista Negócios", "tags" : [ "CRM" ] }, "post" : { "description" : "Cria um novo negócio com dados básicos.", "operationId" : "gravarNegocio", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioOutputTO" } } }, "description" : "Negócio criado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Criar Negócio", "tags" : [ "CRM" ] } }, "/ext/crm/negocio/{codNegocio}" : { "get" : { "description" : "Recupera os dados básicos de um negócio.", "operationId" : "recuperarNegocio", "parameters" : [ { "in" : "path", "name" : "codNegocio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioTO" } } }, "description" : "Negócio recuperado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Negócio", "tags" : [ "CRM" ] }, "put" : { "description" : "Altera os dados básicos de um negócio.", "operationId" : "alterarNegocio", "parameters" : [ { "in" : "path", "name" : "codNegocio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioOutputTO" } } }, "description" : "Negócio alterado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Alterar Negócio", "tags" : [ "CRM" ] } }, "/ext/crm/negocio/{codNegocio}/dependente" : { "post" : { "description" : "Cria um dependente de benefício de saúde.", "operationId" : "criarDependente", "parameters" : [ { "in" : "path", "name" : "codNegocio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioDependenteTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioDependenteTO" } } }, "description" : "Dependente criado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Criar Dependente", "tags" : [ "CRM" ] } }, "/ext/crm/negocio/{codNegocio}/dependente/{codDependente}" : { "put" : { "description" : "Altera um dependente de benefício de saúde.", "operationId" : "alterarDependente", "parameters" : [ { "in" : "path", "name" : "codNegocio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "path", "name" : "codDependente", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioDependenteTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegocioDependenteTO" } } }, "description" : "Dependente alterado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Alterar Dependente", "tags" : [ "CRM" ] } }, "/ext/evento" : { "get" : { "description" : "Retorna a lista de eventos conforme parâmetros.\n\n", "operationId" : "pesquisarEvento", "parameters" : [ { "in" : "query", "name" : "envolvido", "schema" : { "type" : "string", "enum" : [ "Cliente", "Terceiro" ] } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataAberturaInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataAberturaFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEventoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEventoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "in" : "query", "name" : "protocolo", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codPessoa", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codRepresentante", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codConsultor", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaEventoOutputTO" } } }, "description" : "Lista de eventos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Evento", "tags" : [ "Evento" ] } }, "/ext/evento/orcamento" : { "post" : { "description" : "Adiciona ou edita um orçamento num evento.", "operationId" : "gravarOrcamento", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventoOrcamentoInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventoOrcamentoOutputTO" } } }, "description" : "Orçamento gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Orçamento", "tags" : [ "Evento" ] } }, "/ext/evento/situacaoEvento" : { "get" : { "description" : "Retorna a lista de situações de evento.", "operationId" : "listarSituacaoEvento", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de situações" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Situações de Evento", "tags" : [ "Evento" ] } }, "/ext/evento/tecnico" : { "get" : { "description" : "Retorna a lista de técnicos ativos.", "operationId" : "listarTecnicos", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "bairro", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "uf", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaTecnicoOutputTO" } } }, "description" : "Lista de técnicos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Lista Técnicos", "tags" : [ "Evento" ] }, "post" : { "description" : "Grava um técnico com dados básicos.", "operationId" : "gravarTecnico", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PessoaInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PessoaOutputTO" } } }, "description" : "Cadastro gravado com sucesso" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Técnico", "tags" : [ "Evento" ] } }, "/ext/evento/tipoEvento" : { "get" : { "description" : "Retorna a lista de tipos de evento, que são necessários para identificar corretamente o evento.", "operationId" : "listarTipoEvento", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TipoEventoBean" } } }, "description" : "Lista de tipos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Tipos de Evento", "tags" : [ "Evento" ] } }, "/ext/evento/{codEvento}" : { "get" : { "description" : "Retorna os dados do evento indicado.", "operationId" : "recuperarEvento", "parameters" : [ { "in" : "path", "name" : "codEvento", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventoOutputTO" } } }, "description" : "Dados do evento" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Evento", "tags" : [ "Evento" ] } }, "/ext/evento/{codEvento}/orcamentos" : { "get" : { "description" : "Retorna a lista de orçamentos de um determinando evento.", "operationId" : "listarOrcamentos", "parameters" : [ { "in" : "path", "name" : "codEvento", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventoOrcamentoOutputTO" } } }, "description" : "Lista de orçamentos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Orçamentos", "tags" : [ "Evento" ] } }, "/ext/financeiro/cartaoCredito" : { "post" : { "description" : "Cadastra um cartão de crédito para a pessoa.", "operationId" : "cadastrarCartaoCredito", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CadastroCartaoInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CadastroCartaoOutputTO" } } }, "description" : "Identificação do cartão" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Cadastrar Cartão de Crédito", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/formaPagamento" : { "get" : { "description" : "Retorna a lista de formas de pagamento disponíveis.", "operationId" : "listarFormaPagamento", "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FormaPagamentoTO" } } }, "description" : "Forma de Pagamento" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Formas de Pagamento", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/tipoLiquidacao" : { "get" : { "description" : "Retorna a lista de tipos de liquidação, necessários para a liquidação de título.", "operationId" : "listarTipoLiquidacao", "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TipoLiquidacaoBean" } } }, "description" : "Lista de tipos" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Tipos de Liquidação", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/tipoTitulo" : { "get" : { "description" : "Retorna a lista de tipos de título, necessários para a criação de título.", "operationId" : "listarTipoTitulo", "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TipoTituloBean" } } }, "description" : "Lista de tipos" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Tipos de Título", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo" : { "get" : { "description" : "Retorna a lista de títulos conforme parâmetros.", "operationId" : "pesquisarTitulo", "parameters" : [ { "in" : "query", "name" : "tipo", "required" : true, "schema" : { "type" : "string", "enum" : [ "Débito", "Crédito", "Rateio" ] } }, { "in" : "query", "name" : "codLoja", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codConsultor", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codRepresentante", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEmissaoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEmissaoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataVencimentoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataVencimentoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataLiquidacaoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataLiquidacaoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "description" : "Repetir o parâmetro para selecionar mais de uma situação.", "in" : "query", "name" : "situacao", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Aberto", "Pendente", "Liquidado", "Cancelado", "Protestado", "Rejeitado", "Agrupado", "Negociado" ] } } }, { "in" : "query", "name" : "situacaoBeneficio", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "placa", "schema" : { "type" : "string" } }, { "description" : "Índice do registro inicial, começando em zero.", "in" : "query", "name" : "inicio", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListaTituloOutputTO" } } }, "description" : "Lista de títulos" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Títulos", "tags" : [ "Financeiro" ] }, "post" : { "description" : "Cria um título de crédito.", "operationId" : "criarTitulo", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CriacaoTituloInputTO" } } } }, "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CriacaoTituloOutputTO" } } }, "description" : "Identificação do título" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Criar Título", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/boleto" : { "get" : { "description" : "Retorna a lista de boletos ativos conforme parâmetros.", "operationId" : "pesquisarBoleto", "parameters" : [ { "in" : "query", "name" : "codLoja", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEmissaoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataEmissaoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataVencimentoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataVencimentoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataLiquidacaoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataLiquidacaoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "description" : "Repetir o parâmetro para selecionar mais de uma situação.", "in" : "query", "name" : "situacao", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Aberto", "Pendente", "Liquidado", "Cancelado", "Protestado", "Rejeitado", "Agrupado", "Negociado" ] } } }, { "in" : "query", "name" : "situacaoBeneficio", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "placa", "schema" : { "type" : "string" } }, { "description" : "Índice do registro inicial, começando em zero.", "in" : "query", "name" : "inicio", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListaBoletoOutputTO" } } }, "description" : "Lista de boletos" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Boletos", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/liquidar" : { "post" : { "description" : "Efetua a liquidação de um título com o valor informado.", "operationId" : "liquidarTitulo", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CobrancaTituloInputTO" } } } }, "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CobrancaTituloInputTO" } } }, "description" : "Código da liquidação." } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Liquidar Título", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/pagar" : { "post" : { "description" : "Efetua o pagamento de um título com cartão de crédito pré-cadastrado.", "operationId" : "pagarTituloComCartao", "parameters" : [ { "in" : "query", "name" : "codTitulo", "required" : true, "schema" : { "type" : "integer", "format" : "int64", "minimum" : 1 } }, { "in" : "query", "name" : "codCartaoCredito", "required" : true, "schema" : { "type" : "integer", "format" : "int32", "minimum" : 1 } }, { "in" : "query", "name" : "codFormaPagamento", "schema" : { "type" : "integer", "format" : "int32", "minimum" : 1 } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CobrancaCartaoOutputTO" } } }, "description" : "NSU e código de autorização da transação." } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pagar Título", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/{codTitulo}" : { "get" : { "description" : "Retorna os dados detalhados do título.", "operationId" : "recuperarTitulo", "parameters" : [ { "in" : "path", "name" : "codTitulo", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TituloOutputTO" } } }, "description" : "Título" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Título", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/{codTitulo}/boleto" : { "get" : { "description" : "Retorna a Linha Digitável e a URL do PDF do boleto mais recente do título.", "operationId" : "recuperarBoleto", "parameters" : [ { "in" : "path", "name" : "codTitulo", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BoletoOutputTO" } } }, "description" : "Boleto do Título" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Boleto", "tags" : [ "Financeiro" ] }, "post" : { "description" : "Emite um novo boleto para o título. Caso a carteira seja online, os dados do boleto não serão retornados imediatamente, podendo ser recuperados depois.", "operationId" : "emitirBoleto", "parameters" : [ { "in" : "path", "name" : "codTitulo", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BoletoOutputTO" } } }, "description" : "Boleto do Título" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Emitir Boleto", "tags" : [ "Financeiro" ] } }, "/ext/financeiro/titulo/{codTitulo}/pix" : { "post" : { "description" : "Emite um novo Pix para o título. Caso o título já tenha um Pix ativo, este será retornado.", "operationId" : "emitirPix", "parameters" : [ { "in" : "path", "name" : "codTitulo", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" }, "default" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PixOutputTO" } } }, "description" : "Pix do Título" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Emitir Pix", "tags" : [ "Financeiro" ] } }, "/ext/integracao/araujo/empresas/{matricula}" : { "get" : { "description" : "Retorna os dados do benefício para integração com a Drogaria Araújo.", "operationId" : "recuperarBeneficioAraujo", "parameters" : [ { "description" : "Enviar o CPF ou o número do cartão de benefícios.", "in" : "path", "name" : "matricula", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioAraujoTO" } } }, "description" : "Dados do benefício" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Benefício (Araújo)", "tags" : [ "Integração Especial" ] } }, "/ext/integracao/univers" : { "get" : { "description" : "Retorna a lista de benefícios para integração com a Univers.", "operationId" : "listarBeneficiosUnivers", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BeneficioUniversTO" } } }, "description" : "Lista de benefícios" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Benefícios (Univers)", "tags" : [ "Integração Especial" ] } }, "/ext/negociacao" : { "get" : { "description" : "Retorna a lista dos planos contratados pela empresa. \n\n O campo 'tipoBeneficio' retorna algum dos seguintes itens: \n - Assinatura\n - Assistência 24h\n - Consórcio\n - Diversos\n - Proteção Veicular\n- Saúde", "operationId" : "listarNegociacao", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NegociacaoOutputTO" } } }, "description" : "Lista de negociações" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Negociações", "tags" : [ "Empresa" ] } }, "/ext/rede/clinica" : { "get" : { "description" : "Retorna a lista de clínicas encontradas.", "operationId" : "listarClinica", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string", "description" : "Nome da clínica ou do médico" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codRegiao", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codEspecialidade", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codExame", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codMedico", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "bairro", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaClinicaOutputTO" } } }, "description" : "Lista de clínicas" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Clínicas", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/clinica/{id}" : { "get" : { "description" : "Recupera os dados completos da clínica pelo ID.", "operationId" : "recuperarClinica", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClinicaOutputTO" } } }, "description" : "Dados da clínica" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Clínica", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/especialidade" : { "get" : { "description" : "Retorna a lista de especialidades médicas disponíveis.", "operationId" : "listarEspecialidade", "parameters" : [ { "description" : "Nome da especialidade", "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "description" : "Códigos de região separados por vírgula.", "in" : "query", "name" : "codRegiao", "schema" : { "type" : "string", "pattern" : "^\\d+(,\\d+)*$" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de especialidades" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Especialidades", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/exame" : { "get" : { "description" : "Retorna a lista de exames médicos disponíveis.", "operationId" : "listarExame", "parameters" : [ { "description" : "Nome do exame", "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "description" : "Códigos de região separados por vírgula.", "in" : "query", "name" : "codRegiao", "schema" : { "type" : "string", "pattern" : "^\\d+(,\\d+)*$" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExameTO" } } }, "description" : "Lista de exames" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Exames", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/medico" : { "get" : { "description" : "Retorna a lista de médicos encontrados.", "operationId" : "listarMedico", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codRegiao", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codEspecialidade", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "bairro", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaMedicoOutputTO" } } }, "description" : "Lista de médicos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Médicos", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/medico/{id}" : { "get" : { "description" : "Recupera os dados completos do médico pelo ID.", "operationId" : "recuperarMedico", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MedicoOutputTO" } } }, "description" : "Dados do médico" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Médico", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/parceiro" : { "get" : { "description" : "Retorna a lista de parceiros.", "operationId" : "listarParceiro_1", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cpfCnpj", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codTipoParceiro", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codServico", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codRegiao", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "bairro", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "uf", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PesquisaParceiroOutputTO" } } }, "description" : "Lista de parceiros" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Parceiros", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/parceiro/servico" : { "get" : { "description" : "Retorna a lista serviços de parceiro.", "operationId" : "listarServicoParceiro", "parameters" : [ { "in" : "query", "name" : "nome", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "cidade", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "uf", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "codRegiao", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de serviços de parceiro" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Serviços de Parceiro", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/parceiro/tipo" : { "get" : { "description" : "Retorna a lista tipos de parceiro.", "operationId" : "listarTipoParceiro", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de tipos de parceiro" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Tipos de Parceiro", "tags" : [ "Rede Credenciada" ] } }, "/ext/rede/regiao" : { "get" : { "description" : "Retorna a lista de regiões de atendimento disponíveis.", "operationId" : "listarRegiao", "parameters" : [ { "description" : "Códigos de especialidade separados por vírgula.", "in" : "query", "name" : "codEspecialidade", "schema" : { "type" : "string", "pattern" : "^\\d+(,\\d+)*$" } }, { "in" : "query", "name" : "comClinica", "schema" : { "type" : "boolean" } }, { "in" : "query", "name" : "comMedico", "schema" : { "type" : "boolean" } }, { "in" : "query", "name" : "comParceiro", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "Lista de regiões" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Regiões de Atendimento", "tags" : [ "Rede Credenciada" ] } }, "/ext/relatorio/adesao" : { "get" : { "description" : "Lista todos os relatórios de adesão disponíveis ao usuário.", "operationId" : "listarAdesao", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Relatórios de Adesão", "tags" : [ "Relatório" ] }, "options" : { "description" : "Retorna os parâmetros disponíveis para a geração do relatório de adesão.", "operationId" : "recuperarParametrosAdesao", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonAdesaoParamTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Parâmetros de Adesão", "tags" : [ "Relatório" ] }, "post" : { "description" : "Solicita a geração de um relatório de adesão conforme leiaute e filtros especificados.", "operationId" : "gerarAdesao", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonAdesaoInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gerar Relatório de Adesão", "tags" : [ "Relatório" ] } }, "/ext/relatorio/adesao/{codRelatorio}" : { "get" : { "description" : "Faz o download do relatório gerado.", "operationId" : "baixarAdesao", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Arquivo do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Baixar Relatório de Adesão", "tags" : [ "Relatório" ] }, "options" : { "description" : "Recupera os metadados do relatório. Use para ver o status da geração.", "operationId" : "recuperarAdesao", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "204" : { "content" : { "text/plain" : { } }, "description" : "Não encontrado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Relatório de Adesão", "tags" : [ "Relatório" ] } }, "/ext/relatorio/consulta" : { "get" : { "description" : "Lista todos os relatórios de Consulta disponíveis ao usuário.", "operationId" : "listarConsulta", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Relatórios de Consulta Médica", "tags" : [ "Relatório" ] }, "options" : { "description" : "Retorna os parâmetros disponíveis para a geração do relatório de Consulta.", "operationId" : "recuperarParametrosConsulta", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonConsultaParamTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Parâmetros de Consulta Médica", "tags" : [ "Relatório" ] }, "post" : { "description" : "Solicita a geração de um relatório de Consulta conforme leiaute e filtros especificados.", "operationId" : "gerarConsulta", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonConsultaInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gerar Relatório de Consulta Médica", "tags" : [ "Relatório" ] } }, "/ext/relatorio/consulta/{codRelatorio}" : { "get" : { "description" : "Faz o download do relatório gerado.", "operationId" : "baixarConsulta", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Arquivo do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Baixar Relatório de Consulta Médica", "tags" : [ "Relatório" ] }, "options" : { "description" : "Recupera os metadados do relatório. Use para ver o status da geração.", "operationId" : "recuperarConsulta", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "204" : { "content" : { "text/plain" : { } }, "description" : "Não encontrado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Relatório de Consulta Médica", "tags" : [ "Relatório" ] } }, "/ext/relatorio/evento" : { "get" : { "description" : "Lista todos os relatórios de evento disponíveis ao usuário.", "operationId" : "listarEvento", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Relatórios de Evento", "tags" : [ "Relatório" ] }, "options" : { "description" : "Retorna os parâmetros disponíveis para a geração do relatório de evento.", "operationId" : "recuperarParametrosEvento", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonEventoParamTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Parâmetros de Evento", "tags" : [ "Relatório" ] }, "post" : { "description" : "Solicita a geração de um relatório de evento conforme leiaute e filtros especificados.", "operationId" : "gerarEvento", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonEventoInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gerar Relatório de Evento", "tags" : [ "Relatório" ] } }, "/ext/relatorio/evento/{codRelatorio}" : { "get" : { "description" : "Faz o download do relatório gerado.", "operationId" : "baixarEvento", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Arquivo do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Baixar Relatório de Evento", "tags" : [ "Relatório" ] }, "options" : { "description" : "Recupera os metadados do relatório. Use para ver o status da geração.", "operationId" : "recuperarEvento_1", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "204" : { "content" : { "text/plain" : { } }, "description" : "Não encontrado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Relatório de Evento", "tags" : [ "Relatório" ] } }, "/ext/relatorio/financeiro" : { "get" : { "description" : "Lista todos os relatórios de financeiro disponíveis ao usuário.", "operationId" : "listarFinanceiro", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Relatórios de Financeiro", "tags" : [ "Relatório" ] }, "options" : { "description" : "Retorna os parâmetros disponíveis para a geração do relatório de financeiro.", "operationId" : "recuperarParametrosFinanceiro", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonFinanceiroParamTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Parâmetros de Financeiro", "tags" : [ "Relatório" ] }, "post" : { "description" : "Solicita a geração de um relatório de financeiro conforme leiaute e filtros especificados.", "operationId" : "gerarFinanceiro", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonFinanceiroInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gerar Relatório de Financeiro", "tags" : [ "Relatório" ] } }, "/ext/relatorio/financeiro/{codRelatorio}" : { "get" : { "description" : "Faz o download do relatório gerado.", "operationId" : "baixarFinanceiro", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Arquivo do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Baixar Relatório de Financeiro", "tags" : [ "Relatório" ] }, "options" : { "description" : "Recupera os metadados do relatório. Use para ver o status da geração.", "operationId" : "recuperarFinanceiro", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "204" : { "content" : { "text/plain" : { } }, "description" : "Não encontrado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Relatório de Financeiro", "tags" : [ "Relatório" ] } }, "/ext/relatorio/helpDesk" : { "get" : { "description" : "Lista todos os relatórios de HelpDesk disponíveis ao usuário.", "operationId" : "listarHelpDesk", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Relatórios de HelpDesk", "tags" : [ "Relatório" ] }, "options" : { "description" : "Retorna os parâmetros disponíveis para a geração do relatório de HelpDesk.", "operationId" : "recuperarParametrosHelpDesk", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonHelpDeskParamTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Parâmetros de HelpDesk", "tags" : [ "Relatório" ] }, "post" : { "description" : "Solicita a geração de um relatório de HelpDesk conforme leiaute e filtros especificados.", "operationId" : "gerarHelpDesk", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonHelpDeskInputTO" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Parâmetros do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gerar Relatório de HelpDesk", "tags" : [ "Relatório" ] } }, "/ext/relatorio/helpDesk/{codRelatorio}" : { "get" : { "description" : "Faz o download do relatório gerado.", "operationId" : "baixarHelpDesk", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "Arquivo do relatório" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Baixar Relatório de HelpDesk", "tags" : [ "Relatório" ] }, "options" : { "description" : "Recupera os metadados do relatório. Use para ver o status da geração.", "operationId" : "recuperarHelpDesk", "parameters" : [ { "in" : "path", "name" : "codRelatorio", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RelPersonTO" } } }, "description" : "Dados do relatório" }, "204" : { "content" : { "text/plain" : { } }, "description" : "Não encontrado" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Relatório de HelpDesk", "tags" : [ "Relatório" ] } }, "/ext/saude/marcacao" : { "post" : { "description" : "Abre uma nova marcação de consulta com a situação inicial.", "operationId" : "abrirConsulta", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsultaInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsultaOutputTO" } } }, "description" : "Dados da marcação de consulta" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Abrir Marcação de Consulta", "tags" : [ "Saúde" ] } }, "/ext/saude/marcacao/{codConsulta}" : { "get" : { "description" : "Recupera os dados de determina marcação de consulta.", "operationId" : "recuperarConsulta_1", "parameters" : [ { "in" : "path", "name" : "codConsulta", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsultaOutputTO" } } }, "description" : "Dados da marcação de consulta" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Marcação de Consulta", "tags" : [ "Saúde" ] } }, "/ext/vistoria" : { "get" : { "description" : "Retorna a lista de vistorias conforme parâmetros.\n\n", "operationId" : "pesquisarVistoria", "parameters" : [ { "in" : "query", "name" : "codPessoa", "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "query", "name" : "codBeneficio", "schema" : { "type" : "integer", "format" : "int32" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataSolicitacaoInicial", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "example" : "dd/MM/yyyy", "in" : "query", "name" : "dataSolicitacaoFinal", "schema" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, { "in" : "query", "name" : "codTipoVistoria", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VistoriaOutputTO" } } }, "description" : "Lista de vistorias" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Pesquisar Vistoria", "tags" : [ "Vistoria/Documentação" ] }, "post" : { "description" : "Cria uma nova vistoria/documentação.", "operationId" : "criarVistoria", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CriacaoVistoriaInputTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VistoriaOutputTO" } } }, "description" : "Vistoria criada" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Criar Vistoria", "tags" : [ "Vistoria/Documentação" ] } }, "/ext/vistoria/tipos" : { "get" : { "description" : "Retorna a lista de tipos de vistoria/documentação.", "operationId" : "listarTiposIniciais", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TipoVistoriaInicialTO" } } }, "description" : "Lista de tipos" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Listar Tipos de Vistoria", "tags" : [ "Vistoria/Documentação" ] } }, "/ext/vistoria/{codVistoria}" : { "get" : { "description" : "Recupera uma vistoria/documentação.", "operationId" : "recuperarVistoria", "parameters" : [ { "in" : "path", "name" : "codVistoria", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VistoriaOutputTO" } } }, "description" : "Vistoria recuperada" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Recuperar Vistoria", "tags" : [ "Vistoria/Documentação" ] } }, "/ext/vistoria/{codVistoria}/anexo" : { "put" : { "description" : "Grava um anexo de vistoria/documentação. Caso exista um anexo com o mesmo nome, ele será sobrescrito.
Enviar requisição 'multipart/form-data' com os campos:", "operationId" : "gravarAnexo", "parameters" : [ { "in" : "path", "name" : "codVistoria", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "ID do documento" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Anexo", "tags" : [ "Vistoria/Documentação" ] } }, "/ext/vistoria/{codVistoria}/documento/{tipo}" : { "put" : { "description" : "Grava um documento de vistoria/documentação. Os documentos permitidos são: assinatura, selfie e contrato.
Enviar requisição 'multipart/form-data' com os campos:", "operationId" : "gravarDocumento", "parameters" : [ { "in" : "path", "name" : "codVistoria", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "path", "name" : "tipo", "required" : true, "schema" : { "type" : "string", "enum" : [ "assinatura", "selfie", "contrato" ] } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "ID do documento" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Documento", "tags" : [ "Vistoria/Documentação" ] } }, "/ext/vistoria/{codVistoria}/foto/{codTipo}" : { "put" : { "description" : "Grava uma foto de vistoria/documentação.
Enviar requisição 'multipart/form-data' com os campos:", "operationId" : "gravarFoto", "parameters" : [ { "in" : "path", "name" : "codVistoria", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "in" : "path", "name" : "codTipo", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CodigoNomeTO" } } }, "description" : "ID da foto" }, "401" : { "content" : { "text/plain" : { } }, "description" : "Não autorizado" } }, "security" : [ { "bearer" : [ ] } ], "summary" : "Gravar Foto", "tags" : [ "Vistoria/Documentação" ] } } }, "components" : { "schemas" : { "AcessoOutputTO" : { "type" : "object", "properties" : { "authorizationToken" : { "type" : "string" }, "authorizationType" : { "type" : "string" }, "codClienteSiprov" : { "type" : "integer", "format" : "int32" }, "codUsuario" : { "type" : "integer", "format" : "int32" }, "nomeClienteSiprov" : { "type" : "string" }, "nomeUsuario" : { "type" : "string" }, "permissaoLoja" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LojaOutputTO" } }, "plano" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlanoOutputTO" } } } }, "BeneficioAjusteInputTO" : { "type" : "object", "description" : "Envie ajustes de valor para definir descontos ou acréscimos ao valor da mensalidade do benefício.", "properties" : { "descricao" : { "type" : "string", "maxLength" : 45, "minLength" : 0 }, "regra" : { "type" : "string", "enum" : [ "Desconto", "Acréscimo" ] }, "tipo" : { "type" : "string", "enum" : [ "$", "%" ] }, "validade" : { "type" : "string", "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" }, "valor" : { "type" : "number" } } }, "BeneficioAraujoCartaoTO" : { "type" : "object", "properties" : { "nome" : { "type" : "string" }, "numero" : { "type" : "string" }, "tipo" : { "type" : "string" } } }, "BeneficioAraujoTO" : { "type" : "object", "properties" : { "existente" : { "type" : "boolean" }, "mensagem" : { "type" : "string" }, "vida" : { "$ref" : "#/components/schemas/BeneficioAraujoVidaTO" } } }, "BeneficioAraujoVidaTO" : { "type" : "object", "properties" : { "cartao" : { "$ref" : "#/components/schemas/BeneficioAraujoCartaoTO" }, "codigoPlano" : { "type" : "integer", "format" : "int32" }, "cpf" : { "type" : "string" }, "dependentes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BeneficioAraujoVidaTO" } }, "grupoCronicoDependente" : { "type" : "string" }, "limiteFinanciamento" : { "type" : "integer", "format" : "int32" }, "matricula" : { "type" : "string" }, "nome" : { "type" : "string" }, "saldoFinanciamento" : { "type" : "integer", "format" : "int32" }, "sexo" : { "type" : "string" }, "tipo" : { "type" : "string" } } }, "BeneficioInputTO" : { "type" : "object", "properties" : { "ajustes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BeneficioAjusteInputTO" } }, "ativo" : { "type" : "boolean" }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codCartaoCredito" : { "type" : "integer", "format" : "int32" }, "codConsultor" : { "type" : "integer", "format" : "int32" }, "codFormaPagamento" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "integer", "format" : "int32" }, "codPlano" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codRepresentante" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "diaVencimento" : { "type" : "integer", "format" : "int32", "maximum" : 30, "minimum" : 1 }, "numeroCartaoDesconto" : { "type" : "string" }, "situacao" : { "type" : "string" } }, "required" : [ "codPlano" ] }, "BeneficioOutputTO" : { "type" : "object", "properties" : { "codBeneficio" : { "type" : "integer", "format" : "int32" }, "numeroCartaoDesconto" : { "type" : "string" }, "sequencial" : { "type" : "integer", "format" : "int32" } } }, "BeneficioUniversTO" : { "type" : "object", "properties" : { "cpf" : { "type" : "string" }, "limite" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "nrIdentificacao" : { "type" : "string" }, "operacao" : { "type" : "integer", "format" : "int32" }, "parentesco" : { "type" : "integer", "format" : "int32" }, "plano" : { "type" : "integer", "format" : "int32" }, "titularidade" : { "type" : "integer", "format" : "int32" } } }, "BeneficioVeiculoInputTO" : { "type" : "object", "properties" : { "ajustes" : { "type" : "array", "description" : "Envie ajustes de valor para definir descontos ou acréscimos ao valor da mensalidade do benefício.", "items" : { "$ref" : "#/components/schemas/BeneficioAjusteInputTO" } }, "anoFabricacao" : { "type" : "integer", "format" : "int32", "maximum" : 2099, "minimum" : 1900 }, "anoModelo" : { "type" : "integer", "format" : "int32", "maximum" : 2099, "minimum" : 1900 }, "ativo" : { "type" : "boolean", "description" : "Envie true se o veículo estiver ativo no sistema ou false se estiver inativo." }, "categoria" : { "type" : "string", "enum" : [ "MOTOCICLETA", "LEVE", "UTILITARIO", "PICKUP", "CAMINHAO", "ONIBUS", "BICICLETA", "OUTRO" ] }, "chassi" : { "type" : "string", "maxLength" : 35, "minLength" : 5, "pattern" : "^([A-Z0-9]{5,35})?$" }, "codBeneficio" : { "type" : "integer", "format" : "int32", "description" : "Este código é retornado pelo Siprov após gravar o benefício. Deve ser salvo pelo cliente e reenviado nas requisições seguintes. Se não for enviado, a requisição criará novo benefício.", "maximum" : 2147483647, "minimum" : 1 }, "codCartaoCredito" : { "type" : "integer", "format" : "int32", "description" : "Informe o código do Cartão de Crédito previamente cadastrado e recuperado no respectivo método." }, "codConsultor" : { "type" : "integer", "format" : "int32", "description" : "Informe o código do consultor se quiser definir o consultor.", "maximum" : 2147483647, "minimum" : 1 }, "codFormaPagamento" : { "type" : "integer", "format" : "int32", "description" : "Informe o código da Forma de Pagamento previamente cadastrado e recuperado no respectivo método." }, "codLoja" : { "type" : "integer", "format" : "int32", "description" : "Os valores disponíveis para o cliente são retornados pelo método de autenticação.", "maximum" : 2147483647, "minimum" : 1 }, "codPlano" : { "type" : "integer", "format" : "int32", "description" : "Envie um dos planos disponíveis na consulta de negociação.", "maximum" : 2147483647, "minimum" : 1 }, "codRepresentante" : { "type" : "integer", "format" : "int32", "description" : "Informe o código do representante se quiser definir o representante.", "maximum" : 2147483647, "minimum" : 1 }, "codigoFipe" : { "type" : "string", "example" : "999999-9", "pattern" : "^(\\d{6}\\-\\d)?$" }, "combustivel" : { "type" : "string", "enum" : [ "GASOLINA", "ETANOL", "FLEX", "DIESEL", "GNV", "ELETRICO", "OUTRO" ] }, "cor" : { "type" : "string", "maxLength" : 20, "minLength" : 0 }, "cpfCnpj" : { "type" : "string", "description" : "Informe o CPF/CNPJ com ou sem máscara." }, "dataAdesao" : { "type" : "string", "description" : "Data de adesão do benefício.", "example" : "dd/MM/yyyy", "maxLength" : 10, "minLength" : 0, "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "diaVencimento" : { "type" : "integer", "format" : "int32", "maximum" : 30, "minimum" : 1 }, "excluirPlano" : { "type" : "boolean", "description" : "Envie true para excluir o plano do benefício (caso exista) ou false para incluí-lo (caso não exista)." }, "marca" : { "type" : "string", "maxLength" : 45, "minLength" : 2 }, "modelo" : { "type" : "string", "maxLength" : 60, "minLength" : 1 }, "numeroPassageiros" : { "type" : "integer", "format" : "int32", "maximum" : 999, "minimum" : 1 }, "numeroPortas" : { "type" : "integer", "format" : "int32", "maximum" : 10, "minimum" : 1 }, "placa" : { "type" : "string" }, "renavam" : { "type" : "string", "maxLength" : 35, "minLength" : 0 }, "situacao" : { "type" : "string", "description" : "Envie o nome da situação de benefício." }, "tipoVeiculo" : { "type" : "string", "description" : "Descrição do tipo de veículo", "maxLength" : 45, "minLength" : 0 }, "valorProtegido" : { "type" : "number", "minimum" : 0 }, "valorVeiculo" : { "type" : "number", "minimum" : 0 } }, "required" : [ "codPlano" ] }, "BeneficioVeiculoTO" : { "type" : "object", "properties" : { "anoFabricacao" : { "type" : "integer", "format" : "int32" }, "anoModelo" : { "type" : "integer", "format" : "int32" }, "ativo" : { "type" : "boolean" }, "categoria" : { "type" : "string" }, "chassi" : { "type" : "string" }, "codigoFipe" : { "type" : "string" }, "combustivel" : { "type" : "string" }, "cor" : { "type" : "string" }, "marca" : { "type" : "string" }, "modelo" : { "type" : "string" }, "placa" : { "type" : "string" }, "renavam" : { "type" : "string" }, "semPlaca" : { "type" : "boolean" }, "tipoVeiculo" : { "type" : "string" }, "valorParticipacao" : { "type" : "number" }, "valorProtegido" : { "type" : "number" }, "valorVeiculo" : { "type" : "number" } } }, "BoletoOutputTO" : { "type" : "object", "properties" : { "chavePix" : { "type" : "string" }, "codBoleto" : { "type" : "integer", "format" : "int64" }, "linhaDigitavel" : { "type" : "string" }, "urlFatura" : { "type" : "string" }, "urlPdf" : { "type" : "string" } } }, "CadastroCartaoInputTO" : { "type" : "object", "properties" : { "anoExpiracao" : { "type" : "integer", "format" : "int32", "maximum" : 2099, "minimum" : 2021 }, "codPessoa" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codigoSeguranca" : { "type" : "string", "pattern" : "^\\d{3}$" }, "cpfCnpjTitular" : { "type" : "string" }, "mesExpiracao" : { "type" : "integer", "format" : "int32", "maximum" : 12, "minimum" : 1 }, "nomeTitular" : { "type" : "string", "maxLength" : 2147483647, "minLength" : 1 }, "numeroCartao" : { "type" : "string", "pattern" : "^\\d{4}([. ]?\\d{4}){3}$" } }, "required" : [ "anoExpiracao", "codPessoa", "mesExpiracao" ] }, "CadastroCartaoOutputTO" : { "type" : "object", "properties" : { "codCartaoCredito" : { "type" : "integer", "format" : "int32" } } }, "CampoAdicionalInputTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "valor" : { "type" : "object", "description" : "O deve ser uma String em caso de valor individual, ou uma array de String em caso de múltiplos valores." } }, "required" : [ "id", "valor" ] }, "CampoAdicionalOutputTO" : { "type" : "object", "properties" : { "codCampo" : { "type" : "integer", "format" : "int32" }, "grupo" : { "type" : "string" }, "nome" : { "type" : "string" }, "obrigatorio" : { "type" : "boolean" }, "ordem" : { "type" : "integer", "format" : "int32" }, "tipo" : { "type" : "string", "enum" : [ "Texto curto", "Texto longo", "Número", "Lista de seleção única", "Lista de seleção múltipla", "Campo de seleção única", "Campo de seleção múltipla", "Calendário" ] }, "valoresInformados" : { "type" : "array", "items" : { "type" : "string" } }, "valoresPossiveis" : { "type" : "array", "items" : { "type" : "string" } } } }, "CartaoCreditoTO" : { "type" : "object", "properties" : { "codCartao" : { "type" : "integer", "format" : "int32" }, "descricao" : { "type" : "string" } } }, "ClinicaEspecialidadeOutputTO" : { "type" : "object", "properties" : { "condicoes" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int32" }, "medico" : { "$ref" : "#/components/schemas/CodigoNomeTO" }, "nome" : { "type" : "string" }, "observacao" : { "type" : "string" }, "valorConsulta" : { "type" : "number" } } }, "ClinicaMedicoOutputTO" : { "type" : "object", "properties" : { "crm" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "rqe" : { "type" : "string" } } }, "ClinicaOutputTO" : { "type" : "object", "properties" : { "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "emails" : { "type" : "array", "items" : { "type" : "string" } }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "especialidades" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClinicaEspecialidadeOutputTO" } }, "exames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CodigoNomeTO" } }, "horarios" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FaixaHorarioOutputTO" } }, "id" : { "type" : "integer", "format" : "int32" }, "medicos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClinicaMedicoOutputTO" } }, "nome" : { "type" : "string" }, "razaoSocial" : { "type" : "string" }, "regiaoAtendimento" : { "type" : "string" }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } }, "urlLogomarca" : { "type" : "string" } } }, "CobrancaCartaoOutputTO" : { "type" : "object", "properties" : { "codigoAutorizacao" : { "type" : "string" }, "nsu" : { "type" : "string" } } }, "CobrancaTituloInputTO" : { "type" : "object", "properties" : { "codTipoLiquidacao" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codTitulo" : { "type" : "integer", "format" : "int64", "minimum" : 1 }, "observacao" : { "type" : "string" }, "valorPago" : { "type" : "number", "minimum" : 1 } }, "required" : [ "codTipoLiquidacao", "codTitulo", "valorPago" ] }, "CodigoNomeTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" } } }, "ConsultaInputTO" : { "type" : "object", "properties" : { "bairro" : { "type" : "string", "description" : "Bairro de preferência para clínicas ou consultórios.", "title" : "Bairro" }, "cidade" : { "type" : "string", "description" : "Cidade de preferência para clínicas ou consultórios.", "title" : "Cidade" }, "codBeneficio" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Benefício" }, "codDependente" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Dependente" }, "codEspecialidade" : { "type" : "integer", "format" : "int32", "description" : "Código da especialidade demandada para a marcação de consulta.", "maximum" : 2147483647, "minimum" : 1, "title" : "Código da Especialidade" }, "codRegiaoAtendimento" : { "type" : "integer", "format" : "int32", "description" : "Código da região de atendimento de preferência para clínicas ou consultórios.", "maximum" : 2147483647, "minimum" : 1, "title" : "Código da Região de Atendimento" }, "codTitular" : { "type" : "integer", "format" : "int32", "description" : "Código do titular (associado ou cliente)", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Titular" }, "dataFinal" : { "type" : "string", "description" : "Data final do período para pesquisa de disponibilidade de clínicas ou consultórios.", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$", "title" : "Data Final" }, "dataInicial" : { "type" : "string", "description" : "Data inicial do período para pesquisa de disponibilidade de clínicas ou consultórios.", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$", "title" : "Data Inicial" }, "descricao" : { "type" : "string", "description" : "Descrição da demanda para marcação de consulta.", "title" : "Descrição" }, "preferenciaData" : { "type" : "string", "description" : "Preferência de data para marcação da consulta.", "title" : "Preferência de Data" } } }, "ConsultaOutputTO" : { "type" : "object", "properties" : { "codBeneficio" : { "type" : "integer", "format" : "int32", "title" : "Código do Benefício" }, "codConsulta" : { "type" : "integer", "format" : "int64", "title" : "Código da Marcação de Consulta" }, "codDependente" : { "type" : "integer", "format" : "int32", "title" : "Código do Dependente (titular ou dependente)" }, "codEspecialidade" : { "type" : "integer", "format" : "int32", "title" : "Código da Especialidade" }, "codTitular" : { "type" : "integer", "format" : "int32", "title" : "Código do Titular (titular ou dependente)" }, "dataAbertura" : { "type" : "string", "title" : "Data de Abertura" }, "dataConsulta" : { "type" : "string", "title" : "Data da Consulta" }, "enderecoConsulta" : { "type" : "string", "title" : "Endereço da Consulta" }, "nomeEspecialidade" : { "type" : "string", "title" : "Nome da Especialidade" }, "nomeMedico" : { "type" : "string", "title" : "Nome do Médico" }, "nomeSolicitante" : { "type" : "string", "title" : "Nome do Solicitante (titular ou dependente)" }, "nomeUsuarioAbertura" : { "type" : "string", "title" : "Nome do Usuário de Abertura" }, "preferenciaData" : { "type" : "string", "title" : "Data de Preferência" }, "protocolo" : { "type" : "string", "title" : "Protocolo" }, "situacao" : { "type" : "string", "title" : "Situação da Marcação de Consulta" } } }, "CriacaoTituloInputTO" : { "type" : "object", "properties" : { "codBeneficio" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codPessoa" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codTipoTitulo" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "descricao" : { "type" : "string", "maxLength" : 100, "minLength" : 1 }, "valor" : { "type" : "number", "minimum" : 1 }, "vencimento" : { "type" : "string", "maxLength" : 10, "minLength" : 10, "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" } }, "required" : [ "codBeneficio", "codPessoa", "codTipoTitulo", "valor" ] }, "CriacaoTituloOutputTO" : { "type" : "object", "properties" : { "codTitulo" : { "type" : "integer", "format" : "int64" } } }, "CriacaoVistoriaInputTO" : { "type" : "object", "properties" : { "codBeneficio" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "codTipo" : { "type" : "integer", "format" : "int32", "minimum" : 1 }, "observacao" : { "type" : "string", "maxLength" : 255, "minLength" : 0 } }, "required" : [ "codBeneficio", "codTipo" ] }, "CriacaoVistoriaOutputFotoTO" : { "type" : "object", "properties" : { "codFoto" : { "type" : "integer", "format" : "int32" }, "codImagem" : { "type" : "integer", "format" : "int32" }, "codTipo" : { "type" : "integer", "format" : "int32" }, "dataEnvio" : { "type" : "string" }, "descricao" : { "type" : "string" }, "finalidade" : { "type" : "string", "enum" : [ "Benefício", "Documentos" ] }, "latitude" : { "type" : "number" }, "longitude" : { "type" : "number" }, "nomeArquivo" : { "type" : "string" }, "nomeTipo" : { "type" : "string" }, "nomeUsuario" : { "type" : "string" }, "obrigatorio" : { "type" : "boolean" }, "ordem" : { "type" : "integer", "format" : "int32" }, "tamanho" : { "type" : "integer", "format" : "int32" }, "tipoAnexo" : { "type" : "string", "enum" : [ "Genérico", "Assinatura", "Contrato", "Selfie" ] }, "tipoMime" : { "type" : "string" }, "urlFoto" : { "type" : "string" }, "urlImagem" : { "type" : "string" } } }, "DependenteBasicoOutputTO" : { "type" : "object", "properties" : { "codDependente" : { "type" : "integer", "format" : "int32" }, "numeroCartaoDesconto" : { "type" : "string" } } }, "DependenteCompletoOutputTO" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "codDependente" : { "type" : "integer", "format" : "int32" }, "cpf" : { "type" : "string" }, "dataCadastro" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "idade" : { "type" : "integer", "format" : "int32" }, "identidade" : { "type" : "string" }, "nome" : { "type" : "string" }, "numeroCartaoDesconto" : { "type" : "string" }, "parentesco" : { "type" : "string" }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro" ] }, "telefone" : { "type" : "string" } } }, "DependenteInputTO" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "codBeneficio" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1 }, "codDependente" : { "type" : "integer", "format" : "int32", "description" : "Este código é retornado pelo Siprov após gravar o dependente. Deve ser salvo pelo cliente e reenviado nas requisições seguintes. Se não for enviado, a requisição criará novo dependente.", "maximum" : 2147483647, "minimum" : 1 }, "cpf" : { "type" : "string" }, "dataNascimento" : { "type" : "string", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "identidade" : { "type" : "string", "maxLength" : 45, "minLength" : 0 }, "nome" : { "type" : "string", "maxLength" : 100, "minLength" : 3 }, "numeroCartaoDesconto" : { "type" : "string", "maxLength" : 20, "minLength" : 0 }, "parentesco" : { "type" : "string", "enum" : [ "CONJUGE", "PAI", "FILHO", "IRMAO", "AVO", "TIO", "SOBRINHO", "PRIMO", "NETO", "SOGRO", "PET_CANINO", "PET_FELINO", "PET_OUTROS", "OUTRO" ] }, "planos" : { "type" : "array", "description" : "Informe os códigos de planos do dependente conforme negociação.", "items" : { "type" : "integer", "format" : "int32", "description" : "Informe os códigos de planos do dependente conforme negociação." } }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro" ] }, "telefone" : { "type" : "string" } }, "required" : [ "codBeneficio" ] }, "EnderecoTO" : { "type" : "object", "properties" : { "bairro" : { "type" : "string", "maxLength" : 60, "minLength" : 0 }, "cep" : { "type" : "string" }, "cidade" : { "type" : "string", "maxLength" : 60, "minLength" : 0 }, "codEndereco" : { "type" : "integer", "format" : "int32" }, "complemento" : { "type" : "string", "maxLength" : 50, "minLength" : 0 }, "logradouro" : { "type" : "string", "maxLength" : 150, "minLength" : 0 }, "numero" : { "type" : "string", "maxLength" : 50, "minLength" : 0 }, "tipoEndereco" : { "type" : "string", "maxLength" : 30, "minLength" : 0 }, "tipoLogradouro" : { "type" : "string", "maxLength" : 20, "minLength" : 0 }, "uf" : { "type" : "string", "maxLength" : 2, "minLength" : 0 } } }, "EventoOrcamentoInputTO" : { "type" : "object", "properties" : { "codEvento" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Evento" }, "codFornecedor" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Fornecedor" }, "codOrcamento" : { "type" : "integer", "format" : "int32", "maximum" : 2147483647, "minimum" : 1, "title" : "Código do Orçamento" }, "dataOrcamento" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$", "title" : "Data do Orçamento" }, "itens" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventoOrcamentoItemTO" }, "title" : "Itens" }, "observacao" : { "type" : "string", "title" : "Observação" } }, "required" : [ "codEvento", "codFornecedor", "dataOrcamento" ] }, "EventoOrcamentoItemTO" : { "type" : "object", "properties" : { "codOrcamentoItem" : { "type" : "integer", "format" : "int32", "description" : "Código identificador do item do orçamento. Deve ser informado na edição.", "title" : "Código de Item do Orçamento" }, "desconto" : { "type" : "number", "description" : "Valor de desconto do item de orçamento.", "example" : 10.0, "title" : "Desconto" }, "descricao" : { "type" : "string", "description" : "Descrição curta do item de orçamento.", "example" : "Peças", "title" : "Descrição" }, "quantidade" : { "type" : "number", "description" : "Quantidade do item de orçamento.", "example" : 10.0, "title" : "Quantidade" }, "valor" : { "type" : "number", "description" : "Valor do item de orçamento.", "example" : 100.0, "title" : "Valor" } }, "required" : [ "descricao", "quantidade", "valor" ], "title" : "Itens" }, "EventoOrcamentoOutputTO" : { "type" : "object", "properties" : { "codEvento" : { "type" : "integer", "format" : "int32", "title" : "Código do Evento" }, "codOrcamento" : { "type" : "integer", "format" : "int32", "title" : "Código do Orçamento" }, "dataOrcamento" : { "type" : "string", "title" : "Data do Orçamento" }, "nomeFornecedor" : { "type" : "string", "title" : "Nome do Fornecedor" }, "nomeResponsavel" : { "type" : "string", "title" : "Nome do Responsável" }, "observacao" : { "type" : "string", "title" : "Observação" }, "situacao" : { "type" : "string", "enum" : [ "Em Análise", "Aprovado", "Cancelado", "Rateio Efetuado" ], "title" : "Situação" }, "valorTotal" : { "type" : "number", "title" : "Valor Total" } } }, "EventoOutputTO" : { "type" : "object", "properties" : { "alocador" : { "$ref" : "#/components/schemas/EventoPessoaOutputTO" }, "associado" : { "$ref" : "#/components/schemas/EventoPessoaOutputTO" }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codEvento" : { "type" : "integer", "format" : "int32" }, "condutor" : { "$ref" : "#/components/schemas/EventoPessoaOutputTO" }, "corDestaque" : { "type" : "string" }, "corInversa" : { "type" : "string" }, "dataAbertura" : { "type" : "string" }, "dataEvento" : { "type" : "string" }, "envolvido" : { "type" : "string", "enum" : [ "Cliente", "Terceiro" ] }, "local" : { "$ref" : "#/components/schemas/EnderecoTO" }, "prioridade" : { "type" : "string", "enum" : [ "Baixa", "Média", "Alta", "Urgente" ] }, "protocolo" : { "type" : "string" }, "relacionados" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventoOutputTO" } }, "responsavel" : { "type" : "string" }, "situacao" : { "type" : "string" }, "tipoEvento" : { "type" : "string" }, "veiculo" : { "$ref" : "#/components/schemas/EventoVeiculoOutputTO" } } }, "EventoPessoaOutputTO" : { "type" : "object", "properties" : { "categoriaCnh" : { "type" : "string", "enum" : [ "A", "B", "C", "D", "E", "AB", "AC", "AD", "AE", "ACC" ] }, "codLoja" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "dataExpedicao" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "identidade" : { "type" : "string" }, "inscricaoEstadual" : { "type" : "string" }, "inscricaoMunicipal" : { "type" : "string" }, "nomeFantasia" : { "type" : "string" }, "nomeLoja" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "numeroCnh" : { "type" : "string" }, "orgaoExpedidor" : { "type" : "string" }, "representanteLegal" : { "type" : "string" }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro" ] }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } }, "validadeCnh" : { "type" : "string" } } }, "EventoVeiculoOutputTO" : { "type" : "object", "properties" : { "anoFabricacao" : { "type" : "integer", "format" : "int32" }, "anoModelo" : { "type" : "integer", "format" : "int32" }, "categoria" : { "type" : "string" }, "chassi" : { "type" : "string" }, "combustivel" : { "type" : "string" }, "cor" : { "type" : "string" }, "marca" : { "type" : "string" }, "modelo" : { "type" : "string" }, "numeroPortas" : { "type" : "integer", "format" : "int32" }, "placa" : { "type" : "string" }, "renavam" : { "type" : "string" }, "tipoVeiculo" : { "type" : "string" }, "valorParticipacao" : { "type" : "number" }, "valorProtegido" : { "type" : "number" }, "valorVeiculo" : { "type" : "number" } } }, "ExameTO" : { "type" : "object", "properties" : { "codExame" : { "type" : "integer", "format" : "int32" }, "descricao" : { "type" : "string" }, "nome" : { "type" : "string" } } }, "FaixaHorarioOutputTO" : { "type" : "object", "properties" : { "dia" : { "type" : "string", "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "fim" : { "type" : "string" }, "inicio" : { "type" : "string" } } }, "FormaPagamentoTO" : { "type" : "object", "properties" : { "codFormaPagamento" : { "type" : "integer", "format" : "int32" }, "descricao" : { "type" : "string" }, "parcelas" : { "type" : "integer", "format" : "int32" }, "tipo" : { "type" : "string" } } }, "ItemBeneficioOutputTO" : { "type" : "object", "properties" : { "codItem" : { "type" : "integer", "format" : "int32" }, "codPlano" : { "type" : "integer", "format" : "int32" }, "descricao" : { "type" : "string" }, "nome" : { "type" : "string" }, "valor" : { "type" : "number" } } }, "ItemBoletoOutputTO" : { "type" : "object", "properties" : { "beneficio" : { "type" : "string" }, "celular" : { "type" : "string" }, "chavePix" : { "type" : "string" }, "codBoleto" : { "type" : "integer", "format" : "int64" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codTitulo" : { "type" : "integer", "format" : "int64" }, "cpfCnpjPessoa" : { "type" : "string" }, "dataEmissao" : { "type" : "string" }, "dataVencimento" : { "type" : "string" }, "descricao" : { "type" : "string" }, "linhaDigitavel" : { "type" : "string" }, "nomeLoja" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "tipo" : { "type" : "string" }, "urlFatura" : { "type" : "string" }, "urlPdf" : { "type" : "string" }, "valor" : { "type" : "number" } } }, "ItemTituloOutputTO" : { "type" : "object", "properties" : { "celular" : { "type" : "string" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codTitulo" : { "type" : "integer", "format" : "int64" }, "cpfCnpjPessoa" : { "type" : "string" }, "dataEmissao" : { "type" : "string" }, "dataLiquidacao" : { "type" : "string" }, "dataVencimento" : { "type" : "string" }, "descricao" : { "type" : "string" }, "nomeDevedorCredor" : { "type" : "string" }, "nomeLoja" : { "type" : "string" }, "sequencialBeneficio" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "situacao" : { "type" : "string", "enum" : [ "Aberto", "Pendente", "Liquidado", "Cancelado", "Protestado", "Rejeitado", "Agrupado", "Negociado" ] }, "tipo" : { "type" : "string" }, "valor" : { "type" : "number" }, "valorLiquidado" : { "type" : "number" } } }, "LeadInputTO" : { "type" : "object", "properties" : { "codLoja" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codUsuarioResponsavel" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "dataNascimento" : { "type" : "string", "example" : "yyyy-MM-dd", "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "natureza" : { "type" : "string", "enum" : [ "F", "J" ] }, "nomePessoa" : { "type" : "string" }, "observacao" : { "type" : "string" }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro" ] }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } } } }, "LeadOutputTO" : { "type" : "object", "properties" : { "cpfCnpj" : { "type" : "string" }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" } } }, "LeadTO" : { "type" : "object", "properties" : { "codPessoa" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "natureza" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "sexo" : { "type" : "string" }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } } } }, "ListaBoletoOutputTO" : { "type" : "object", "properties" : { "itens" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ItemBoletoOutputTO" } }, "quantidade" : { "type" : "integer", "format" : "int32" } } }, "ListaDiaVencimentoTO" : { "type" : "object", "properties" : { "dias" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "ListaPesquisaAssociadoOutputTO" : { "type" : "object", "properties" : { "itens" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PesquisaAssociadoOutputTO" } }, "paginaAtual" : { "type" : "integer", "format" : "int32" }, "proximaPagina" : { "type" : "boolean" }, "quantidade" : { "type" : "integer", "format" : "int32" } } }, "ListaTituloOutputTO" : { "type" : "object", "properties" : { "itens" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ItemTituloOutputTO" } }, "quantidade" : { "type" : "integer", "format" : "int32" } } }, "LojaOutputTO" : { "type" : "object", "properties" : { "codLoja" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" } } }, "MedicoConsultorioTO" : { "type" : "object", "properties" : { "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "horarios" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FaixaHorarioOutputTO" } }, "nome" : { "type" : "string" }, "telefone1" : { "type" : "string" }, "telefone2" : { "type" : "string" } } }, "MedicoOutputTO" : { "type" : "object", "properties" : { "consultorios" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MedicoConsultorioTO" } }, "crm" : { "type" : "string" }, "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "emails" : { "type" : "array", "items" : { "type" : "string" } }, "especialidades" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CodigoNomeTO" } }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "regiaoAtendimento" : { "type" : "string" }, "rqe" : { "type" : "string" }, "valorConsulta" : { "type" : "number" } } }, "NegociacaoOutputTO" : { "type" : "object", "properties" : { "codPlano" : { "type" : "integer", "format" : "int32" }, "nomePlano" : { "type" : "string" }, "tipoBeneficio" : { "type" : "string", "enum" : [ "Proteção Veicular", "Saúde", "Diversos", "Consórcio", "Assistência 24H", "Assinatura", "Rumo Tecnologia" ] }, "tipoDesconto" : { "type" : "string", "enum" : [ "$", "%" ] }, "tipoTaxaAdesao" : { "type" : "string", "enum" : [ "$", "%" ] }, "valor" : { "type" : "number" }, "valorDescontoMaximo" : { "type" : "number" }, "valorDescontoMinimo" : { "type" : "number" }, "valorTaxaAdesaoMaxima" : { "type" : "number" }, "valorTaxaAdesaoMinima" : { "type" : "number" } } }, "NegocioBeneficioInputTO" : { "type" : "object", "properties" : { "anoFabricacao" : { "type" : "integer", "format" : "int32" }, "anoModelo" : { "type" : "integer", "format" : "int32" }, "categoria" : { "type" : "string", "enum" : [ "Motocicleta", "Leve", "Utilitário", "Pickup", "Caminhão", "Ônibus", "Outro", "Bicicleta" ] }, "chassi" : { "type" : "string" }, "codTipoVeiculo" : { "type" : "integer", "format" : "int32" }, "codigoFipe" : { "type" : "string" }, "combustivel" : { "type" : "string", "enum" : [ "Gasolina", "Etanol", "Flex", "Diesel", "GNV", "Elétrico", "Outro" ] }, "cor" : { "type" : "string" }, "diaVencimento" : { "type" : "integer", "format" : "int32" }, "marca" : { "type" : "string" }, "modelo" : { "type" : "string" }, "numeroPassageiros" : { "type" : "integer", "format" : "int32" }, "numeroPortas" : { "type" : "integer", "format" : "int32" }, "placa" : { "type" : "string" }, "renavam" : { "type" : "string" }, "semPlaca" : { "type" : "boolean" }, "tipoBeneficio" : { "type" : "string", "enum" : [ "Proteção Veicular", "Saúde", "Diversos", "Consórcio", "Assistência 24H", "Assinatura", "Rumo Tecnologia" ] }, "valorProtegido" : { "type" : "number" }, "valorVeiculo" : { "type" : "number" }, "zeroKm" : { "type" : "boolean" } } }, "NegocioBeneficioTO" : { "type" : "object", "properties" : { "anoFabricacao" : { "type" : "integer", "format" : "int32" }, "anoModelo" : { "type" : "integer", "format" : "int32" }, "categoria" : { "type" : "string" }, "chassi" : { "type" : "string" }, "codTipoVeiculo" : { "type" : "integer", "format" : "int32" }, "codigoFipe" : { "type" : "string" }, "combustivel" : { "type" : "string" }, "cor" : { "type" : "string" }, "dependentes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NegocioDependenteTO" } }, "diaVencimento" : { "type" : "integer", "format" : "int32" }, "marca" : { "type" : "string" }, "modelo" : { "type" : "string" }, "numeroPassageiros" : { "type" : "integer", "format" : "int32" }, "numeroPortas" : { "type" : "integer", "format" : "int32" }, "placa" : { "type" : "string" }, "renavam" : { "type" : "string" }, "semPlaca" : { "type" : "boolean" }, "tipoBeneficio" : { "type" : "string", "enum" : [ "Proteção Veicular", "Saúde", "Diversos", "Consórcio", "Assistência 24H", "Assinatura", "Rumo Tecnologia" ] }, "valorProtegido" : { "type" : "number" }, "valorVeiculo" : { "type" : "number" }, "zeroKm" : { "type" : "boolean" } } }, "NegocioDependenteTO" : { "type" : "object", "properties" : { "codDependente" : { "type" : "integer", "format" : "int32" }, "cpf" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "identidade" : { "type" : "string" }, "nome" : { "type" : "string" }, "parentesco" : { "type" : "string" }, "sexo" : { "type" : "string" } } }, "NegocioInputTO" : { "type" : "object", "properties" : { "beneficio" : { "$ref" : "#/components/schemas/NegocioBeneficioInputTO" }, "dataPrevisao" : { "type" : "string" }, "descricao" : { "type" : "string" }, "lead" : { "$ref" : "#/components/schemas/LeadInputTO" }, "nomeContato" : { "type" : "string" } }, "required" : [ "beneficio", "lead" ] }, "NegocioOutputTO" : { "type" : "object", "properties" : { "codNegocio" : { "type" : "integer", "format" : "int32" } } }, "NegocioTO" : { "type" : "object", "properties" : { "beneficio" : { "$ref" : "#/components/schemas/NegocioBeneficioTO" }, "codNegocio" : { "type" : "integer", "format" : "int32" }, "corDestaqueEtapa" : { "type" : "string" }, "corDestaqueNegocio" : { "type" : "string" }, "corInversaEtapa" : { "type" : "string" }, "corInversaNegocio" : { "type" : "string" }, "dataCadastro" : { "type" : "string" }, "dataPrevisao" : { "type" : "string" }, "descricao" : { "type" : "string" }, "lead" : { "$ref" : "#/components/schemas/LeadTO" }, "nomeContato" : { "type" : "string" }, "nomeEtapa" : { "type" : "string" }, "nomeFunil" : { "type" : "string" }, "nomeSituacao" : { "type" : "string" }, "nomeUsuarioCadastro" : { "type" : "string" }, "nomeUsuarioResponsavel" : { "type" : "string" }, "sequencial" : { "type" : "integer", "format" : "int32" } } }, "NomeValorTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "valor" : { "type" : "object", "description" : "O valor será uma String em caso de valor individual, ou uma array de String em caso de múltiplos valores." } } }, "PesquisaAssociadoOutputTO" : { "type" : "object", "properties" : { "categoriaCnh" : { "type" : "string", "enum" : [ "A", "B", "C", "D", "E", "AB", "AC", "AD", "AE", "ACC" ] }, "chassi" : { "type" : "string" }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "conjuge" : { "type" : "string" }, "cpfCnpj" : { "type" : "string" }, "cpfCnpjResponsavelFinanceiro" : { "type" : "string" }, "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "dataAdesao" : { "type" : "string" }, "dataAtivacao" : { "type" : "string" }, "dataCadastro" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "enderecoResponsavelFinanceiro" : { "$ref" : "#/components/schemas/EnderecoTO" }, "faturarParaEmpresa" : { "type" : "boolean" }, "idade" : { "type" : "integer", "format" : "int32" }, "identidade" : { "type" : "string" }, "nomeEmpresa" : { "type" : "string" }, "nomeMae" : { "type" : "string" }, "nomePai" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "nomeResponsavelFinanceiro" : { "type" : "string" }, "numeroCartaoDesconto" : { "type" : "string" }, "numeroCnh" : { "type" : "string" }, "placa" : { "type" : "string" }, "planos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlanoOutputTO" } }, "recebeEmail" : { "type" : "boolean" }, "recebeWhatsApp" : { "type" : "boolean" }, "sequencial" : { "type" : "integer", "format" : "int32" }, "sexo" : { "type" : "string" }, "situacao" : { "type" : "string" }, "telefoneCelular" : { "type" : "string" }, "telefoneFixo" : { "type" : "string" }, "tipoBeneficio" : { "type" : "string" }, "tipoSituacao" : { "type" : "string" } } }, "PesquisaBeneficioOutputTO" : { "type" : "object", "properties" : { "categoriaCnh" : { "type" : "string", "enum" : [ "A", "B", "C", "D", "E", "AB", "AC", "AD", "AE", "ACC" ] }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "dataCadastro" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "idade" : { "type" : "integer", "format" : "int32" }, "identidade" : { "type" : "string" }, "nomeConsultor" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "nomePlanoPrincipal" : { "type" : "string" }, "nomeRepresentante" : { "type" : "string" }, "numeroCartaoDesconto" : { "type" : "string" }, "numeroCnh" : { "type" : "string" }, "sexo" : { "type" : "string" }, "situacao" : { "type" : "string" }, "telefoneCelular" : { "type" : "string" }, "telefoneFixo" : { "type" : "string" }, "tipoBeneficio" : { "type" : "string" }, "tipoSituacao" : { "type" : "string" }, "valorMensalidade" : { "type" : "number" }, "veiculo" : { "$ref" : "#/components/schemas/BeneficioVeiculoTO" } } }, "PesquisaClinicaOutputTO" : { "type" : "object", "properties" : { "condicoes" : { "type" : "string" }, "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "emails" : { "type" : "array", "items" : { "type" : "string" } }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "observacao" : { "type" : "string" }, "razaoSocial" : { "type" : "string" }, "regiaoAtendimento" : { "type" : "string" }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } }, "urlLogomarca" : { "type" : "string" }, "valorConsulta" : { "type" : "number" } } }, "PesquisaDependenteOutputTO" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codDependente" : { "type" : "integer", "format" : "int32" }, "cpf" : { "type" : "string" }, "cpfCnpjTitular" : { "type" : "string" }, "dataCadastro" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "identidade" : { "type" : "string" }, "nomeDependente" : { "type" : "string" }, "nomeTitular" : { "type" : "string" }, "nomeUsuarioCadastro" : { "type" : "string" }, "numeroCartaoDesconto" : { "type" : "string" }, "parentesco" : { "type" : "string", "enum" : [ "Cônjuge", "Mãe/Pai", "Filho(a)", "Irmã/Irmão", "Avó/Avô", "Tio(a)", "Sobrinho(a)", "Primo(a)", "Neto(a)", "Sogro(a)", "Outro", "Pet - Canino", "Pet - Felino", "Pet - Outros", "Cunhado(a)", "Genro/Nora", "Enteado(a)", "Padrasto/Madrasta" ] }, "planos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ItemBeneficioOutputTO" } }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro" ] }, "telefone" : { "type" : "string" } } }, "PesquisaEventoOutputTO" : { "type" : "object", "properties" : { "codEvento" : { "type" : "integer", "format" : "int32" }, "corDestaque" : { "type" : "string" }, "corInversa" : { "type" : "string" }, "dataAbertura" : { "type" : "string" }, "dataEvento" : { "type" : "string" }, "envolvido" : { "type" : "string", "enum" : [ "Cliente", "Terceiro" ] }, "nomeLoja" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "prioridade" : { "type" : "string", "enum" : [ "Baixa", "Média", "Alta", "Urgente" ] }, "protocolo" : { "type" : "string" }, "responsavel" : { "type" : "string" }, "situacao" : { "type" : "string" }, "tipoEvento" : { "type" : "string" } } }, "PesquisaMedicoOutputTO" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" } } }, "PesquisaNegocioOutputBeneficioTO" : { "type" : "object", "properties" : { "chassi" : { "type" : "string" }, "marca" : { "type" : "string" }, "modelo" : { "type" : "string" }, "placa" : { "type" : "string" }, "tipoBeneficio" : { "type" : "string", "enum" : [ "Proteção Veicular", "Saúde", "Diversos", "Consórcio", "Assistência 24H", "Assinatura", "Rumo Tecnologia" ] } } }, "PesquisaNegocioOutputLeadTO" : { "type" : "object", "properties" : { "celular" : { "type" : "string" }, "codLead" : { "type" : "integer", "format" : "int32" }, "nomeFantasia" : { "type" : "string" }, "nomeRazao" : { "type" : "string" } } }, "PesquisaNegocioOutputTO" : { "type" : "object", "properties" : { "beneficio" : { "$ref" : "#/components/schemas/PesquisaNegocioOutputBeneficioTO" }, "codNegocio" : { "type" : "integer", "format" : "int32" }, "dataCadastro" : { "type" : "string" }, "descricao" : { "type" : "string" }, "lead" : { "$ref" : "#/components/schemas/PesquisaNegocioOutputLeadTO" }, "responsavel" : { "type" : "string" }, "sequencial" : { "type" : "integer", "format" : "int32" } } }, "PesquisaParceiroOutputTO" : { "type" : "object", "properties" : { "cpfCnpj" : { "type" : "string" }, "dadosAdicionais" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NomeValorTO" } }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "observacao" : { "type" : "string" }, "telefone" : { "type" : "string" }, "urlLogomarca" : { "type" : "string" } } }, "PesquisaTecnicoOutputTO" : { "type" : "object", "properties" : { "cpfCnpj" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "id" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "observacao" : { "type" : "string" }, "telefone" : { "type" : "string" } } }, "PesquisaVendedorOutputTO" : { "type" : "object", "properties" : { "codLoja" : { "type" : "integer", "format" : "int32" }, "codUsuario" : { "type" : "integer", "format" : "int32" }, "cpfCnpj" : { "type" : "string" }, "dataNascimento" : { "type" : "string" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "id" : { "type" : "integer", "format" : "int32" }, "identidade" : { "type" : "string" }, "nome" : { "type" : "string" }, "observacao" : { "type" : "string" }, "telefone" : { "type" : "string" }, "tipo" : { "type" : "string" } } }, "PessoaInputTO" : { "type" : "object", "properties" : { "codLoja" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codigoIntegracao" : { "type" : "string" }, "cpfCnpj" : { "type" : "string" }, "dataExpedicao" : { "type" : "string", "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" }, "dataNascimento" : { "type" : "string", "pattern" : "^(\\d{4}\\-\\d{2}\\-\\d{2})?$" }, "email" : { "type" : "string" }, "endereco" : { "$ref" : "#/components/schemas/EnderecoTO" }, "identidade" : { "type" : "string", "maxLength" : 25, "minLength" : 0 }, "natureza" : { "type" : "string", "enum" : [ "F", "J" ] }, "nomeFantasia" : { "type" : "string", "maxLength" : 100, "minLength" : 0 }, "nomePessoa" : { "type" : "string", "maxLength" : 250, "minLength" : 1 }, "observacao" : { "type" : "string" }, "orgaoExpedidor" : { "type" : "string", "maxLength" : 20, "minLength" : 0 }, "recebeEmail" : { "type" : "boolean" }, "recebeWhatsApp" : { "type" : "boolean" }, "sexo" : { "type" : "string", "enum" : [ "Feminino", "Masculino", "Outro", "F, M, I" ] }, "telefones" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelefoneTO" } } } }, "PessoaOutputTO" : { "type" : "object", "properties" : { "codPessoa" : { "type" : "integer", "format" : "int32" } } }, "PixOutputTO" : { "type" : "object", "properties" : { "chavePix" : { "type" : "string" }, "codPix" : { "type" : "integer", "format" : "int64" }, "dataEmissao" : { "type" : "string" }, "dataVencimento" : { "type" : "string" }, "situacao" : { "type" : "string", "enum" : [ "Pendente", "Aberto", "Liquidado", "Cancelado", "Estornado" ] }, "valorPix" : { "type" : "number" } } }, "PlanoOutputTO" : { "type" : "object", "properties" : { "codPlano" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "valor" : { "type" : "number" } } }, "RastreadorInstalacaoTO" : { "type" : "object", "properties" : { "codRastreadorInstalacao" : { "type" : "integer", "format" : "int32" }, "dataInstalacao" : { "type" : "string" }, "dataRemocao" : { "type" : "string" }, "nomeRastreador" : { "type" : "string" }, "nomeSituacao" : { "type" : "string" }, "nomeUsuarioInstalacao" : { "type" : "string" }, "nomeUsuarioRemocao" : { "type" : "string" }, "numeroImei" : { "type" : "string" }, "numeroSerie" : { "type" : "string" } } }, "RelPersonAdesaoInputTO" : { "type" : "object", "properties" : { "codConsultor" : { "type" : "integer", "format" : "int32" }, "codEmpresa" : { "type" : "integer", "format" : "int32" }, "codLayout" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "codNaturezaPessoa" : { "type" : "integer", "format" : "int32", "description" : "0=Todas, 1=Física, 2=Jurídica", "maximum" : 2, "minimum" : 0 }, "codRepresentante" : { "type" : "integer", "format" : "int32" }, "codTipoAssociado" : { "type" : "integer", "format" : "int32", "description" : "0=Todos, 1=Empresa, 2=Avulso", "maximum" : 2, "minimum" : 0 }, "dataAdesaoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAdesaoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAtivacaoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAtivacaoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCadastroFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCadastroInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "diaNascimentoFinal" : { "type" : "string", "example" : "dd/MM", "pattern" : "^(\\d{2}/\\d{2})?$" }, "diaNascimentoInicial" : { "type" : "string", "example" : "dd/MM", "pattern" : "^(\\d{2}/\\d{2})?$" }, "formato" : { "type" : "string", "description" : "Formato de saída do relatório", "enum" : [ "Excel", "JSON" ], "example" : "XLSX ou JSON" }, "idadeFinal" : { "type" : "integer", "format" : "int32", "maximum" : 120, "minimum" : 0 }, "idadeInicial" : { "type" : "integer", "format" : "int32", "maximum" : 120, "minimum" : 0 }, "situacaoBeneficio" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } }, "required" : [ "codLayout", "formato" ] }, "RelPersonAdesaoParamTO" : { "type" : "object", "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RelPersonTO" } }, "parametros" : { "$ref" : "#/components/schemas/RelPersonAdesaoInputTO" } } }, "RelPersonConsultaInputTO" : { "type" : "object", "properties" : { "codEmpresa" : { "type" : "integer", "format" : "int32" }, "codLayout" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "integer", "format" : "int32" }, "dataAberturaFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAberturaInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataConfirmacaoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataConfirmacaoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataConsultaFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataConsultaInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "formato" : { "type" : "string", "description" : "Formato de saída do relatório", "enum" : [ "Excel", "JSON" ], "example" : "XLSX ou JSON" }, "prioridade" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Baixa", "Média", "Alta", "Urgente" ] } } }, "required" : [ "codLayout", "formato" ] }, "RelPersonConsultaParamTO" : { "type" : "object", "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RelPersonTO" } }, "parametros" : { "$ref" : "#/components/schemas/RelPersonConsultaInputTO" } } }, "RelPersonEventoInputTO" : { "type" : "object", "properties" : { "codEmpresa" : { "type" : "integer", "format" : "int32" }, "codLayout" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "integer", "format" : "int32" }, "codSituacaoEvento" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "codTipoEvento" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "dataAberturaFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAberturaInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEncerramentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEncerramentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEventoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEventoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "envolvido" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Cliente", "Terceiro" ] } }, "formato" : { "type" : "string", "description" : "Formato de saída do relatório", "enum" : [ "Excel", "JSON" ], "example" : "XLSX ou JSON" }, "prioridade" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Baixa", "Média", "Alta", "Urgente" ] } } }, "required" : [ "codLayout", "formato" ] }, "RelPersonEventoParamTO" : { "type" : "object", "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RelPersonTO" } }, "parametros" : { "$ref" : "#/components/schemas/RelPersonEventoInputTO" } } }, "RelPersonFinanceiroInputTO" : { "type" : "object", "properties" : { "codConsultor" : { "type" : "integer", "format" : "int32" }, "codEmpresa" : { "type" : "integer", "format" : "int32" }, "codLayout" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "codRepresentante" : { "type" : "integer", "format" : "int32" }, "codTipoLiquidacao" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "codTipoTitulo" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "dataCancelamentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEmissaoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEmissaoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataLiquidacaoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataLiquidacaoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataVencimentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataVencimentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "formato" : { "type" : "string", "description" : "Formato de saída do relatório", "enum" : [ "Excel", "JSON" ], "example" : "XLSX ou JSON" }, "situacaoBeneficio" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "situacaoTitulo" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Aberto", "Pendente", "Liquidado", "Cancelado", "Protestado", "Rejeitado", "Agrupado", "Negociado" ] } }, "tipoLancamento" : { "type" : "string", "description" : "Tipo de lançamento do título", "enum" : [ "Débito", "Crédito", "Rateio" ], "example" : "CREDITO" } }, "required" : [ "codLayout", "formato", "tipoLancamento" ] }, "RelPersonFinanceiroParamTO" : { "type" : "object", "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RelPersonTO" } }, "parametros" : { "$ref" : "#/components/schemas/RelPersonFinanceiroInputTO" } } }, "RelPersonHelpDeskInputTO" : { "type" : "object", "properties" : { "codEmpresa" : { "type" : "integer", "format" : "int32" }, "codLayout" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "integer", "format" : "int32" }, "dataAberturaFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataAberturaInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataCancelamentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEncerramentoFinal" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "dataEncerramentoInicial" : { "type" : "string", "example" : "dd/MM/yyyy", "pattern" : "^(\\d{2}/\\d{2}/\\d{4})?$" }, "formato" : { "type" : "string", "description" : "Formato de saída do relatório", "enum" : [ "Excel", "JSON" ], "example" : "XLSX ou JSON" }, "prioridade" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "Baixa", "Média", "Alta", "Urgente" ] } } }, "required" : [ "codLayout", "formato" ] }, "RelPersonHelpDeskParamTO" : { "type" : "object", "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RelPersonTO" } }, "parametros" : { "$ref" : "#/components/schemas/RelPersonHelpDeskInputTO" } } }, "RelPersonTO" : { "type" : "object", "properties" : { "codLayout" : { "type" : "integer", "format" : "int32" }, "codRelatorio" : { "type" : "integer", "format" : "int32" }, "dataEmissao" : { "type" : "string" }, "formato" : { "type" : "string", "enum" : [ "Excel", "JSON" ] }, "mensagem" : { "type" : "string" }, "nomeLayout" : { "type" : "string" }, "nomeUsuario" : { "type" : "string" }, "situacao" : { "type" : "string", "enum" : [ "Pendente", "Processando", "Finalizado", "Cancelado" ] } } }, "SituacaoBeneficioTO" : { "type" : "object", "properties" : { "codSituacaoBeneficio" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "tipo" : { "type" : "string", "enum" : [ "Pendente", "Ativo", "Substituído", "Cancelado", "Inativo", "Recusado", "Inadimplente", "Outros" ] } } }, "TelefoneTO" : { "type" : "object", "properties" : { "ddi" : { "type" : "integer", "format" : "int32" }, "numero" : { "type" : "string", "maxLength" : 15, "minLength" : 10 }, "tipo" : { "type" : "string", "enum" : [ "Fixo", "Celular/WhatsApp" ] } }, "required" : [ "tipo" ] }, "TipoEventoBean" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "codTipoEvento" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "privado" : { "type" : "boolean" } } }, "TipoLiquidacaoBean" : { "type" : "object", "properties" : { "codTipoLiquidacao" : { "type" : "integer", "format" : "int32" }, "nome" : { "type" : "string" }, "prazoCredito" : { "type" : "integer", "format" : "int32" }, "taxaDesconto" : { "type" : "number" }, "valorDesconto" : { "type" : "number" } } }, "TipoTituloBean" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "cartaoCredito" : { "type" : "boolean" }, "codCentroCusto" : { "type" : "integer", "format" : "int32" }, "codNaturezaFinanceira" : { "type" : "integer", "format" : "int32" }, "codServico" : { "type" : "integer", "format" : "int32" }, "codTipoTitulo" : { "type" : "integer", "format" : "int32" }, "codigoServico" : { "type" : "string" }, "comissoesLoja" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TipoTituloComissaoLojaBean" } }, "comissoesPessoa" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TipoTituloComissaoPessoaBean" } }, "descricaoCentroCusto" : { "type" : "string" }, "descricaoNaturezaFinanceira" : { "type" : "string" }, "inadimplencia" : { "type" : "boolean" }, "nome" : { "type" : "string" }, "nomeServico" : { "type" : "string" }, "tipoLancamento" : { "type" : "string", "enum" : [ "Débito", "Crédito", "Rateio" ] }, "unicidade" : { "type" : "boolean" }, "valorPadrao" : { "type" : "number" } } }, "TipoTituloComissaoLojaBean" : { "type" : "object", "properties" : { "codComissao" : { "type" : "integer", "format" : "int32" }, "codComissionado" : { "type" : "integer", "format" : "int32" }, "codLoja" : { "type" : "integer", "format" : "int32" }, "nomeComissionado" : { "type" : "string" }, "nomeLoja" : { "type" : "string" }, "nomeTipoTitulo" : { "type" : "string" }, "tipoComissao" : { "type" : "string", "enum" : [ "$", "%" ] }, "tipoComissionado" : { "type" : "string", "enum" : [ "Unidade", "Cliente", "Acionamento", "Empresa", "Associado", "Representante", "Consultor", "Tipo de Serviço 24H", "Tipo de Evento 24H", "Help Desk", "Benefício", "Cartão de Benefícios", "Evento", "Adesão", "Técnico", "Documentação", "Clínica", "Lead", "Negócio", "Rastreador", "Agregado", "Médico", "Tipo de Benefício Veicular", "Tipo de Benefício Saúde", "Tipo de Benefício Diversos", "Tipo de Benefício Consórcio", "Tipo de Benefício 24H", "Ordem de Serviço", "Dependente", "Sub-Benefício" ] }, "urlComissionado" : { "type" : "string" }, "valorComissao" : { "type" : "number" } } }, "TipoTituloComissaoPessoaBean" : { "type" : "object", "properties" : { "codComissao" : { "type" : "integer", "format" : "int32" }, "codComissionado" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "nomeComissionado" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "nomeTipoTitulo" : { "type" : "string" }, "tipoComissao" : { "type" : "string", "enum" : [ "$", "%" ] }, "tipoComissionado" : { "type" : "string", "enum" : [ "Unidade", "Cliente", "Acionamento", "Empresa", "Associado", "Representante", "Consultor", "Tipo de Serviço 24H", "Tipo de Evento 24H", "Help Desk", "Benefício", "Cartão de Benefícios", "Evento", "Adesão", "Técnico", "Documentação", "Clínica", "Lead", "Negócio", "Rastreador", "Agregado", "Médico", "Tipo de Benefício Veicular", "Tipo de Benefício Saúde", "Tipo de Benefício Diversos", "Tipo de Benefício Consórcio", "Tipo de Benefício 24H", "Ordem de Serviço", "Dependente", "Sub-Benefício" ] }, "tipoPessoa" : { "type" : "string", "enum" : [ "Associado", "Representante", "Consultor", "Fornecedor", "Terceiro", "Empresa", "Médico", "Clínica", "Técnico", "Parceiro", "Lead" ] }, "urlComissionado" : { "type" : "string" }, "valorComissao" : { "type" : "number" } } }, "TipoVeiculoBean" : { "type" : "object", "properties" : { "ativo" : { "type" : "boolean" }, "categoria" : { "type" : "string", "enum" : [ "Motocicleta", "Leve", "Utilitário", "Pickup", "Caminhão", "Ônibus", "Outro", "Bicicleta" ] }, "codTipoVeiculo" : { "type" : "integer", "format" : "int32" }, "disponivelAppConsultor" : { "type" : "boolean" }, "disponivelContratacao" : { "type" : "boolean" }, "nome" : { "type" : "string" } } }, "TipoVistoriaInicialTO" : { "type" : "object", "properties" : { "categoria" : { "type" : "string", "enum" : [ "Motocicleta", "Leve", "Utilitário", "Pickup", "Caminhão", "Ônibus", "Outro", "Bicicleta" ] }, "codTipoVistoria" : { "type" : "integer", "format" : "int32" }, "nomeTipoVistoria" : { "type" : "string" }, "permitirAnexo" : { "type" : "boolean" }, "qtdeFotos" : { "type" : "integer", "format" : "int32" } } }, "TituloBeneficioOutputTO" : { "type" : "object", "properties" : { "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codConsultor" : { "type" : "integer", "format" : "int32" }, "codRepresentante" : { "type" : "integer", "format" : "int32" }, "descricao" : { "type" : "string" }, "nomeConsultor" : { "type" : "string" }, "nomeRepresentante" : { "type" : "string" }, "nomeSituacao" : { "type" : "string" }, "tipoSituacao" : { "type" : "string", "enum" : [ "Pendente", "Ativo", "Substituído", "Cancelado", "Inativo", "Recusado", "Inadimplente", "Outros" ] } } }, "TituloBoletoOutputTO" : { "type" : "object", "properties" : { "codBoleto" : { "type" : "integer", "format" : "int64" }, "dataEmissao" : { "type" : "string" }, "dataVencimento" : { "type" : "string" }, "linhaDigitavel" : { "type" : "string" }, "nossoNumero" : { "type" : "string" }, "numeroDocumento" : { "type" : "string" }, "situacao" : { "type" : "string", "enum" : [ "Pendente", "Aberto", "Cancelado", "Prorrogado", "Liquidado", "Salvo", "Emitido", "Remetido", "Baixado" ] }, "urlPdf" : { "type" : "string" }, "valorBoleto" : { "type" : "number" } } }, "TituloClassificacaoOutputTO" : { "type" : "object", "properties" : { "classificador" : { "type" : "string" }, "codCentroCusto" : { "type" : "integer", "format" : "int32" }, "codClassificacao" : { "type" : "integer", "format" : "int64" }, "codNaturezaFinanceira" : { "type" : "integer", "format" : "int32" }, "descricaoCentroCusto" : { "type" : "string" }, "descricaoNaturezaFinanceira" : { "type" : "string" }, "percentual" : { "type" : "number" }, "tipoLancamento" : { "type" : "string", "enum" : [ "Débito", "Crédito", "Rateio" ] }, "valor" : { "type" : "number" } } }, "TituloLiquidacaoOutputTO" : { "type" : "object", "properties" : { "acrescimo" : { "type" : "number" }, "agencia" : { "type" : "string" }, "banco" : { "type" : "string", "enum" : [ "246 — ABC Brasil", "085 — Ailos", "461 — Asaas", "001 — Banco do Brasil", "021 — Banestes", "318 — BMG", "274 — BMP Money Plus", "237 — Bradesco", "070 — Banco de Brasília", "218 — BS2 Bonsucesso", "208 — BTG Pactual", "336 — C6 Bank", "104 — Caixa Econômica Federal", "000 — Celesc", "542 — Cloud Walk (InfinityPay)", "403 — Cora", "133 — Cresol Confederação", "000 — EDP", "364 — Gerencianet", "077 — Inter", "341 — Itaú", "401 — Iugu", "383 — Juno", "323 — Mercado Pago", "389 — Mercantil", "237 — Next", "260 — Nubank", "212 — Original", "290 — PagSeguro", "509 — Paytime", "633 — Rendimento", "422 — Safra", "033 — Santander", "756 — Sicoob", "748 — Sicredi", "637 — Sofisa", "197 — Stone Pagamentos", "136 — Unicred", "655 — Votorantim" ] }, "codCaixa" : { "type" : "integer", "format" : "int32" }, "codConta" : { "type" : "integer", "format" : "int32" }, "codLiquidacao" : { "type" : "integer", "format" : "int64" }, "codTipoLiquidacao" : { "type" : "integer", "format" : "int32" }, "dataCredito" : { "type" : "string" }, "dataEstorno" : { "type" : "string" }, "dataLiquidacao" : { "type" : "string" }, "desconto" : { "type" : "number" }, "descricaoCaixa" : { "type" : "string" }, "descricaoConta" : { "type" : "string" }, "despesas" : { "type" : "number" }, "juros" : { "type" : "number" }, "multa" : { "type" : "number" }, "nomeEstornador" : { "type" : "string" }, "nomeLiquidante" : { "type" : "string" }, "nomeTipoLiquidacao" : { "type" : "string" }, "observacao" : { "type" : "string" }, "total" : { "type" : "number" }, "valor" : { "type" : "number" } } }, "TituloOutputTO" : { "type" : "object", "properties" : { "beneficios" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TituloBeneficioOutputTO" } }, "boletos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TituloBoletoOutputTO" } }, "classificacao" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TituloClassificacaoOutputTO" } }, "codLoja" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codTipoTitulo" : { "type" : "integer", "format" : "int32" }, "codTitulo" : { "type" : "integer", "format" : "int64" }, "cpfCnpjPessoa" : { "type" : "string" }, "dataCancelamento" : { "type" : "string" }, "dataEmissao" : { "type" : "string" }, "dataLancamento" : { "type" : "string" }, "dataVencimento" : { "type" : "string" }, "descricao" : { "type" : "string" }, "liquidacoes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TituloLiquidacaoOutputTO" } }, "nomeLoja" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "nomeTipoTitulo" : { "type" : "string" }, "nomeUsuarioCadastro" : { "type" : "string" }, "nomeUsuarioCancelamento" : { "type" : "string" }, "observacao" : { "type" : "string" }, "pix" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PixOutputTO" } }, "situacao" : { "type" : "string", "enum" : [ "Aberto", "Pendente", "Liquidado", "Cancelado", "Protestado", "Rejeitado", "Agrupado", "Negociado" ] }, "tipoLancamento" : { "type" : "string", "enum" : [ "Débito", "Crédito", "Rateio" ] }, "tipoPessoa" : { "type" : "string", "enum" : [ "Associado", "Representante", "Consultor", "Fornecedor", "Terceiro", "Empresa", "Médico", "Clínica", "Técnico", "Parceiro", "Lead" ] }, "urlFatura" : { "type" : "string" }, "valor" : { "type" : "number" } } }, "ValidacaoBeneficioInputTO" : { "type" : "object", "description" : "Parâmetro para a pesquisa de benefício. Pode ser informado o CPF/CNPJ ou o número do cartão de benefícios.", "properties" : { "matricula" : { "type" : "string" }, "sequencial" : { "type" : "integer", "format" : "int32" } } }, "ValidacaoBeneficioOutputTO" : { "type" : "object", "description" : "Retorna o status do benefício e dados básicos do beneficiário.", "properties" : { "cpf" : { "type" : "string" }, "dataCadastro" : { "type" : "string" }, "matricula" : { "type" : "string" }, "nome" : { "type" : "string" }, "sequencial" : { "type" : "integer", "format" : "int32" }, "status" : { "type" : "string" } } }, "VistoriaOutputTO" : { "type" : "object", "properties" : { "categoria" : { "type" : "string", "enum" : [ "Motocicleta", "Leve", "Utilitário", "Pickup", "Caminhão", "Ônibus", "Outro", "Bicicleta" ] }, "checkList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CampoAdicionalOutputTO" } }, "codBeneficio" : { "type" : "integer", "format" : "int32" }, "codPessoa" : { "type" : "integer", "format" : "int32" }, "codTipo" : { "type" : "integer", "format" : "int32" }, "codVistoria" : { "type" : "integer", "format" : "int32" }, "codVistoriador" : { "type" : "integer", "format" : "int32" }, "dataConclusao" : { "type" : "string" }, "dataExpiracaoLink" : { "type" : "string" }, "dataFinalizacao" : { "type" : "string" }, "dataRejeicao" : { "type" : "string" }, "dataSolicitacao" : { "type" : "string" }, "descricaoBeneficio" : { "type" : "string" }, "fotos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CriacaoVistoriaOutputFotoTO" } }, "link" : { "type" : "string" }, "motivoRejeicao" : { "type" : "string" }, "nomePessoa" : { "type" : "string" }, "nomeSolicitante" : { "type" : "string" }, "nomeTipo" : { "type" : "string" }, "nomeUsuarioRejeicao" : { "type" : "string" }, "nomeVistoriador" : { "type" : "string" }, "observacao" : { "type" : "string" }, "parecer" : { "type" : "string" }, "situacao" : { "type" : "string", "enum" : [ "Pendente", "Realizada", "Cancelada", "Finalizada", "Rejeitada" ] } } } }, "securitySchemes" : { "basic" : { "scheme" : "basic", "type" : "http" }, "bearer" : { "scheme" : "bearer", "type" : "http" } } } }