01. DADOS GERAIS
| Produto: |
TOTVS Backoffice
|
|---|---|
| Linha de Produto: | Linha Protheus |
| Segmento: | Backoffice |
| Módulo: | SIGAFAT - Faturamento |
| Função: | FATAPICGC - Cadastro de Clientes x CAROL (Integração via API) |
| País: | Brasil |
| Ticket: | |
| Requisito/Story/Issue: | DSERFAT-19186 |
02. SITUAÇÃO/REQUISITO
Criar a integração API entre o Cadastro de Clientes e a CAROL, visando facilitar o processo do cadastramento dos Clientes no Protheus®. Os campos básicos/obrigatórios padrões do Cadastro de Clientes devem ser preenchidos automaticamente.
03. SOLUÇÃO
Desenvolvida a API de integração do Cadastro de Clientes do Protheus® com a CAROL. Ela será executada ao se preencher o campo CPF/CNPJ (A1_CGC) no Cadastro de Clientes (via gatilho).
Esta nova integração com a CAROL está parametrizada para que realize somente a pesquisa de pessoas jurídicas, e também não possui pontos de entrada.
Para ativar esta integração em seu ambiente, é necessário aplicar o Pacote de Dicionário (UPDDISTR), neste caso somente do Release 12.1.27, nos demais terão de ser criados manualmente seguindo os dizeres abaixo, também deverá aplicar o pacote oficial dos programas-fonte da Expedição Contínua do módulo Faturamento (SIGAFAT), cuja data de corte dos mesmos é posterior à 07/02/2021 e, posteriormente, seguir o passo-a-passo logo mais abaixo.
A execução da API terá o seguinte comportamento:
• Serão preenchidos automaticamente os seguintes campos:
| Campo | Título |
|---|---|
| A1_NOME | Nome |
| A1_NREDUZ | N Fantasia |
| A1_PESSOA | Física/Juríd. |
| A1_END | Endereço |
| A1_MUN | Município |
| A1_BAIRRO | Bairro |
| A1_EST | Estado |
| A1_CEP | CEP |
| A1_DDD | DDD |
| A1_TEL | Telefone |
| A1_CNAE | Cód. CNAE |
• Os campos abaixo continuam com a necessidade do seu preenchimento manual:
| Campo | Descrição |
|---|---|
| A1_COD | Código |
| A1_LOJA | Loja |
Com a aplicação do pacote de dicionários descrito acima, serão criados os seguintes:
- Parâmetro MV_APICCGC
- Gatilho no campo A1_CGC no Dicionário de Dados de Gatilhos (SX7) que será o responsável por executar a integração API com a CAROL. Este gatilho, mesmo criado no ambiente, somente terá efeito se o novo parâmetro MV_APICCGC estiver configurado como ativo (.T.).
Para ativar o parâmetro MV_APICCGC, acesse o módulo Configurador do ambiente (SIGACFG). No menu lateral, acesse Ambiente → Cadastros → Parâmetros. Clique na opção "Parâmetros" na árvore lateral de opções e, no menu superior, clique em "Pesquisar":
Na caixa de texto que é apresentada à esquerda da tela, digite MV_APICCGC e clique no botão Buscar. Após encontrar o parâmetro MV_APICCGC, clique no botão Editar.
Alterar o conteúdo do parâmetro para verdadeiro (.T.) conforme as imagens abaixo. Clique em Salvar para concluir o processo, e quando retornar ao browser inicial, clique na opção Sair.
IMPORTANTE!
Este passo somente deve ser executado caso o gatilho e o parâmetro não existam em seu ambiente. Caso contrário, será necessário somente a ativação do parâmetro MV_APICCGC com o conteúdo igual a .T..
Criação do Gatilho:
Acesse o menu Base de Dados → Dicionário → Gatilhos:
Onde:
Campo | Conteúdo |
|---|---|
Campo | A1_CGC |
Sequência | Utilizar a última sequência disponível em seu ambiente |
| Cnt. Domínio | A1_CGC |
| Tipo | 1 - Primário |
| Regra | M030APICGC() |
| Posiciona | 2 - Não |
| Condição | GETNEWPAR("MV_APICCGC", .F. ) |
04. DEMAIS INFORMAÇÕES
- Pacotes de Atualização - Faturamento - P12
- Atualização de Dicionário - Faturamento
- Atualizador de dicionário e base de dados - UPDDISTR
05. ASSUNTOS RELACIONADOS
Consulte aqui a documentação do parâmetro MV_APICCGC.
Sobre os Dados:
- Os dados desta API são os mesmos encontrados no portal da Receita Federal > Dados Públicos CNPJ. Consulte aqui.
- Eles são atualizados a cada 03 (três) meses. Ou seja, a resposta para um CNPJ que fora cadastrado dentro de cada um destes intervalos de 03 (três) meses pode ser retornado com o status de "não encontrada".
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas