Contexto de negócio (Introdução)
A oferta TOTVS Colaboração, compreende toda integração entre os ERPs TOTVS com a solução NeoGrid. Este documento tem por objetivo a definição das especificações e critérios técnicos necessários para a integração da recepção de nota fiscal de serviço eletrônica entre o ERP DATASUL e a Neogrid para atender a solução TOTVS Colaboração 2.0.
A integração referente à recepção de Notas Fiscais de Serviços Eletrônicas (NFS-e) de fornecedores abrange a utilização dos dados do XML da NFS-e recebido dos fornecedores para geração de informações para automatização do recebimento (digitação) de notas fiscais dentro do ERP.
Entre as vantagens que esta integração proporciona, estão:
- Segurança: A nota pode ser importada no recebimento logo após ser validada pelo servidor da respectiva Prefeitura, o que garante a consistência e autenticidade das informações;
- Redução de Custos: Redução do volume de digitação de notas fiscais no Recebimento. Isso pode representar redução de custos de mão-de-obra para efetuar a digitação, bem como a redução de possíveis erros de digitação de informações;
- Previsibilidade: Planejamento para recepção dos serviços prestados dentro do município;
- Redução de Erros: Redução de erros de escrituração devido à eliminação de erros de digitação de notas fiscais.
A recepção de NFS-e, contempla a recepção, validação e tradução das informações inerentes ao negócio do fornecedor para informações de negócio do cliente.
Objetivos do projeto TOTVS Colaboração 2.0
O projeto TOTVS Colaboração 2.0 tem como objetivo a implantação de um modelo único e performático para possibilitar o relacionamento entre os clientes TOTVS que adquirem a solução TOTVS Colaboração.
O TOTVS Colaboração foi lançado em 2010 com a integração da solução ERP x TSS x Neogrid utilizando Web Services. Em julho de 2014 iniciou-se o projeto de reestruturação da arquitetura utilizada, passando a realizar a integração direta do ERP com a Neogrid através da troca de arquivos em diretório (filesystem).
Sistemas Envolvidos
- ERP Datasul – Módulo de Recebimento. Funcionalidade de recepção de notas fiscais eletrônicas.
- Client Neogrid – Responsável por entregar os arquivos no portal Neogrid.
- Neogrid (Portal e Web EDI).
- Prefeituras: Validação dos dados da RPS enviada pelo fornecedor.
Arquitetura de comunicação com a Neogrid
Na versão 1.0 do TOTVS Colaboração a integração entre ERP e Neogrid era realizada via WebService com a utilização do TSS como produto fiscal único. Os XMLs eram gerados conforme padrões disponíveis no TSS.
Na versão 2.0, a integração será realizada diretamente entre ERP e Neogrid, sem o intermédio do TSS. Essa comunicação passa a ser feita com a utilização de troca de arquivos em diretório (filesystem).
Nessa arquitetura a comunicação é feita através da utilização de um ClientEDI que deve ser instalado no cliente, o qual ficará responsável por realizar a comunicação com a Neogrid.
A integração entre a Neogrid e a TOTVS tem as seguintes premissas:
- Solução de integração simples e padronizada para todos os tipos de documentos e ERPs TOTVS, com foco na performance da solução para o cliente final e na agilidade de atendimento para as equipes de suporte;
- O padrão de comunicação entre os ERPs TOTVS e a Neogrid será realizada de forma assíncrona com troca de documentos no formato XML em diretórios;
- Existem dois tipos de integração do ponto de vista dos ERPs: envio de documentos e recebimento de documentos;
- A Neogrid deve instalar um aplicativo cliente denominado “Client Neogrid” no ambiente de cada cliente;
- Para cada tipo de documento, todos os ERPs TOTVS devem utilizar o mesmo layout de integração com a Neogrid;
- Toda e qualquer alteração futura a ser realizada na solução TOTVS Colaboração deve ser notificada para as equipes Neogrid e TOTVS, para que a integração continue funcionando corretamente.
Abaixo exemplo de comunicação na nova arquitetura:
Padrões Técnicos
1. Nomenclatura de Arquivos
A nomenclatura dos arquivos nos diretórios, tanto para envio como para retorno, deve seguir a padronização “[Tipo do Documento]_[Timestamp]_[Número sequencial].xml”, onde:
- [Tipo de Documento] é o código do tipo de documento EDI
- [Timestamp] é a data e hora no formato “yyyyMMddHHmmssSSS”
- [Número sequencial] é um número sequencial de quatro dígitos
Exemplo de nome de arquivo para um documento de recepção de NFS-e: “319_20140627154700123_0001.xml”.
O envio de documentos pelo Client NeoGrid possui um controle de documentos duplicado. Arquivos enviados pelos ERPs TOTVS com o mesmo nome serão rejeitados.
A solução NeoGrid está preparada para que os ERPs enviem os arquivos de recebimento de NFS-e para validação com o código EDI 319:
Projeto | Fluxo | Cód EDI | Leiaute |
NFS-e Recebimento | Recebimento de NFS-e (Neogrid -> ERP) | 319 | XML padrão NeoGrid |
2. Padrão de comunicação
O padrão de comunicação utilizado entre ERP e Neogrid é por troca de arquivos em diretórios (filesystem) com a utilização do Client da Neogrid.
O ClientEDI é um JOB em JAVA onde é parametrizado o tempo de monitoramento do diretório e do WebEDI. Ele acessa o WebEDI utilizando WebServices onde é utilizado um método para envio e outro para buscar as mensagens processadas.
Dentro do diretório de instalação do Client existem duas subpastas denominadas IN e OUT, onde todos os arquivos a serem integrados devem ser depositados.
- OUT..: diretório onde os ERPs devem depositar os arquivos para envio para a Neogrid
- IN......: diretório onde os ERPs devem ler os arquivos recebidos da Neogrid
No ERP Datasul existe um JOB responsável por monitorar a subpasta IN e processar o retorno de todos os arquivos que forem depositados neste diretório.
Integração
A integração envolve o ERP (Datasul), a Neogrid e a Prefeitura e prevê dois fluxos: recebimento iniciado pelo ERP e recebimento iniciado pelo Neogrid, detalhados na sequência.
Recebimento iniciado pelo ERP:
Obs.: Neste caso o cliente recebe o XML por e-mail e importa a NFS-e para o ERP.
Passos:
- Fornecedor envia o XML da NFS-e para o cliente;
- Usuário salva o XML da NFS-e e importa via diretório (RE0517);
- Se o fornecedor estiver parametrizado para atualizar automaticamente no Receb. Fiscal a NFS-e fica digitada no RE1001;
- Se o fornecedor NÃO estiver parametrizado para atualizar automaticamente no Receb. Fiscal a NFS-e fica disponível no monitor aguardando ação do usuário.
Recebimento iniciado pelo Neogrid:
Obs.: Caso o cliente não utilize a emissão de NF-e/NFS-e pelo TOTVS Colaboração, a etapa “JOB Fiscal” pode ser retirada do fluxo, pois há a possibilidade de parametrizar a busca dos documentos diretamente do diretório do client Neogrid (IN).
Passos:
- Fornecedor envia o XML da NFS-e para o Neogrid;
- Neogrid valida a mensagem;
- Neogrid envia consulta de situação da NFS-e para a prefeitura correspondente;
- A Prefeitura processa consulta da situação da NFS-e e retorna e resultado;
- Neogrid disponibiliza o retorno da consulta da NFS-e;
- Client Neogrid busca XML da NFS-e validado na Neogrid e salva em um diretório “IN” (Nomenclatura arquivo: 319_*.xml);
- ERP busca NFS-e do diretório “IN” e salva em diretório para recepção (JOB Fiscal – CD0590);
- ERP busca NFS-e do diretório de recepção e efetiva no recebimento (Importação NFS-e TOTVS Colaboração - RE0522).
Escopo
Esta integração contempla a recepção do layout ABRASF.
Contempla a recepção de notas fiscais de serviços prestados dentro do município.
Não está contemplada a recepção da mensagem de cancelamento/substituição da NFS-e.
Pré-requisitos instalação/implantação/utilização
Pré-requisitos (técnicos ou de negócio) para o funcionamento da integração:
- Versões mínimas de produto:
- Datasul 12.1.2 em diante;
- Client Neogrid na versão disponibilizada e instalada pela Neogrid;
- Pré-requisitos de negócio:
- Contratação da oferta do TOTVS Colaboração (TOTVS e Neogrid);
- Demais parametrizações no ERP, conforme detalhado na sequência.
- Pré-requisitos para utilização no ERP:
- Ativar a função "TOTVS-COLABORACAO" (via programa CD7070);
- Acessar os parâmetros globais (CD0101), pasta “Integr. II” e habilitar o TOTVS Colaboração e a versão 2.0;
Acessar o programa de configuração de diretórios do Colaboração 2.0 (CD0360A) e configurar os diretórios do Client Neogrid, conforme figura que segue.
No campo “Diretório Recepção Documentos” deve ser informado o diretório onde o ERP irá buscar os documentos.
Configurar a execução do JOB Fiscal que realiza a leitura dos documentos da pasta “IN”.
Este JOB pode ser executado de 2 formas:
- Programa CD0590 rodando em RPW;
- Programa Agente;
OBS: Para mais detalhes sobre o JOB Fiscal devem ser acessados os manuais de emissão de NF-e no TOTVS Colaboração 2.0.
Configurar os parâmetros do conversor de documentos de entrada (RE0119);
Habilitar a funcionalidade para receber Conhecimento de Transporte, parâmetro “Habilita NFS-e”, nos parâmetros do Conversor (RE0119);
Configurar o engine de regras: O Engine de Regras possibilita configurar as condições externalizando a regra de negócio. Utilizar os programas CD0024 para cadastro das regras, CD0025 para cadastros de tipos de operação e CD0026 para testes.
As seguintes operações devem ser traduzidas pela Engine:
- serie-docto: Série da Nota Fiscal;
- cod-item-serv: Código do Item;
- nat-operacao: Natureza de Operação;
- numero-ordem: Número da Ordem de Compra;
- num-pedido: Número do Pedido de Compra;
- parcela: Número da Parcela da Ordem de Compra;
- cod-un: Unidade de Medida;
- cod-emitente: Código do Fornecedor.
Para traduzir essas operações, deve ser possível passar as seguintes variáveis:
- serie-docto: Série da Nota Fiscal;
- cod-un: Unidade de Medida;
- cod-emitente: Código do Fornecedor;
- cod-gr-forn: Código do Grupo do Fornecedor;
- cod-estabel: Código do Estabelecimento;
- dt-emissão: Data de Emissão;
- ge-codigo: Grupo Contábil do Item;
- cod-uf-prestdor: Unidade da Federação do Emitente;
- cod-item-serv: Código do Serviço;
- num-munpio-prestac: Código Município Prestação Serviço (Tabela IBGE).
Instalação/Atualização
Para esta integração é necessária a instalação do Client Neogrid no servidor do cliente. Esta instalação não será detalhada neste documento pois é de responsabilidade da equipe Neogrid.
Mensagens comuns da integração
- Mensagem 52116: Estrutura do arquivo <nome_do_arquivo_XML> não corresponde à NFS-e. Ocorre quando o sistema identifica que o arquivo importado não comporta o schema padrão ABRASF (Associação Brasileira das Secretarias de Finanças das Capitais), utilizado para recepção da NFS-e.
- Mensagem 52023: A situação NFS-e está como Extraviada ou Cancelada. Ocorre quando a TAG <statusRPS> está com conteúdo igual a 3. Nesse caso deve-se entrar em contato com o fornecedor.
- Mensagem 52018: Emitente não parametrizado para receber automaticamente o documento, favor consultar a nota no RE0708. Esse é apenas um alerta, informando que a nota não foi gerada no Recebimento Fiscal (verificar CD0401).
- Mensagem 32100: Não encontrado estabelecimento com o CNPJ do tomador. O CNPJ que consta na TAG <cnpjTom> deve ser o mesmo CNPJ que consta para o estabelecimento que fará a recepção da NFS-e.
- Mensagem 158: Fornecedor inválido. Ocorre quando não foi localizado fornecedor utilizando o CNPJ da TAG <cnpjPrest>, ou se o emitente encontrado não é fornecedor nem ambos (verificar CD0401).
- Mensagem 2: Não encontrado item para a chave informada. Ocorre quando o código do item que consta na TAG <itemListaServ> não foi encontrado. O item deve existir no cadastro de itens (CD0204) e deve ter controle contábil igual a Débito Direto. É possível cadastrar uma regra no configurador de regras (CD0024) para traduzir o conteúdo dessa TAG para um item válido.
- Mensagem 35041: Natureza de Operação Inválida. Cadastre uma regra para sugerir a Nat. Operação através da rotina. Ocorre quando a natureza de operação sugerida pela regra cadastrada para a natureza de operação não é válida ou não é de entrada/compra
Nota:
- Podem ocorrer outros erros de negócio, no momento da efetivação da NFS-e no recebimento fiscal, porém a solução a ser adotada é a mesma utilizada para o recebimento no produto (sem que seja o conversor).
Checklist de suporte da aplicação
Pontos importantes para o funcionamento e atendimento da integração.
Verificações:
- Client Neogrid deverá estar em execução (lembrando que a parametrização deste é de responsabilidade da equipe Neogrid);
- JOB Fiscal (CD0590) deverá estar rodando em RPW ou via agente;
- Importador de notas (RE0522) do módulo de recebimento deve estar rodando em RPW;
- Demais Parametrizações do tópico 8 devem ser verificadas.