Esta documentação consolida a API do Qbem EB, organizada por domínios funcionais para facilitar a navegação, compreensão e manutenção das integrações.
\nBeneficiários
\nMovimentação
\nEstipulantes
\nContempla exclusivamente os recursos da API Qbem EB.
\nO Portal do Beneficiário não integra esta collection. Funcionalidades relacionadas devem ser documentadas separadamente.
\nO ambiente recomendado para início das integrações é o Sandbox de Testes, destinado a:
\nValidação de integrações
\nTestes funcionais
\nSimulação de cenários sem impacto em dados reais
\nMáximo de 12 requisições por minuto
\nNão é permitido paralelismo
\nRequisições concorrentes podem ser bloqueadas ou rejeitadas
\nIniciar a integração pelo ambiente de sandbox
\nValidar todos os fluxos antes da promoção para produção
\nGarantir que a variável .baseUrl esteja correta no ambiente ativo
Revisar variáveis de ambiente antes da execução das requisições
\nEvitar chamadas concorrentes
\nA utilização da API depende da configuração da variável de ambiente .baseUrl:
https://bd2946f1-ed8c-4cd6-94da-a49cd77f4c66.mock.pstmn.io\n\nEsta URL corresponde a um ambiente de sandbox.
Os dados disponibilizados são fictícios e não representam fluxos reais de negócio.
Seu objetivo é permitir testes, simulações e entendimento do processo de integração, sem impacto em ambientes produtivos.
\nUtilizar .baseUrl em todas as requisições
Evitar URLs fixas (hardcoded)
\nValidar o ambiente ativo antes de executar chamadas
\nPara acesso aos ambientes de desenvolvimento, homologação e produção, é necessário solicitar liberação junto ao suporte.
\nO acesso está sujeito à validação, podendo exigir:
\nIdentificação do sistema consumidor
\nFinalidade de uso
\nCredenciais de integração
\nContato:
suporte@qbem.net.br
Ambientes como homologação podem implicar custos adicionais.
A disponibilidade, condições de uso e eventuais cobranças devem ser previamente validadas com o suporte responsável.
Identificador do grupo econômico
\n"},{"key":"idEstipulante","value":"","type":"text","description":"Identificador da estipulante
\n"},{"key":"statusAtivo","value":"","description":"Filtra por status ativo ( boolean)
\n","type":"text"},{"key":"nome","value":"","type":"text","description":"Nome da estipulante
\n"},{"key":"classificacao","value":"","type":"text","description":"Classificação da estipulante
\n"},{"key":"idUsuarioCriacao","value":"","type":"text","description":"Usuário que criou o registro
\n"},{"key":"dataCriacaoDe","value":"","description":"Data inicial de criação (AAAA-MM-DD)
\n","type":"text"},{"key":"dataCriacaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"idUsuarioAlteracao","value":"","type":"text","description":"Usuário que alterou o registro
\n"},{"key":"dataAlteracaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataAlteracaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"NumPagina","value":"1","type":"text"},{"key":"QtdPagina","value":"100","type":"text"}]},"url":"{{.baseUrl}}/estipulanteapi/estipulantes","description":"Realiza a consulta de estipulantes cadastradas na plataforma.
A operação retorna os registros conforme os filtros informados no corpo da requisição.
Método: POST
Endpoint: .baseUrl/estipulanteapi/estipulantes
A requisição exige autenticação via headers obrigatórios:
\nmultipart/form-dataidEstipulante: 7413\nstatusAtivo: true\nNumPagina: 1\nQtdPagina: 100\n\nOperação exclusivamente de leitura.
\nUtiliza POST para envio estruturado de filtros.
A lista pode ser retornada vazia caso não existam registros.
\nCampos de data devem seguir padrão ISO 8601 (YYYY-MM-DD).
Identificador do grupo econômico
\n"},{"key":"idEstipulante","value":"1","type":"text","description":"Identificador da estipulante
\n"},{"key":"statusAtivo","value":"","description":"true / false
\n","type":"text"},{"key":"Nome","value":"","type":"text","description":"Nome da subestipulante
\n"},{"key":"idUsuarioCriacao","value":"","type":"text","description":"Usuário criação do registro
\n"},{"key":"DataCriacaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"DataCriacaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"idUsuarioAlteracao","value":"","type":"text","description":"Usuário alteração do registro
\n"},{"key":"DataAlteracaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"DataAlteracaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/Subestipulantes","description":"Realiza a consulta de subestipulantes vinculados a um estipulante.
A operação retorna os registros conforme os filtros informados no corpo da requisição.
Método: POST
Endpoint: .baseUrl/EstipulanteApi/Subestipulantes
A requisição exige autenticação via headers obrigatórios:
\nmultipart/form-dataidEstipulante: 7413\nstatusAtivo: true\nNumPagina: 1\nQtdPagina: 100\n\nOperação exclusivamente de leitura..
\nUtiliza POST para envio estruturado de filtros.
Campos devem ser enviados como form-data, não JSON.
A lista pode ser retornada vazia caso não existam registros.
\nFiltra pelo grupo econômico
\n"},{"key":"idEstipulante","value":"1","type":"text","description":"Filtra pela estipulante
\n","disabled":true},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pela subestipulante
\n"},{"key":"idOperadora","value":"","type":"text","description":"Filtra pela operadora
\n"},{"key":"idContrato","value":"","type":"text","description":"Filtra por um contrato específico
\n"},{"key":"idEstruturaEmpresarial","value":"","type":"text","description":"Filtra pela estrutura empresarial
\n"},{"key":"vigenciaFinalContratoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"vigenciaFinalContratoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataVencimentoDe","value":"","type":"text","description":"AAAA-MM-DD
\n"},{"key":"dataVencimentoAte","value":"","type":"text","description":"AAAA-MM-DD
\n"},{"key":"exibirContratosAtivos","value":"","description":"true / false
\n","type":"text"},{"key":"idTipoCliente","value":"","description":"1 - EMPRESARIAL / 2 - PME / 3 - INDIVIDUAL
\n","type":"text"},{"key":"classificacao","value":"","type":"text","description":"Classificação do contrato
\n"},{"key":"idContratoConjugadoLider","value":"","type":"text","description":"Contrato conjugado líder
\n"},{"key":"idUsuarioCriacao","value":"","type":"text","description":"Usuário de criação
\n"},{"key":"dataCriacaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataCriacaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"idUsuarioAlteracao","value":"","type":"text","description":"Usuário de alteração
\n"},{"key":"dataAlteracaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataAlteracaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/Contratos","description":"Realiza a consulta de contratos cadastrados no domínio de estipulantes, com base nos filtros enviados na requisição. A operação é exclusivamente de leitura, apesar do uso do método POST.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/Contratos
Formato: multipart/form-data
\nOperação exclusivamente de leitura
\nParâmetros enviados como formulário (não JSON)
\nCampos não informados não são considerados como filtro
\nPaginação obrigatória via NumPagina e QtdPagina
\nFiltra pelo grupo econômico
\n"},{"key":"idEstipulante","value":"1","type":"text","description":"Filtra pela estipulante
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pela subestipulante
\n"},{"key":"idOperadora","value":"","type":"text","description":"Filtra pela operadora
\n"},{"key":"idContrato","value":"","type":"text","description":"Filtra pelo contrato
\n"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/Elegibilidades","description":"Realiza a consulta de elegibilidades vinculadas ao domínio de estipulantes, com base nos filtros enviados na requisição. A operação é exclusivamente de leitura, apesar do uso do método POST.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/Elegibilidades
Formato: multipart/form-data
\nOperação exclusivamente de leitura
\nOs parâmetros devem ser enviados como formulário, não como JSON
\nCampos não informados não são considerados como filtro
\nA paginação deve ser controlada por NumPagina e QtdPagina
Lista de identificadores de faturamento
\n"},{"key":"idGrupoEconomico","value":"","type":"text","description":"Filtra pelo grupo econômico
\n"},{"key":"idEstipulante","value":"","type":"text","description":"Filtra pela estipulante
\n"},{"key":"idOperadora","value":"","type":"text","description":"Filtra pela operadora
\n"},{"key":"idProduto","value":"","description":"1 - ASSISTÊNCIA MÉDICA / 2 - ASSISTÊNCIA ODONTOLÓGICA / 3 - SEGURO DE VIDA / 4 - PREVIDÊNCIA PRIVADA / 5 - AUXÍLIO REFEIÇÃO / 6 - AUXÍLIO ALIMENTAÇÃO / 7 - AUXÍLIO TRANSPORTE / 8 - AUXÍLIO COMBUSTÍVEL / 10 - ASSISTÊNCIA FUNERAL / 13 - PRESTAMISTA / 14 - AUXÍLIO FARMÁCIA / 15 - PCMSO / 16 - SEGURO DE VIDA INDIVIDUAL / 17 - GYMPASS / 18 - PROGRAMA DE ASSISTÊNCIA E APOIO / 19 - ACIDENTES PESSOAIS / 20 - SEGURO VIAGEM / 22 - PASI / 25 - ACIDENTES PESSOAIS MOTORISTA / 26 - VIDA EM GRUPO / 29 - REMUNERAÇÃO FIXA / 30 - REMUNERAÇÃO VARIÁVEL / 31 - VALE CULTURA / 32 - VALE ANIVERSÁRIO / 33 - CESTA DE NATAL / 34 - SUBSÍDIO ACADEMIA / 35 - SUBSÍDIO EDUCAÇÃO / 36 - SUBSÍDIO IDIOMAS / 37 - AUXÍLIO CRECHE / 38 - ESTACIONAMENTO / 39 - PLR / 40 - BÔNUS / 41 - PREMIAÇÃO / 42 - AUXILIO DRESS CODE / 43 - TESTE COVID-19 / 44 - COLETA IN COMPANY / 45 - EXAME OCUPACIONAL / 46 - CHECK UP / 47 - CARTÃO SERVIÇOS MEDICINA COMPLEMENTAR / 59 - PRONTO ATENDIMENTO DIGITAL / 60 - GERENCIAMENTO DE CRÔNICOS / 64 - OPERACIONAL - SUBSÍDIO / 65 - FOLHA DE PAGAMENTO / 66 - CONCIERGE CX / 67 - PET / 68 - ACIDENTES PESSOAIS PASSAGEIRO COLETIVO / 69 - SEGURO HABITACIONAL EM APÓLICES DE MERCADO - MIP / 71 - DANOS CORPORAIS E/OU MATERIAIS CAUSADOS A PASSAGEI / 72 - DANOS MORAIS CAUSADOS A PASSAGEIROS / 74 - TELEMEDICINA / 75 - MASSAGEM IN COMPANY / 76 - AUXÍLIO ACADEMIA / 78 - CESTA BÁSICA
\n","type":"text"},{"key":"idContrato","value":"","type":"text","description":"Filtra pelo contrato
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pela subestipulante
\n"},{"key":"idFaturamentoTipo","value":"","description":"1 - PRÊMIO / 2 - PRÊMIO 2 / 3 - PRÊMIO AVULSO / 4 - COPARTICIPAÇÃO / 5 - COPARTICIPAÇÃO 2 / 6 - COPARTICIPAÇÃO AVULSO / 7 - CUSTO OPERACIONAL / 8 - CUSTO OPERACIONAL AVULSO / 9 - RECEBIMENTO SINISTRO / 10 - RECEBIMENTO SINISTRO AVULSO / 11 - REAJUSTE RETROATIVO / 12 - RECUPERAÇÃO DE SINISTRO / 13 - RECUPERAÇÃO DE SINISTRO AVULSO / 14 - PRÊMIO 3 / 15 - DESPESAS DE FARMÁCIA / 16 - TAXA ANS / 17 - TAXA DE MANUTENÇÃO / 18 - DESPESAS OPERACIONAIS / 19 - DESP. OPERACIONAIS-REEMBOLSO / 20 - SEGURO VIAGEM / 21 - UTILIZAÇÃO 1ª QUINZENA / 22 - UTILIZAÇÃO 2ª QUINZENA / 23 - UTILIZAÇÃO 3ª QUINZENA / 24 - FATURA COMPLEMENTAR / 26 - PRÊMIO AGRUPADO
\n","type":"text"},{"key":"idProdutor","value":"","type":"text","description":"Identificador do produtor
\n"},{"key":"dataCompetenciaDe","value":"","description":"MM/AAAA
\n","type":"text"},{"key":"dataCompetenciaAte","value":"","description":"MM/AAAA
\n","type":"text"},{"key":"FiltroData","value":"0","description":"0 - NENHUM / 1 - DATA CORTE / 2 - DATA LIBERAÇÃO DA FATURA / 3 - DATA DE VENCIMENTO DA FATURA / 4 - DATA DA EMISSÃO DA FATIRA
\n","type":"text"},{"key":"dataDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"filtrofaturaConferida","value":"","description":"true / false
\n","type":"text"},{"key":"filtroFaturaQuitada","value":"","description":"true / false
\n","type":"text"},{"key":"filtroFaturaProrrogada","value":"","description":"true / false
\n","type":"text"},{"key":"classificacao","value":"","type":"text","description":"Classificação do faturamento
\n"},{"key":"idUsuarioCriacao","value":"","type":"text","description":"Usuário de criação
\n"},{"key":"dataCriacaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataCriacaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"idUsuarioAlteracao","value":"","type":"text","description":"Usuário de alteração
\n"},{"key":"dataAlteracaoDe","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"dataAlteracaoAte","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"inicioVigencia","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"finalVigencia","value":"","description":"AAAA-MM-DD
\n","type":"text"},{"key":"idRoboLogTipo","value":"","description":"0 - NENHUM / 1 - LOGIN INVÁLIDO / 2 - COMANDO INVÁLIDO / 3 - CONTRATO NÃO ENCONTRADO / 4 - EMPRESA NÃO ENCONTRADA / 5 - ANO/MÊS NÃO ENCONTRADO / 6 - DOWNLOAD / 7 - INCOMPLETO / 8 - SENHA NÃO CONFIGURADA / 9 - OPERADORA NÃO ENCONTRADA / 10 - LOGIN INDISPONIVEL / 11 - COD. SUBESTIPULANTE DIVERGENTE / 90 - COMPLETO-KIT CONCLUÍDO / 98 - INDISPONÍVEL / 99 - ERRO DE EXECUÇÃO
\n","type":"text"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/Faturamentos","description":"Realiza a consulta de faturamentos vinculados ao estipulante, com base nos filtros enviados na requisição. A operação é exclusivamente de leitura, apesar do uso do método POST.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/Faturamentos
Formato: multipart/form-data
\nID Produto
\nID do tipo de Faturamentro
\nFiltro Data
\nOperação exclusivamente de leitura
\nOs parâmetros devem ser enviados como formulário, não como JSON
\nCampos não informados não são considerados como filtro
\nA paginação deve ser controlada por NumPagina e QtdPagina
Filtra os reembolsos pelo Id
\n"},{"key":"idBeneficiarioSolicitante","value":"","type":"text","description":"Filtra pelo id do beneficiario solicitance
\n"},{"key":"idGrupoEconomico","value":"","type":"text","description":"Filtra pelo grupo economico
\n"},{"key":"idEstipulante","value":"","type":"text","description":"Filtra pela estipulante
\n"},{"key":"Nome","value":"","type":"text","description":"Filtra pelo nome
\n"},{"key":"Protocolo","value":"","type":"text","description":"Filtra pelo protocolo
\n"},{"key":"StatusReembolso","value":"","description":"1 - AGUARDANDO ANÁLISE INTERNA / 2 - AGUARDANDO RETORNO DA SEGURADORA / 3 - PENDÊNCIA DE DOCUMENTOS / 4 - REEMBOLSO PAGO / 5 - REEMBOLSO NÃO APROVADO / 6 - CANCELADO / 7 - DEVOLVIDO / 8 - FINALIZADO / 9 - DEVOLVIDO PARA REGULARIZAÇÃO
\n","type":"text"},{"key":"DataSolicitacaoDe","value":"","type":"text","description":"Filtra pelo inicio da data de solicitação
\n"},{"key":"DataSolicitacaoAte","value":"","type":"text","description":"Filtra pelo fim da data de solicitação
\n"},{"key":"DataRetornoDe","value":"","description":"Filtra pelo inicio do retorno
\n","type":"text","uuid":"b7430628-3b95-4102-ba00-45ff7b67a7a8"},{"key":"DataRetornoAte","value":"","description":"Filtra pelo fim do retorno
\n","type":"text","uuid":"706c8246-671d-4335-b904-75620a79e977"},{"key":"NaoVisualizadas","value":"","description":"true / false
\n","type":"text"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"10","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/Reembolsos","description":"Realiza a consulta de reembolsos.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/Reembolsos
Formato: multipart/form-data
\nInformar o ID do Grupo Econômico associado a estipulante do contrato pesquisado.
\n","type":"text"},{"key":"idEstipulante","value":"","description":"Informar o ID da Estipulante do contrato pesquisado.
\n","type":"text"},{"key":"idSubestipulante","value":"","description":"Informar o ID da Subestipulante associada ao contrato pesquisado.
\n","type":"text"},{"key":"idOperadora","value":"","description":"Informar o ID da Operadora referente ao contrato pesquisado
\n","type":"text"},{"key":"idContrato","value":"","description":"Informar o ID do contrato pesquisado
\n","type":"text"},{"key":"vigenciaFinalContratoDe","value":"","description":"Informar o período inicial de pesquisa dos contratos que tem final de vigência programado a partir desta data (AAAA-MM-DD)
\n","type":"text"},{"key":"vigenciaFinalContratoAte","value":"","description":"Informar o período final de pesquisa dos contratos que tem final de vigência programado até esta data (AAAA-MM-DD)
\n","type":"text"},{"key":"exibirContratosAtivos","value":"","description":"Exibição de registros de reajuste de contratos ativos/inativos\nTrue / False
\n","type":"text"},{"key":"idTipoCliente","value":"","type":"text","description":"Informar o ID do tipo de cliente informado no contrato pesquisado.\n1 - EMPRESARIAL / 2 - PME / 3 - INDIVIDUAL / 4 - FAMILIAR / 5 - ADESÃO
\n"},{"key":"idClassificacao","value":"","description":"Informar o ID da classificação atribuída a estipulante do contrato pesquisado.
\n","type":"text"},{"key":"NumPagina","value":"1","description":"Informar qual página de resultados deve ser exibida no retorno da pesquisa.
\n","type":"text"},{"key":"QtdPagina","value":"100","description":"Informar a quantidade de registros exibidos na página solicitada, limitado ao número de 100 registros.
\n","type":"text"}]},"url":"{{.baseUrl}}/EstipulanteApi/Reajustes","description":"Realiza a consulta dos reajustes de um contrato.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/Reajustes
A requisição exige autenticação via headers obrigatórios:
\nFormato: multipart/form-data
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","uuid":"90386f18-eb62-44a5-bfad-6facb7bc6bdb","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"NumPagina","value":"1","type":"text","uuid":"26f67fe7-f3aa-450e-a469-278312587567","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","uuid":"d82fc24d-6069-407a-9a8e-fb8c7813afac","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/FaturamentosExcluidos","description":"Realiza a consulta de faturamentos excluídos.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/FaturamentosExcluidos
Formato: multipart/form-data
\nO intervalo das datas não pode ser maior do que 60 dias.
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","uuid":"90386f18-eb62-44a5-bfad-6facb7bc6bdb","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"NumPagina","value":"1","type":"text","uuid":"26f67fe7-f3aa-450e-a469-278312587567"},{"key":"QtdPagina","value":"100","type":"text","uuid":"d82fc24d-6069-407a-9a8e-fb8c7813afac"}]},"url":"{{.baseUrl}}/EstipulanteApi/EstipulantesExcluidas","description":"Realiza a consulta de estipulantes excluídas.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/EstipulantesExcluidas
Formato: multipart/form-data
\nO intervalo das datas não pode ser maior do que 60 dias.
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","uuid":"90386f18-eb62-44a5-bfad-6facb7bc6bdb","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"NumPagina","value":"1","type":"text","uuid":"26f67fe7-f3aa-450e-a469-278312587567","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","uuid":"d82fc24d-6069-407a-9a8e-fb8c7813afac","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/SubestipulantesExcluidas","description":"Realiza a consulta de subestipulantes excluídas.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/SubestipulantesExcluidas
Formato: multipart/form-data
\nO intervalo das datas não pode ser maior do que 60 dias.
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","uuid":"90386f18-eb62-44a5-bfad-6facb7bc6bdb","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"NumPagina","value":"1","type":"text","uuid":"26f67fe7-f3aa-450e-a469-278312587567","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","uuid":"d82fc24d-6069-407a-9a8e-fb8c7813afac","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/EstipulanteApi/ContratosExcluidos","description":"Realiza a consulta de contratos excluídos.
\nMétodo: POST
Endpoint: .baseUrl/EstipulanteApi/ContratosExcluidos
Formato: multipart/form-data
\nO intervalo das datas não pode ser maior do que 60 dias.
\nEsta pasta reúne as requisições de consulta relacionadas aos estipulantes, permitindo consultar dados cadastrais, elegibilidade e demais informações associadas a esse domínio. Seu objetivo é centralizar endpoints de leitura e validação, facilitando o acesso às informações necessárias para análise, conferência e suporte às operações da API.
\n","_postman_id":"ba113492-7dd8-4b35-a5c4-a7a894fc9d35"}],"id":"f399d0ec-ac27-4064-a7ae-edfbda4d4adc","description":"API de consulta para acesso a dados relacionados a estipulantes e entidades associadas.
\nEsta coleção reúne endpoints destinados à consulta de informações de estipulantes, subestipulantes, contratos, elegibilidades, faturamentos, reembolsos e reajustes. Também contempla consultas de registros excluídos.
\nOs recursos disponíveis nesta coleção são voltados à recuperação de dados para integração, conferência e acompanhamento operacional, preservando a estrutura já existente dos endpoints. De forma complementar, a coleção permite consultar bases históricas ou registros marcados como excluídos quando aplicável.
\nEscopo principal da coleção:
\nConsulta de estipulantes
\nConsulta de subestipulantes
\nConsulta de contratos
\nConsulta de elegibilidades
\nConsulta de faturamentos
\nConsulta de reembolsos
\nConsulta de reajustes
\nConsulta de registros excluídos de estipulantes, subestipulantes, contratos e faturamentos
\nEsta documentação tem como objetivo facilitar o entendimento funcional dos endpoints de consulta, sem alterar seus nomes, estrutura, métodos, URLs ou payloads existentes.
\n","_postman_id":"f399d0ec-ac27-4064-a7ae-edfbda4d4adc"},{"name":"Movimentação","item":[{"name":"Envios","item":[{"name":"Movimentação por lote","event":[{"listen":"test","script":{"id":"1c7dcafc-54ae-4620-9bb3-99d6c9b54616","exec":["const status = pm.response.code;","const contentType = (pm.response.headers.get('Content-Type') || '').toLowerCase();","const responseText = pm.response.text();","const isLikelyJson = contentType.includes('application/json') || /^[\\s\\r\\n]*[\\[{]/.test(responseText);","","let jsonData = null;","if (isLikelyJson && responseText) {"," try {"," jsonData = pm.response.json();"," } catch (e) {"," jsonData = null;"," }","}","","const successStatuses = [200, 201, 202];","const errorStatuses = [400, 401, 403, 404, 409, 422, 500];","","function isObject(value) {"," return value !== null && typeof value === 'object' && !Array.isArray(value);","}","","function findFirstValueDeep(input, candidateKeys) {"," const seen = new WeakSet();"," const normalizedKeys = candidateKeys.map(k => String(k).toLowerCase());",""," function walk(value) {"," if (value === null || value === undefined) return undefined;",""," if (Array.isArray(value)) {"," for (const item of value) {"," const found = walk(item);"," if (found !== undefined && found !== null && found !== '') return found;"," }"," return undefined;"," }",""," if (typeof value !== 'object') return undefined;"," if (seen.has(value)) return undefined;"," seen.add(value);",""," for (const key of Object.keys(value)) {"," const normalizedKey = key.toLowerCase();"," if (normalizedKeys.includes(normalizedKey)) {"," const candidate = value[key];"," if (candidate !== undefined && candidate !== null && candidate !== '') {"," return candidate;"," }"," }"," }",""," for (const key of Object.keys(value)) {"," const found = walk(value[key]);"," if (found !== undefined && found !== null && found !== '') return found;"," }",""," return undefined;"," }",""," return walk(input);","}","","function hasAnyKeyDeep(input, candidateKeys) {"," const seen = new WeakSet();"," const normalizedKeys = candidateKeys.map(k => String(k).toLowerCase());",""," function walk(value) {"," if (value === null || value === undefined) return false;",""," if (Array.isArray(value)) {"," return value.some(walk);"," }",""," if (typeof value !== 'object') return false;"," if (seen.has(value)) return false;"," seen.add(value);",""," for (const key of Object.keys(value)) {"," if (normalizedKeys.includes(key.toLowerCase())) return true;"," }",""," return Object.keys(value).some(key => walk(value[key]));"," }",""," return walk(input);","}","","const idKeys = ["," 'idArquivo', 'arquivoId', 'id_arquivo', 'idarquivo',"," 'idCarga', 'cargaId', 'id_carga', 'idcarga',"," 'idImportacao', 'importacaoId', 'id_importacao',"," 'protocolo', 'codigo', 'id'","];","","const messageKeys = ["," 'message', 'mensagem', 'messages', 'mensagens',"," 'error', 'erro', 'errors', 'detalhe', 'detail',"," 'descricao', 'description', 'title'","];","","pm.test('Status HTTP dentro do esperado para upload', function () {"," pm.expect(successStatuses.concat(errorStatuses)).to.include(status);","});","","pm.test('Tempo de resposta abaixo de 30s', function () {"," pm.expect(pm.response.responseTime).to.be.below(30000);","});","","if (successStatuses.includes(status)) {"," pm.test('Resposta de sucesso não está vazia', function () {"," pm.expect(responseText).to.be.a('string').and.not.empty;"," });",""," pm.test('Resposta de sucesso possui conteúdo interpretável', function () {"," const hasStructuredJson = jsonData !== null && (isObject(jsonData) || Array.isArray(jsonData));"," const hasPrimitiveBody = responseText.trim().length > 0;"," pm.expect(hasStructuredJson || hasPrimitiveBody).to.equal(true);"," });",""," if (isLikelyJson) {"," pm.test('Quando aplicável, retorno JSON é válido', function () {"," pm.expect(jsonData, 'Corpo indicava JSON, mas não foi possível fazer parse').to.not.equal(null);"," });"," }",""," if (jsonData !== null) {"," pm.test('Retorno JSON possui estrutura mínima útil', function () {"," const hasTopLevelContent ="," (isObject(jsonData) && Object.keys(jsonData).length > 0) ||"," (Array.isArray(jsonData) && jsonData.length > 0);"," pm.expect(hasTopLevelContent).to.equal(true);"," });"," }",""," let extractedId;",""," if (jsonData !== null) {"," extractedId = findFirstValueDeep(jsonData, idKeys);"," }",""," if ((extractedId === undefined || extractedId === null || extractedId === '') && responseText) {"," const plainIdMatch = responseText.match(/\\b\\d{1,20}\\b/);"," if (plainIdMatch) {"," extractedId = plainIdMatch[0];"," }"," }",""," pm.test('Resposta de sucesso contém identificador da importação/arquivo quando disponível', function () {"," const hasIdInJson = jsonData !== null && hasAnyKeyDeep(jsonData, idKeys);"," const hasPlainNumericBody = /^\\s*\\d+\\s*$/.test(responseText);"," pm.expect(hasIdInJson || hasPlainNumericBody || extractedId !== undefined).to.equal(true);"," });",""," if (extractedId !== undefined && extractedId !== null && extractedId !== '') {"," const extractedIdString = String(extractedId).trim();"," pm.collectionVariables.set('idArquivo', extractedIdString);"," pm.collectionVariables.set('idArquivoImportado', extractedIdString);"," pm.environment.set('idArquivo', extractedIdString);"," pm.environment.set('idArquivoImportado', extractedIdString);",""," if (/^\\d+$/.test(extractedIdString)) {"," pm.collectionVariables.set('idCarga', extractedIdString);"," pm.environment.set('idCarga', extractedIdString);"," }",""," pm.test('Identificador retornado foi persistido para próximas etapas', function () {"," pm.expect(pm.collectionVariables.get('idArquivo') || pm.environment.get('idArquivo')).to.eql(extractedIdString);"," });"," }","}","","if (!successStatuses.includes(status)) {"," pm.test('Resposta de erro foi tratada sem quebra de parse', function () {"," pm.expect(true).to.equal(true);"," });",""," pm.test('Resposta de erro contém alguma informação diagnóstica', function () {"," const hasText = typeof responseText === 'string' && responseText.trim().length > 0;"," const hasMessageInJson = jsonData !== null && hasAnyKeyDeep(jsonData, messageKeys);"," pm.expect(hasText || hasMessageInJson).to.equal(true);"," });",""," if (status === 401 || status === 403) {"," pm.test('Erro de autenticação identificado corretamente', function () {"," pm.expect([401, 403]).to.include(status);"," });"," }",""," if (status === 404) {"," pm.test('Erro 404 tratado para endpoint/recurso não encontrado', function () {"," pm.expect(status).to.equal(404);"," });"," }",""," if (status >= 500) {"," pm.test('Erro de servidor identificado', function () {"," pm.expect(status).to.be.at.least(500);"," });"," }",""," if (jsonData !== null) {"," pm.test('JSON de erro, quando presente, possui estrutura mínima', function () {"," const hasAnyContent ="," (isObject(jsonData) && Object.keys(jsonData).length > 0) ||"," (Array.isArray(jsonData) && jsonData.length > 0);"," pm.expect(hasAnyContent).to.equal(true);"," });"," }","}","","pm.test('Headers essenciais da request estão configurados', function () {"," pm.expect(pm.request.headers.has('email')).to.equal(true);"," pm.expect(pm.request.headers.has('senha')).to.equal(true);","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"e5413646-cba8-4820-8607-53663462c5ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"email","value":"{{user_email}}","description":"email do usuario
\n"},{"key":"senha","value":"{{user_pass}}","description":"senha do usuario
\n"}],"body":{"mode":"formdata","formdata":[{"key":"idEstipulante","value":"{{estipulante_id}}","type":"text","description":"Id da estipulante
\n"},{"key":"idTipoArquivo","value":"1","type":"text","description":"1 - Arquivo Qbem
\n"},{"key":"TipoLayout","value":"1","type":"text","description":"1 - Movimentacao
\n"},{"key":"idTiposLayoutMovimentacao","value":"1","type":"text","description":"1 - Movimentacao
\n"},{"key":"Arquivo","type":"file","value":null}]},"url":"{{.baseUrl}}/MovimentacaoApi/Carregar","description":"Realiza o envio de um arquivo de movimentação em lote para a plataforma QBem EB, iniciando o processo de importação, validação e preparação dos registros para processamento.
\nEste endpoint representa o primeiro passo do fluxo de movimentação por arquivo, sendo utilizado para cargas em massa de beneficiários conforme o layout aceito pela plataforma.
\nMétodo: POST
URL: {{.baseUrl}}/MovimentacaoApi/Carregar
A autenticação é enviada por meio dos headers:
\nemail: {{user_email}}
senha: {{user_pass}}
Esta operação deve ser enviada como multipart/form-data.
Envie os seguintes campos no corpo da requisição:
\nidEstipulante: identificador do estipulante responsável pela carga.
idTipoArquivo: tipo do arquivo enviado.
TipoLayout: tipo de layout utilizado no arquivo.
idTiposLayoutMovimentacao: identificador do layout de movimentação.
Arquivo: arquivo de movimentação a ser importado.
Ao receber a requisição:
\na API processa o upload do arquivo de movimentação;
\nassocia a carga aos parâmetros informados;
\ninicia a etapa de importação e validação;
\nretorna o identificador do arquivo importado para consultas e etapas posteriores do fluxo.
\nUtilize este endpoint quando for necessário realizar movimentações em lote por arquivo, como inclusões, alterações ou outras atualizações em massa suportadas pelo layout da integração.
\nEsse endpoint é indicado para cenários em que o processamento ocorre a partir de um arquivo estruturado, em vez de operações individuais por registro.
\nApós o envio bem-sucedido do arquivo, o fluxo recomendado é:
\nConsultar o resumo inicial da importação.
\nConsultar o resumo completo para obter o detalhamento da validação e os identificadores necessários para continuidade.
\nValidar as linhas processadas, incluindo:
\nregistros com críticas;
\nregistros com aprovações pendentes;
\nregistros sem inconsistências.
\nConfirmar o carregamento dos beneficiários.
\nAcompanhar o progresso do processamento da carga.
\nO campo Arquivo deve ser enviado no formato aceito pelo layout da plataforma.
Os valores de idTipoArquivo, TipoLayout e idTiposLayoutMovimentacao devem estar compatíveis com o tipo de carga processada.
Certifique-se de que as variáveis {{.baseUrl}}, {{user_email}} e {{user_pass}} estejam corretamente configuradas no ambiente ativo.
Este endpoint inicia o fluxo, mas a conclusão do processamento depende das etapas subsequentes de consulta, validação e confirmação.
\nEste request já possui exemplos salvos para cenários como:
\nUnauthorized
Not found
Esses exemplos podem ser usados como referência para tratamento de erros e documentação complementar.
\n","urlObject":{"path":["MovimentacaoApi","Carregar"],"host":["{{.baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"e54bf252-fda0-4941-9e92-fe54d405e374","name":"OK","originalRequest":{"method":"POST","header":[{"key":"email","value":"{{user_email}}"},{"key":"senha","value":"{{user_password}}"}],"body":{"mode":"formdata","formdata":[{"key":"idEstipulante","value":"00000","type":"text","description":"Selecionar o arquivo de movimentação no formato de layout do QBem EB."},{"key":"idTipoArquivo","value":"1","type":"text","description":"Necessário informar o ID de cadastro da estipulante no QBem EB"},{"key":"TipoLayout","value":"1","type":"text","description":"Valor fixo pertinente ao tipo de arquivo necessário para o processo de movimentação via API."},{"key":"idTiposLayoutMovimentacao","value":"1","type":"text","description":"Valor fixo pertinente ao tipo de layout necessário para o processo de movimentação via API."},{"key":"Arquivo","type":"file","description":"Selecionar o arquivo de movimentação no formato de layout do QBem EB.","src":"/C:/Users/anderson.santos/Downloads/EB_movimentacao_layout_GoT_API_.xlsx"}]},"url":"{{.baseUrl}}/MovimentacaoApi/Carregar"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"148"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 21 Aug 2023 18:38:14 GMT"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Cache-Control","value":"private, s-maxage=0"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"idArquivo\": 211752\n}"},{"id":"89a07687-2ed5-4a48-b529-4e556c57b85b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"email","value":"{{USER_EMAIL}}"},{"key":"senha","value":"{{USER_PSWD}}"}],"body":{"mode":"formdata","formdata":[{"key":"Arquivo","value":"","type":"text"},{"key":"idEstipulante","value":"0001","type":"text"}]},"url":"{{.baseUrl}}/MovimentacaoApi/Carregar"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"content-type","value":"text/html; charset=utf-8"},{"key":"date","value":"Fri, 10 Apr 2026 18:10:18 GMT"},{"key":"access-control-expose-headers","value":"Request-Context"},{"key":"cache-control","value":"private,no-cache,no-store"},{"key":"content-encoding","value":"gzip"},{"key":"expires","value":"-1"},{"key":"pragma","value":"no-cache"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-length","value":"2626"},{"key":"strict-transport-security","value":"max-age=31536000;includeSubDomains"},{"key":"request-context","value":"appId=cid-v1:a3406252-0fb5-4a8b-8097-6753bad0bd63"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-option","value":"nosniff"}],"cookie":[],"responseTime":null,"body":"\r\n\r\n\n\n\n \n \n \nAgrupa os endpoints responsáveis pelo início do fluxo de movimentação de beneficiários, contemplando tanto o envio de arquivos em lote quanto movimentações individuais realizadas diretamente pela API.
\nUtilize esta pasta quando for necessário registrar inclusões ou alterações de beneficiários, seja por carga de arquivo para processamento em massa, seja por operações pontuais em tempo real.
\n","_postman_id":"fd28a7aa-92b5-4cf9-8946-b1fece6e9170"},{"name":"Consultas","item":[{"name":"Resumo do arquivo carregado","id":"4d2d5e69-6f99-44d9-9f57-26275b21b519","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"email","value":"{{user_email}}"},{"key":"senha","value":"{{user_pass}}"}],"body":{"mode":"formdata","formdata":[{"key":"idArquivo","value":"{{idArquivo}}","type":"text"}]},"url":"{{.baseUrl}}/MovimentacaoApi/ResumoArquivo","description":"Retorna um resumo das informações do arquivo importado, útil para uma visão geral rápida do resultado do carregamento.
\nUse este endpoint logo após o carregamento do arquivo para obter uma visão geral rápida do status da importação, antes de consultar os detalhes completos ou as linhas individuais.
\nResumo completo do arquivo carregado.Retorna as informações completas da validação do arquivo importado, incluindo o ID da carga, que é necessário para as etapas de confirmação do fluxo.
\nCarregamento dos beneficiários e Progresso de carregamento da carga).Use este endpoint quando precisar de uma análise aprofundada do resultado da importação, ou para obter o ID da carga necessário para prosseguir com a confirmação dos registros válidos.
\nResumo do arquivo carregado, este endpoint fornece o detalhamento completo necessário para o avanço no fluxo de movimentação.Retorna as linhas com críticas ou erros identificados durante a validação de uma carga, permitindo identificar os registros que precisam de correção antes da confirmação.
\nResumo completo do arquivo carregado).Use este endpoint para identificar e analisar os registros com problemas no arquivo importado. As linhas retornadas aqui não poderão ser confirmadas até que as inconsistências sejam corrigidas e o arquivo seja recarregado.
\nDownload do arquivo de inconsistências para exportar e corrigir os registros com erro externamente.Retorna as linhas que aguardam aprovação dentro de uma carga, indicando que é necessária uma ação antes de prosseguir com a confirmação.
\nResumo completo do arquivo carregado).Use este endpoint para identificar registros que estão aguardando aprovação e que bloqueiam o avanço do fluxo de movimentação. Esses registros precisam ser aprovados ou rejeitados antes que a carga possa ser totalmente confirmada.
\nPasso de confirmação do fluxo de movimentação. Este endpoint efetiva o carregamento dos registros válidos e sem inconsistências no QBem EB, tornando as movimentações definitivas na plataforma.
\nResumo completo do arquivo carregado).Use este endpoint após validar o arquivo e confirmar que os registros desejados estão sem inconsistências. Este é o passo que torna as movimentações definitivas no sistema.
\nProgresso de carregamento da carga para acompanhar em tempo real o andamento do processamento.{{URL_EB}} para apontar para o ambiente correto.Permite acompanhar em tempo real o progresso do carregamento dos beneficiários válidos após a confirmação via Carregamento dos beneficiários.
Resumo completo do arquivo carregado).Use este endpoint após acionar o Carregamento dos beneficiários para monitorar o progresso da operação. Pode ser consultado repetidamente até que o processamento seja concluído.
{{URL_EB}} para apontar para o ambiente correto.Retorna as linhas válidas e sem inconsistências de uma carga, ou seja, os registros que estão aptos para confirmação no QBem EB.
\nResumo completo do arquivo carregado).Use este endpoint para verificar quais registros estão válidos antes de prosseguir com a confirmação via Carregamento dos beneficiários. É uma boa prática consultar este endpoint para garantir que os dados corretos serão efetivados.
Carregamento dos beneficiários.Agrupa os endpoints responsáveis por consultar, validar e acompanhar o processamento das cargas de movimentação enviadas para o QBem EB.
\nUtilize esta pasta para obter resumos da importação, identificar linhas com críticas ou aprovações pendentes, verificar registros válidos para confirmação e acompanhar o progresso do carregamento dos beneficiários até a conclusão do processamento.
\n","_postman_id":"2be3a699-8c5e-4365-93bc-99b5f9559914"},{"name":"Downloads","item":[{"name":"Download do arquivo de inconsistências","id":"a8d87e44-b8eb-4967-a089-f4211c1e8d74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"email","value":"{{user_email}}","type":"text"},{"key":"senha","value":"{{user_password}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"idCarga","value":"{{idCarga}}","type":"text"}]},"url":"{{.baseUrl}}/MovimentacaoApi/DownloadArquivoInconsistencia","description":"Realiza o download do arquivo contendo todas as inconsistências identificadas durante a validação da carga, permitindo análise e correção externa dos registros com problema.
\nResumo completo do arquivo carregado).Use este endpoint quando precisar exportar os erros de validação para correção fora da plataforma. Após corrigir os dados no arquivo original, um novo carregamento deverá ser realizado.
\nLinhas com críticas, oferecendo uma forma de exportar os erros em formato de arquivo para facilitar a correção em lote.Agrupa os endpoints responsáveis pela exportação de arquivos gerados durante o processo de movimentação, especialmente os artefatos relacionados à validação das cargas enviadas.
\nUtilize esta pasta para baixar arquivos de apoio à análise e correção, como o arquivo de inconsistências retornado após a validação de uma carga.
\n","_postman_id":"86bec4d2-698c-4b06-bec7-e07e924e6256"}],"id":"b043d50f-fbb6-4109-aef2-2cbb875c1849","description":"Agrupa os endpoints responsáveis pelo fluxo de movimentação de beneficiários, incluindo envio de cargas em lote e alterações individuais, consultas de processamento e resumo dos arquivos carregados, além do download de arquivos de inconsistência.
\nUtilize esta pasta para acompanhar todo o ciclo de importação, validação e tratamento das movimentações.
\n","_postman_id":"b043d50f-fbb6-4109-aef2-2cbb875c1849"},{"name":"Beneficiários","item":[{"name":"Consultas","item":[{"name":"Consultar de Beneficiários","event":[{"listen":"test","script":{"id":"b2a9e089-b649-4364-8684-c45e05d3d9e3","exec":["const response = pm.response;","const responseText = response.text();","const contentType = (response.headers.get('Content-Type') || '').toLowerCase();","","function hasJsonBody() {"," return !!responseText && responseText.trim().length > 0;","}","","function isPlainObject(value) {"," return value !== null && typeof value === 'object' && !Array.isArray(value);","}","","function isNumericLike(value) {"," return typeof value === 'number' || (typeof value === 'string' && value.trim() !== '' && !Number.isNaN(Number(value)));","}","","function isValidCpf(value) {"," return typeof value === 'string' && /^\\d{3}\\.\\d{3}\\.\\d{3}-\\d{2}$/.test(value);","}","","function isValidDateYMD(value) {"," if (typeof value !== 'string' || !/^\\d{4}-\\d{2}-\\d{2}$/.test(value)) return false;"," const date = new Date(value + 'T00:00:00Z');"," return !Number.isNaN(date.getTime()) && date.toISOString().slice(0, 10) === value;","}","","function isValidIso8601(value) {"," if (typeof value !== 'string') return false;"," const isoLike = /^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?(?:Z|[+-]\\d{2}:?\\d{2})$/;"," if (!isoLike.test(value)) return false;"," const date = new Date(value);"," return !Number.isNaN(date.getTime());","}","","pm.test('Status code é 200', function () {"," pm.response.to.have.status(200);","});","","pm.test('Tempo de resposta é razoável (< 5000 ms)', function () {"," pm.expect(response.responseTime, 'tempo de resposta em ms').to.be.below(5000);","});","","let json;","let jsonParsed = false;","","pm.test('Corpo é parseável como JSON quando houver conteúdo', function () {"," if (!hasJsonBody()) {"," pm.expect(true).to.be.true;"," return;"," }",""," json = pm.response.json();"," jsonParsed = true;"," pm.expect(json).to.not.equal(undefined);","});","","pm.test('Content-Type indica JSON quando houver body JSON', function () {"," if (!hasJsonBody()) {"," pm.expect(true).to.be.true;"," return;"," }",""," if (!jsonParsed) {"," json = pm.response.json();"," jsonParsed = true;"," }",""," pm.expect(contentType, 'Content-Type').to.include('application/json');","});","","if (!jsonParsed && hasJsonBody()) {"," try {"," json = pm.response.json();"," jsonParsed = true;"," } catch (e) {"," // os testes acima já capturam falha de parsing"," }","}","","if (jsonParsed) {"," const dataArray = Array.isArray(json.data) ? json.data : null;",""," pm.test(\"'data' existe e é array\", function () {"," pm.expect(json).to.be.an('object');"," pm.expect(json).to.have.property('data');"," pm.expect(json.data, 'json.data').to.be.an('array');"," });",""," pm.test(\"'meta' é objeto quando presente\", function () {"," if (Object.prototype.hasOwnProperty.call(json, 'meta') && json.meta !== null) {"," pm.expect(isPlainObject(json.meta), 'json.meta').to.be.true;"," } else {"," pm.expect(true).to.be.true;"," }"," });",""," pm.test(\"'meta.total' é numérico quando presente\", function () {"," if (isPlainObject(json.meta) && Object.prototype.hasOwnProperty.call(json.meta, 'total')) {"," pm.expect(isNumericLike(json.meta.total), 'meta.total').to.be.true;"," } else {"," pm.expect(true).to.be.true;"," }"," });",""," pm.test(\"'meta.pagina' e 'meta.quantidadePorPagina' são numéricos quando presentes\", function () {"," if (isPlainObject(json.meta) && Object.prototype.hasOwnProperty.call(json.meta, 'pagina')) {"," pm.expect(isNumericLike(json.meta.pagina), 'meta.pagina').to.be.true;"," }"," if (isPlainObject(json.meta) && Object.prototype.hasOwnProperty.call(json.meta, 'quantidadePorPagina')) {"," pm.expect(isNumericLike(json.meta.quantidadePorPagina), 'meta.quantidadePorPagina').to.be.true;"," }"," });",""," pm.test('Estrutura alternativa documentada/legada é identificável quando não houver data/meta', function () {"," const hasCanonicalShape = Array.isArray(json.data);"," const hasLegacyShape = Array.isArray(json.Linhas) || Object.prototype.hasOwnProperty.call(json, 'TotalRegistros');"," pm.expect(hasCanonicalShape || hasLegacyShape, 'shape esperado ou shape legado').to.be.true;"," });",""," if (Array.isArray(dataArray) && dataArray.length > 0) {"," pm.test(\"Itens de 'data' respeitam tipos básicos e formatos documentados\", function () {"," dataArray.forEach(function (item, index) {"," pm.expect(isPlainObject(item), `data[${index}] deve ser objeto`).to.be.true;",""," pm.expect(item, `data[${index}]`).to.have.property('idBeneficiario');"," pm.expect(isNumericLike(item.idBeneficiario), `data[${index}].idBeneficiario`).to.be.true;",""," pm.expect(item, `data[${index}]`).to.have.property('nome');"," pm.expect(item.nome, `data[${index}].nome`).to.be.a('string');",""," pm.expect(item, `data[${index}]`).to.have.property('cpf');"," pm.expect(isValidCpf(item.cpf), `data[${index}].cpf`).to.be.true;",""," pm.expect(item, `data[${index}]`).to.have.property('dataNascimento');"," pm.expect(isValidDateYMD(item.dataNascimento), `data[${index}].dataNascimento`).to.be.true;",""," if (Object.prototype.hasOwnProperty.call(item, 'sexo') && item.sexo != null && item.sexo !== '') {"," pm.expect(['M', 'F'], `data[${index}].sexo`).to.include(item.sexo);"," }",""," if (Object.prototype.hasOwnProperty.call(item, 'email') && item.email != null && item.email !== '') {"," pm.expect(item.email, `data[${index}].email`).to.be.a('string');"," pm.expect(item.email, `data[${index}].email`).to.include('@');"," }",""," if (Object.prototype.hasOwnProperty.call(item, 'idEstipulante') && item.idEstipulante != null && item.idEstipulante !== '') {"," pm.expect(isNumericLike(item.idEstipulante), `data[${index}].idEstipulante`).to.be.true;"," }",""," if (Object.prototype.hasOwnProperty.call(item, 'status') && item.status != null && item.status !== '') {"," pm.expect(['ATIVO', 'INATIVO'], `data[${index}].status`).to.include(item.status);"," }",""," if (Object.prototype.hasOwnProperty.call(item, 'dataCadastro') && item.dataCadastro != null && item.dataCadastro !== '') {"," pm.expect(isValidIso8601(item.dataCadastro), `data[${index}].dataCadastro`).to.be.true;"," }"," });"," });"," } else {"," pm.test(\"Lista 'data' vazia não falha validações de campos de item\", function () {"," pm.expect(Array.isArray(json.data), 'json.data').to.be.true;"," pm.expect(json.data.length, 'quantidade de itens').to.be.at.least(0);"," });"," }","}"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ee4c65e7-5ce3-4504-9dc3-17197ad87e4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"email","value":"{{user_email}}"},{"key":"senha","value":"{{user_pass}}"}],"body":{"mode":"formdata","formdata":[{"key":"idEstipulante","value":"","type":"text","description":"Filtra pela estipulante
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pelo subestipulante
\n"},{"key":"idBeneficiarioTitular","value":"","type":"text","description":"Filtra pelo titular
\n"},{"key":"idGrauParentesco","value":"","type":"text","description":"Filtra pelo id do parentesco
\n"},{"key":"CPFTitular","value":"","type":"text","description":"Filtra pelo cpf do titular
\n"},{"key":"CPF","value":"","type":"text","description":"Filtra pelo cpf
\n"},{"key":"GrauParentesco","value":"","type":"text","description":"Filtra pelo nome do parentesto
\n"},{"key":"DataAlteracaoDe","value":"","type":"text","description":"Data inicial da alteração
\n"},{"key":"DataAlteracaoAte","value":"","type":"text","description":"Data final da alteração
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data inicial da criação
\n"},{"key":"DataCriacaoAte","value":"","type":"text","description":"Data final da criação
\n"},{"key":"CNPJEstipulante","value":"","type":"text","description":"Filtra pelo CNPJ da estipulante
\n"},{"key":"CNPJSubestipulante","value":"","type":"text","description":"Filtra pelo CNPJ da subestipulante
\n"},{"key":"CodigoEmpresa","value":"","type":"text","description":"Filtra pelo código da empresa da subestipulante
\n"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/BeneficiarioApi/Beneficiarios","description":"Realiza a consulta de beneficiários a partir do endpoint BeneficiarioApi/Beneficiarios.
Apesar de utilizar o método POST, esta operação é exclusivamente de leitura, retornando registros conforme os filtros informados no corpo da requisição.
Método: POST
Endpoint: .baseUrl/BeneficiarioApi/Beneficiarios
A requisição exige autenticação via headers obrigatórios:
\nFormato: multipart/form-data
\nContatoApiViewModelFiltra pela estipulante
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pelo subestipulante
\n"},{"key":"idBeneficiarioTitular","value":"","type":"text","description":"Filtra pelo titular
\n"},{"key":"idGrauParentesco","value":"","type":"text","description":"Filtra pelo id do parentesco
\n"},{"key":"CPFTitular","value":"","type":"text","description":"Filtra pelo cpf do titular
\n"},{"key":"CPF","value":"","type":"text","description":"Filtra pelo cpf
\n"},{"key":"GrauParentesco","value":"","type":"text","description":"Filtra pelo nome do parentesto
\n"},{"key":"DataAlteracaoDe","value":"","type":"text","description":"Data inicial da alteração
\n"},{"key":"DataAlteracaoAte","value":"","type":"text","description":"Data final da alteração
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data inicial da criação
\n"},{"key":"DataCriacaoAte","value":"","type":"text","description":"Data final da criação
\n"},{"key":"CNPJEstipulante","value":"","type":"text","description":"Filtra pelo CNPJ da estipulante
\n"},{"key":"CNPJSubestipulante","value":"","type":"text","description":"Filtra pelo CNPJ da subestipulante
\n"},{"key":"CodigoEmpresa","value":"","type":"text","description":"Filtra pelo código da empresa da subestipulante
\n"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/BeneficiarioApi/BeneficiariosCount","description":"Use este endpint para consultar a quantidade de beneficiarios que existem dentro dos filtros informados.
\nMétodo: POST
Endpoint: .baseUrl/BeneficiarioApi/BeneficiariosCount
A requisição exige autenticação via headers obrigatórios:
\nFormato: multipart/form-data
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"idBeneficiario","value":"","type":"text","description":"Filtra pelo ID do beneficiário
\n"},{"key":"idEstipulante","value":"","type":"text","description":"Filtra pela estipulante
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pela subestipulante
\n"},{"key":"idBeneficiarioTitular","value":"","type":"text","description":"Filtra pelo titular
\n"},{"key":"idGrauParentesco","value":"","type":"text","description":"Filtra pelo id do parentesco
\n"},{"key":"CPF","value":"","type":"text","description":"Filtra pelo cpf
\n"},{"key":"CPFTitular","value":"","type":"text","description":"Filtra pelo cpf do titular
\n"},{"key":"GrauParentesco","value":"","type":"text","description":"Filtra pelo nome do parentesto
\n"},{"key":"CNPJEstipulante","value":"","type":"text","description":"Filtra pelo CNPJ da estipulante
\n"},{"key":"CNPJSubestipulante","value":"","type":"text","description":"Filtra pelo CNPJ da subestipulante
\n"},{"key":"CodigoEmpresa","value":"","type":"text","description":"Filtra pelo código da empresa da subestipulante
\n"},{"key":"DataAlteracaoDe","value":"","type":"text","description":"Data inicial da alteração
\n"},{"key":"DataAlteracaoAte","value":"","type":"text","description":"Data final da alteração
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data inicial da criação
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data final da criação
\n"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/BeneficiarioApi/BeneficiariosExcluidos","description":"Realiza a consulta de beneficiários excluídos.
\nMétodo: POST
Endpoint: .baseUrl/BeneficiarioApi/BeneficiariosExcluidos
Formato: multipart/form-data
\nO intervalo das datas de exclusão não pode ser maior do que 60 dias.
\nFiltra pelo inicio da data de exclusão
\n"},{"key":"dataExclusaoAte","value":"31/05/2026","type":"text","description":"Filtra pelo fim da data de exclusão
\n"},{"key":"idBeneficiario","value":"","type":"text","description":"Filtra pelo ID do beneficiário
\n"},{"key":"idEstipulante","value":"","type":"text","description":"Filtra pela estipulante
\n"},{"key":"idSubestipulante","value":"","type":"text","description":"Filtra pela subestipulante
\n"},{"key":"idBeneficiarioTitular","value":"","type":"text","description":"Filtra pelo titular
\n"},{"key":"idGrauParentesco","value":"","type":"text","description":"Filtra pelo id do parentesco
\n"},{"key":"CPF","value":"","type":"text","description":"Filtra pelo cpf
\n"},{"key":"CPFTitular","value":"","type":"text","description":"Filtra pelo cpf do titular
\n"},{"key":"GrauParentesco","value":"","type":"text","description":"Filtra pelo nome do parentesto
\n"},{"key":"CNPJEstipulante","value":"","type":"text","description":"Filtra pelo CNPJ da estipulante
\n"},{"key":"CNPJSubestipulante","value":"","type":"text","description":"Filtra pelo CNPJ da subestipulante
\n"},{"key":"CodigoEmpresa","value":"","type":"text","description":"Filtra pelo código da empresa da subestipulante
\n"},{"key":"DataAlteracaoDe","value":"","type":"text","description":"Data inicial da alteração
\n"},{"key":"DataAlteracaoAte","value":"","type":"text","description":"Data final da alteração
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data inicial da criação
\n"},{"key":"DataCriacaoDe","value":"","type":"text","description":"Data final da criação
\n"},{"key":"NumPagina","value":"1","type":"text","description":"Número da página
\n"},{"key":"QtdPagina","value":"100","type":"text","description":"Quantidade de registros por página
\n"}]},"url":"{{.baseUrl}}/BeneficiarioApi/BeneficiariosExcluidosCount","description":"Realiza a contagem de beneficiários excluídos.
\nMétodo: POST
Endpoint: .baseUrl/BeneficiarioApi/BeneficiariosExcluidosCount
Formato: multipart/form-data
\nO intervalo das datas de exclusão não pode ser maior do que 60 dias.
\nEsta pasta concentra as requisições de consulta de beneficiários, permitindo a recuperação de informações com base nos filtros e parâmetros enviados na chamada.
\nAs operações disponíveis são exclusivamente de leitura, destinadas a cenários como:
\nvalidação de dados
\nconferência cadastral
\nintegração com sistemas parceiros
\nAtualmente, a seção contempla a operação:
\n.baseUrl/BeneficiarioApi/BeneficiariosAntes de executar qualquer requisição, valide:
\n.baseUrl configurado corretamente no ambiente ativo
Headers email e senha com credenciais válidas
Parâmetros do body coerentes com o cenário de consulta
\nUtilize homologação/sandbox para testes e validações
\nPara desenvolvimento compartilhado ou produção, siga o fluxo de liberação e os canais de suporte definidos pelo time responsável
\nAs requisições desta pasta não realizam alterações de estado (somente leitura)
\nRespeite os limites e políticas de uso definidos para a API
\nRealiza a edição de um beneficiário.
\nMétodo: POST
Endpoint: .baseUrl/BeneficiarioApi/Alterar
A requisição exige autenticação via headers obrigatórios:
\nEsta pasta concentra as operações relacionadas aos beneficiários, reunindo endpoints voltados principalmente para consulta de dados e recuperação de informações cadastrais e operacionais.
\nAtualmente, a organização interna está segmentada por tipo de uso, como a subpasta Consultas, facilitando a navegação e a localização das chamadas conforme o objetivo da integração.
\nAs requisições desta seção seguem o padrão de ambiente definido para a vertical em que estão inseridas. Antes de executar qualquer chamada, confirme se a variável de ambiente correspondente está configurada corretamente para o contexto desejado.
\nRecomenda-se utilizar homologação ou sandbox durante o processo de desenvolvimento e validação. Para uso em ambientes de desenvolvimento compartilhado ou produção, siga o fluxo de suporte e liberação definido pelo time responsável.
\n","_postman_id":"febcfb96-93c4-4810-ad55-7339fa70b0d4"}],"id":"4a93a13d-2c78-4248-b9d3-e0aa165db948","description":"Esta pasta reúne os endpoints da versão V1 do catálogo de APIs, organizados por domínios funcionais da operação. Nela, estão concentradas as rotas relacionadas a Beneficiários, Estipulantes e Movimentação, contemplando tanto consultas de dados cadastrais e operacionais quanto processos de carga, acompanhamento e tratamento de informações.
\nSeu objetivo é facilitar a navegação e o consumo dos recursos disponíveis nesta versão da API, oferecendo uma estrutura centralizada para integrações, conferências e rotinas operacionais associadas a esses módulos.
\nSe quiser, também posso adaptar esse texto para um tom mais técnico, mais executivo ou mais curto para uso direto na documentação da pasta V1.
\n","_postman_id":"4a93a13d-2c78-4248-b9d3-e0aa165db948"}],"event":[{"listen":"prerequest","script":{"id":"208b3c3e-2d1b-42de-8b7f-d0b9eb74a469","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"c9dae77d-24f9-4ee5-9219-f508a31de66b","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}]}