Histórico da Página
...
- Para utilização do recurso, é necessário adquirir um pacote do serviço TOTVS API Services. Isso deve estar claro na documentação, com informação do link destinado à compra (https://totvs.store/br/produto/totvs-api-services.html);
- Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada. Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo > Sistemas/Módulo/Aplicações > Sistema Global > Módulo de Aplicações Globais em Web > API Conector Dados Globais.
Imagem 1 - Tela para realizar a permissão das API Conector Dados Globais
- Foi criada a coluna INDCONSPJAPI na tabela que armazena os dados da Pessoa, esta coluna é o Indicador que demonstra se o CNPJ informado foi validado em consulta via API Conector Dados Globais;
- Conforme mostra a imagem abaixo, foram adicionados dois novos componentes à tela, sendo eles o botão Consulta CNPJ, e no fim da tela, uma mensagem onde o conteúdo alerta ao usuário como proceder para realizar a consulta do CNPJ e que tipo de consulta será feita, importante ressaltar que:
- Que os novos componeste inseridos na tela somente serão exibidos se, na rotina Parâmetro Geral, aba Integrações, do módulo Parâmetro, estar marcada se a URL base de API Local estar preenchida, a opção Utiliza integração com TOTVS API Services estar marcada e a Chave de autenticação TOTVS API estiver estar preenchida;
- A mensagem deverá retornar de acordo com a opção selecionada na opção Fonte para pesquisa de informações para dados de pessoa jurídica, na rotina Parâmetro Geral, aba Integrações, do módulo Parâmetro:
- Se a opção marcada for Receita Federal, a mensagem será: Para buscar dados cadastrais de pessoa jurídica junto à Receita Federal, utilize o botão Consulta CNPJ.
- Se a opção marcada for Sintegra, a mensagem será: Para buscar dados cadastrais de pessoa jurídica junto à Sintegra, utilize o botão Consulta CNPJ.
- Se a opção marcada foi Ambos, a mensagem será: Para buscar dados cadastrais de pessoa jurídica junto à Receita Federal e Sintegra, utilize o botão Consulta CNPJ.
Imagem 1 2 - Alteração de Layout na Pessoas - GEPES0010
- Ao clicar no botão Consulta CNPJ, será exibida a tela, conforme imagem abaixo, onde:
- Caso a opção de pesquisa seja Receita Federal, o campo CNPJ obrigatoriamente preenchido, e o campo UF é opcional;
- Se a opção for Sintegra ou Ambos, os campos CNPJ e UF são obrigatórios;
- Se o usuário não informar os campos na rotina Pessoas - GEPES0010, os campos estarão vazios e editáveis para que o usuário possa informar;
- Se o usuário informar os campos na rotina Pessoas - GEPES0010, os campos estarão previamente preenchidos e não editáveis;
Imagem 2 3 - Dialog Pesquisa dados Pessoa Jurídica
Imagem 3 4 - Exemplo de utilização da Consulta CNPJ
...
- Se os campos CNPJ e UF estiverem vazios, deverá ser exibida mensagem de alerta ao usuário;
- Se a opção marcada for Receita Federal, o campo CNPJ é obrigatório.
- Se a opção marcada for Sintegra ou Ambos, o campo CNPJ e UF são obrigatórios.
Imagem 4 5 - Mensagm sobre campos vazios
Imagem 5 6 - Mensagm sobre campos vazios
Imagem 6 7 - Mensagm sobre campos vazios
...
- Ao informar um CNPJ, e este já encontra-se inserido no banco de dados, a rotina retornará avisando se o usuário deseja realmente realizar a pesquisa:
Imagem 7 8 - Mensagm sobre CNPJ já cadastrado.
...
- Se os dados informados estiverem prontos para ser realizada a pesquisa sobre determinado CNPJ, ao clicar no botão com o símbolo de check, a consulta será iniciada, e então a TOTVS API Services, irá buscar e validar os dados:
- Se houver algum problema na comunicação da API, será retornada a mensagem abaixo:
Imagem 8 9 - Mensagm de falha na comunicação com a API.
- Se o CNPJ informado estiver errado ou inválido, será retornada mensagem de alerta:
- Imagem 10 - Mensagm de dados não encontrado.
-
- Se o CNPJ informado estiver correto, e para ele houver mais de uma Inscrição Estadual, será aberta uma tela para que o usuário escolha qual a Inscrição Estadual deseja vincular ao cadastro da Pessoa:, o exemplo da imagem abaixo exibi apenas uma Inscrição Estadual, apenas de modo ilustrativo para demonstração da tela.
- Imagem 11 - Tela que será executada caso o CNPJ pesquisado tenha mais de uma Inscrição Estadual. (taja em vermelho para preservar os dados pesquisados)
-
- Se os CNPJ informado estiver correto, será exibida uma tela com todos os dados resultantes da pesquisa;
- No fim da tela, haverá dois botões, um para confirmar os dados e outro para cancelar a busca dos registros:
- Se o usuário clicar no botão que confirma os dados, será então preenchida a rotina Pessoas - GEPES0010;
- Se o usuário opte por não confirmar os dados, a tela será fechada e voltará a tela de Pesquisa dados de Pessoa Jurídica;
- No fim da tela, haverá dois botões, um para confirmar os dados e outro para cancelar a busca dos registros:
- Se os CNPJ informado estiver correto, será exibida uma tela com todos os dados resultantes da pesquisa;
Imagem 12 - Retorno da API quando os dados são encontrados. (taja em vermelho para preservar os dados pesquisados)
04. DEMAIS INFORMAÇÕES
Disponível a partir da Se estiver na versão 24.07, atualize para o service pack 24.07.001 ou superior.
05. ASSUNTOS RELACIONADOS
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas