Para usar o recurso de busca de logradouro por CEP, com base na API dos Correios, não é necessário nenhuma aquisição ou contrato adicional.
Apenas deve ser instalada a API de dependência e realizar a configuração da URL de instalação, no módulo Parâmetros>Parâmetros> Gerais>aba Integrações> campo URL base de API local.

Cadastrar a Pessoa

Entre na aplicação

Insira o nome do cliente, ou se for empresa insira a razão social:

Imagem 1 - Tela do Cadastro de Pessoa

Informe o tratamento, que é o nome como irá tratar a pessoa, pode ser um apelido ou até mesmo somente o primeiro nome.
Fica aberto para definir como deseja identificar:

Imagem 2 - Tratamento

Defina o tipo de pessoa, se trata de uma pessoal física ou pessoa jurídica:

Imagem 3 - Tipo de Pessoa

Informe o sexo, se trata de uma pessoa do sexo masculino, feminino, ou outros:

Imagem 4 - Sexo

Defina o status da pessoa, se o mesmo trata-se de um prospect, ativo ou outros:

Imagem 5 - Status

Informe o estado civil da pessoa:

Imagem 6 - Estado Civil

Funcionamento do recurso de busca de logradouro por CEP, com base na API dos Correios:

• Consulta Inicial:
  
  • Quando um CEP é informado pela primeira vez, o sistema faz uma chamada à API dos Correios.
  • Os dados retornados, incluindo informações de logradouro, são armazenados na base de dados do ERP junto com a data da consulta.
• Verificações
  
  • Ao consultar um CEP já existente:
  • O sistema verifica a data da última consulta armazenada.
  • Se a consulta foi realizada dentro dos últimos 12 meses, os dados são recuperados diretamente do base de dados sem acionar a API.
  • Se a consulta ultrapassou os 12 meses, o sistema faz uma nova chamada à API, atualizando as informações e a data da consulta.

• Quando se tratar de um CEP por logradouro, a aplicação deve carregar as informações de cidade, UF, bairro e logradouro conforme a pesquisa realizada, ficando o cursor no campo Nº. As informações pesquisadas devem serão automaticamente atualizadas nas tabelas pertinentes ao Logradouro.

                                                                                                                                                                                                          Imagem 7 - Busca de informações baseado no CEP

Para habilitar o campo Cidade, quando existe uma URL configurada para a API de Conector dados Globais, será necessário pressionar TAB quando o cursor estiver no campo CEP.

• Caso o usuário não saiba o CEP, poderá sair do campo CEP.
  Automaticamente os campos Cidade, UF e Logradouro são habilitados para que ele possa informá-los, e assim a rotina buscar pela API Conector Dados Globais do CEP e Bairro correspondente a aquelas informações.

                                                                                                                                Imagem 8 - Busca de informações do CEP através da Cidade, UF e Logradouro

• Quando os dados informados de Cidade, UF e Logradouro, possuírem mais de um CEP vinculado junto aos Correios, será exibida uma dialog com todos os resultados encontrados para que o usuário possa selecionar a informação correta.

Imagem 9 - Retorno de vários CEPs para uma mesma Cidade, UF e Logradouro

Importante ressaltar, que as novas implementações só terão efeito se a API Conector Dados Globais estiver devidamente instalada no ambiente do cliente, caso a API não esteja instalada e configurada, o processo padrão anterior existente continuará sendo executado.

Padrão de configuração de CEP, Cidade, Bairro e Logradouro sem as configurações da API Conector Dados Globais, com a comunicação dos CEP´s dos correios.

Informe a cidade. Quando adicionar a cidade a pessoa, os campos UF e CEP serão preenchidos automaticamente. O campo CEP poderá sofrer alteração quando adicionar o bairro e o logradouro:

Imagem 10 - Cidade

Informe o bairro.
Ao adicionar o bairro o campo CEP poderá reajustar automaticamente:

Imagem 11 - Bairro

Informe o logradouro.
Quando adicionar o logradouro o campo CEP poderá reajustar automaticamente:

Imagem 12 - Logradouro

Adicionar o número da residência:

Imagem 13 - Número

Adicione o telefone de contato, poderá adicionar até três números de telefones:

Imagem 14 - Telefone

Adicionar informações de documentos, como o CPF, RG e órgão expedidor:

Imagem 15 - Dados de Documentos

Clique para incluir.
Ao incluir o cadastro do cliente será gerado um código sequência dessa pessoa. 

Imagem 16 - Incluir Pessoa

Para imprimir o cadastro, basta clicar na impressora.
Se o parâmetro dinâmico IND_HAB_IMP_FICHA_CAD estiver habilitado, será aberto no botão de impressão as duas opções Impressão Ficha Cadastral e Impressão Cadastro.
Caso o parâmetro dinâmico estiver com a opção N será demonstrado somente a opção Impressão Cadastro.

Prescritor

Ao marcar a opção Profissional Prescritor, clique sobre o botão Prescritor e informe os campos necessários.
É possível consultar as informações desta tela por meio da aplicação Cadastro de Profissionais Prescritores - GEPES00100.

Termo de Uso

Clique sobre o botão Termo de Uso e será aberta a tela com o termo de uso cadastrado.
Para imprimir, basta dar um duplo clique no arquivo.

Imagem 17 - Termo de Uso

Relacionamentos

São as pessoas que possuem alguma relação seja familiar ou de trabalho, e que possui vínculo com a outra.

A pessoa relacionada pode ser considerada como Pagador das dívidas da pessoa cadastrada.

Clique para Incluir <F3> a pessoa, e salve <F4> as alterações.

Imagem 18 - Relacionamentos

Contatos

Por meio do botão de Contatos, é aberta a tela para o cadastro de contatos para uma pessoa.

Esses contatos são cadastrados como uma pessoa no sistema, e ficam vinculados a pessoa que se está incluindo ou alterando.

Os contatos são utilizados em diversas partes do ERP, como por exemplo para o envio de boleto por e-mail:

Imagem 19 - Contatos

Endereços

Atualmente o local de entrega pode ser informado no pedido de venda na aplicação Venda Balcão, caso não seja informado no pedido de venda será considerado o endereço de faturamento como local de entrega.

Para o endereço de faturamento são consideradas as informações da aplicação Cadastro de Endereços onde são cadastrados os endereços vinculados ao cadastro de pessoa, entre eles o endereço de entrega.

Clique no botão Endereços e será aberta a tela para informar os dados.

Será possível cadastrar endereços do tipo Cobrança, Correspondência e Entrega.

Clique no botão Cidade e informe a cidade desejada.

Após informar todos os dados do endereço, clique no botão de Incluir <F3>.

Desta forma os endereços para aquela pessoa já estarão configurados.

Imagem 20 - Endereço

Advertências

São advertências aplicadas pelo administrador à pessoa por alguma violação da regra.

É importante informar um resumo da advertência, o campo Nível Edição é caso deseja alterar a permissão da pessoa, e o campo Advertência é a descrição do ocorrido.

Imagem 21 - Advertências

Inativar/Ativar

Por meio do botão Inativar é possível tirar a possibilidade da pessoa utilizar o sistema, isso acontece por exemplo em casos em que se deseja restringir para que o cliente não realize mais compras.

Será aberta a tela para informar a observação para inativar. E clique no botão verde para confirmar.

Imagem 22 - Inativar

Será exibida a mensagem de confirmação.

Imagem 20 - Confirmação

Após inativar a pessoa, o mesmo botão estará como Ativar, e ao clicar sobre ele a pessoa já será ativada automaticamente.

Versões

A partir do botão Versões, é aberta a tela com as versões das alterações que ocorreram no cadastro da pessoa, e ao clicar sobre a alteração no campo justificativa será detalhado o motivo da alteração. Esta tela é apenas para consulta e será habilitada apenas quando houver alterações.

Imagem 23 - Versões

Cadastro

São os dados cadastrais da pessoa. Nesta tela é possível consultar e adicionar mais informações em relação ao cadastro da pessoa, seja ela jurídica ou física.

Imagem 24 - Cadastro

Notas

São as anotações referentes àquela pessoa. 

Escolha o tipo da anotação, e em seguida descreva sobre o que deseja anotar sobre a pessoa.

Imagem 25 - Notas

Para finalizar, clique no botão de Atualizar <F4>.

Logs

Para consultar os logs, clique sobre o botão Logs, e será aberta a tela com os dados da pessoa física, sendo gravado pelo IP da máquina, o usuário, data e hora da consulta, e o histórico das alterações:

Imagem 26 - Logs

Finalidade

Ao incluir o cadastro de pessoa física caso o parâmetro Exige Finalidade (módulo Pessoa e aplicação Parâmetros) esteja parametrizado o indicador , a aplicação demonstrará uma opção solicitando que informe a finalidade do cadastro, sendo as opções Obrigação Legal, Execução de Contratos e Consentimento. Ao confirmar a finalidade, esta será salva e demonstrada no botão Finalidade.

Esta exigência ocorrerá somente para cadastros de pessoas físicas, para cadastros de pessoas jurídicas este botão não será demonstrado. Para cadastros que ocorrem com status Prospect esta finalidade não será exigida, porém ao alterar o cadastro para ativo será necessário parametrizar a finalidade.

Quando o nível do usuário for administrador, será habilitado para ele a opção de modificar a finalidade parametrizada, para o nível usuário as informações serão apenas demonstradas, caso o usuário administrador realize alteração ela estará registrada no LOG. 

Imagem 27 - Finalidade

Anonimizar

Selecione a opção Anonimizar, esta opção será demonstrada somente para cadastros de pessoas físicas, ao selecionar a opção, será demonstrada a mensagem:

Imagem 28 - Anonimiza

Se selecionar a opção Sim o processo verificará se o cadastro teve movimentações nos últimos 5 anos, caso encontre movimentações, retornará a mensagem:

Imagem 29 - Movimentações

Caso o processo não encontre movimentações retornará a mensagem: Dados Anonimizados.

Se o cadastro tiver movimentações, será aberta a tela com o NF/Título, Data e Tipo do Documento:

Imagem 30 - Movimentações 

Os dados serão anonimizados respeitando os campos anonimizados conforme a parametrização realizada previamente na aplicação Parametrização Cadastro de Pessoa, caso tente anonimizar e não exista parametrização dos campos que serão anonimizados, o processo demonstrará a mensagem informando que não foram encontradas as parametrizações de anonimização. Após o cadastro estiver anonimizado, ele ficará com status inativo.

Recolhimento

Por meio do botão Recolhimento será possível escolher o tipo de recolhimento. É utilizado quando a pessoa é tomador de serviço e o mesmo é classificado como Substituto Tributário para NFSe.

Os tipos de recolhimento são:

• A Receber: para local de incidência do imposto no município e tomador não sendo substituto tributário. 
• Retido na Fonte: para local de incidência do imposto no município e tomador substituto tributário.

E também é possível informar o motivo da retenção.

Imagem 31 - Recolhimento

Após informar os campos, clique para retornar.

Consulta CNPJ

Foram implementadas na aplicação, recurso para buscar informações de pessoa do tipo Jurídica, através da nova API Conector Dados Globais, com base nos dados da Receita Federal ou Sintegra, em integração à plataforma TOTVS API Services.
Requisitos para uso do recurso de busca de informações de pessoa do tipo Jurídica com base nos dados da Receita Federal ou Sintegra.

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 32 - Permissão de Listar na API de 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 componentes inseridos na tela somente serão exibidos se, na rotina Parâmetro Geral, aba Integrações, do módulo Parâmetro, 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 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 33 - Layout no cadastro de pessoa - Botão Consulta CNPJ
         

• 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 34 - Dialog Pesquisa dados Pessoa Jurídica

Imagem 34 - 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 35 - Mensagem sobre campos vazios

    
    

    

    Imagem 36 - Mensagem sobre campos vazios

    
    

    

    Imagem 37 - Mensagem 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 38 - Mensagem 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 39 - Mensagem de falha na comunicação com a API.
    
    
    

    • • Se o CNPJ informado estiver errado ou inválido, será retornada mensagem de alerta:
    • 
    •                                                                                                                                                                     Imagem 40 - Mensagem 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 41 - Tela que será executada caso o CNPJ pesquisado tenha mais de uma Inscrição Estadual. (tarja 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;

    
    

    

    Imagem 42 - Retorno da API quando os dados são encontrados. (tarja em vermelho para preservar os dados pesquisados)

O uso do Tipo de Produto em diferentes tecnologias não homologadas, como em Sistema Operacional, Plataforma, Navegadores e outros dispositivos, pode comprometer a segurança dos sistemas e está sujeito a situações não previstas, sem cobertura de suporte.