Manual de Usuário v4.00 - r002 PDF
Manual de Usuário v4.00 - r002 PDF
Manual de Usuário v4.00 - r002 PDF
Comply e-Docs
1
Conteúdo
Processos ....................................................................................................................313
NF-e: .......................................................................................................................315
2
NFS-e:.....................................................................................................................325
Interface EDI...........................................................................................................331
EDI ..........................................................................................................................331
Padrões Técnicos.....................................................................................................399
Configuração ...........................................................................................................406
Com este projeto, a Sonda IT busca um contato mais próximo com seus clientes e colaboradores,
facilitando e simplificando o acesso às informações sobre seus produtos, permitindo que o
usuário, de forma online ou off-line, otimize o uso das ferramentas desenvolvidas pela empresa,
suas funcionalidades e aplicações.
A ajuda de nossos produtos está estruturada por módulos, que obedecem a uma sequência,
permitindo que o usuário utilize-os como um roteiro para a realização das atividades e rotinas
atendidas por cada um dos sistemas da Sonda IT. De forma clara e objetiva, essa documentação
apresenta o passo a passo pra a realização das rotinas, ilustrando os tópicos com telas dos
próprios produtos. A atualização dessas informações é feita constantemente e reflete sempre
qualquer alteração sofrida pelo produto.
Sugerimos aos nossos clientes e colaboradores que explorem os recursos desta ferramenta para
solucionar possíveis dúvidas quanto à utilização dos produtos Sonda IT, agilizando assim a solução
de problemas simples, que dependem de uma simples parametrização ou uso mais eficiente da
ferramenta.
4
Versões do Produto
Esta documentação refere-se à Versão 4.00 do Comply e-Docs, podendo conter funções ainda
indisponíveis em seu aplicativo.
Nesta pasta é possível acessar, imprimir e baixar os arquivos da versão atual e anteriores,
clicando duas (02) vezes sobre o link de interesse.
Caso não tenha recebido seus dados de acesso em sua caixa de correio, favor solicitar reenvio
através do e-mail: [email protected]
6
Gerenciador de Documentos Eletrônicos
Comply e-Docs
Sistema Comply e-Docs
Introdução
Abaixo seguem as principais caracteristicas do sistema e dos módulos Mercantil e Serviços, que
estão incorporados ao Comply e-Docs:
8
Nota Fiscal Eletrônica Mercantil:
10
Expandindo os Módulos de Nota Fiscal Eletrônica Mercantil e Serviços, temos as seguintes
funcionalidades dividas em: Abap, Framework, Comply e-Docs Server, Outbound, Inbound, Client
Inbound, Arquivamento, Integração e Nota de Serviço Eletrônica.
ABAP. Este componente é responsável pela interface entre o componente Comply e-Docs
Server e o SAP, sendo utilizado pelas funcionalidades de Outbound, Inbound e Nota Fiscal
de Serviço. Este componente tem as funções de prover informações aos usuários SAP
sobre o estado das Notas Fiscais, extrair informações, enviá-las ao componente Comply e-
Docs Server, receber a resposta do processamento. Além de atualizar o SAP com as
informações relacionadas à NF-e;
12
Componente Framework
Neste manual, demonstraremos os cadastros e parâmetros que devem ser efetuados antes da
ativação dos processos do componente Comply e-Docs Server. O sucesso deste depende
principalmente de informações externas a ele, que irão garantir a correta ocorrência dos ciclos.
Acesso ao Sistema
Login
Para login ao Comply e-Docs siga o procedimento abaixo:
Campos disponíveis:
o Nome do usuário: Informar o nome de usuário.
o Senha: Informar a senha cadastrada.
o Entrar automaticamente: Marque esta opção se desejar salvar os dados de acesso,
dispensando a digitação do usuário e senha no próximo acesso.
14
Depois de informados os dados solicitados, clique duas (02) vezes sobre o ícone ao
lado do aplicativo Comply e-Docs:
16
Para adicionar um novo Servidor, clique duas (02) vezes no botão: - Adicionar.
Será exibida a tela abaixo:
18
Janelas Ativas
Ao abrir qualquer função do Comply e-Docs, o aplicativo lista as janelas que estão ativas,
conforme destacado em vermelho na imagem abaixo:
Para acessá-las, escolha na caixa "Janelas Ativas", a tela que deseja utilizar.
Pesquisa
Para realizar a pesquisa de registros, existentes no Comply e-Docs, siga o procedimento a seguir:
A tela de pesquisa está disponível em todas as funcionalidades que permitem cadastros de dados.
Escolha a operação:
20
Resultados gerados:
o A operação % mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado similar ao digitado. Pode ser utilizada a operação no início, meio
ou final do conteúdo inserido no campo;
o A operação = mais uma letra / número ou palavra digitada no campo Valor, retorna
o resultado igual ao digitado;
o A operação ! = mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado diferente do digitado;
o A operação < mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado menor que o digitado.
o A operação <= mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado igual ou menor que o digitado.
o A operação > mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado maior que o digitado.
o A operação >= mais uma letra / número ou palavra digitada no campo "Valor",
retorna o resultado igual ou menor que o digitado.
Registre o Valor que irá filtrar para ter acesso à lista. Caso não haja nenhuma informação
referente ao filtro, o sistema apenas não demonstra as informações.
Transação
Todas as telas do sistema possuem nomenclatura, a qual denominamos de "Transação".
Através do nome da transação, o usuário pode acessar uma funcionalidade sem utilizar o menu.
Veja a seguir o procedimento para localizar uma funcionalidade pelo nome da transação:
No canto superior da tela principal do sistema, no campo "Atalho" o usuário digita o nome
da transação:
22
Para buscar a transação indicada no campo "Atalho", selecione a opção :
Campos disponíveis:
Senha Atual: Informar a senha atual.
Nova Senha: Cadastrar uma nova senha.
Nova Senha Repetir: Repetir nova senha cadastrada.
A senha pode ser alterada quando desejar; A primeira senha de acesso ao sistema será informada
pelo consultor.
24
Envio de Mensagem
O sistema disponibiliza a opção de envio de mensagem em tempo real, sem a obrigatoriedade de
acessar outro aplicativo. Esta funcionalidade servirá para o contato entre os usuários do sistema
devidamente cadastrados na tela de Usuário.
Enviar Mensagem:
26
Na lista apresentada, selecionar o usuário;
Inserir o assunto no campo "Assunto";
Registrar a mensagem no campo "Corpo da Mensagem";
E, por último, clicar em "Enviar";
Será apresentada mensagem para confirmação do envio:
28
Visualizar E-mails
Para receber a mensagens usando o aplicado, acessar o menu a seguir:
Para utilização das opções ‘Marcar como Lida’ e ‘Exclusão’, escolha o registro antes de efetuar
a ação.
Menu Painel de Controle
Atalho: N/A
30
o Impressora Cliente: Local – Impressora cadastrada localmente;
o Impressora Rede: Impressora compartilhada para os usuários;
o Oficial: DANFE que pode ser impresso para circular com a mercadoria (possui
validade legal);
o Não Oficial: DANFE que pode ser impresso, mas não deve circular com a
mercadoria, utilizada apenas para conferência (não possui validade legal);
o Bandeja da Impressora: Selecione a bandeja onde será impresso o DANFE.
Atalho: PNLINB
32
Painel Inbound mostrando expansão de NF-e com informações de Evento e
Histórico de Eventos
Aba > Todas
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que não
possuem nenhum evento de manifestação do destinatário;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Ciência da Operação;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Confirmação da Operação;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento em estado de Erro;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Desconhecimento da Operação;
Esta aba classifica e mostra as últimas NF-es de Inbound recebidas pelo sistema e que
possuem o último evento válido sendo Operação Não Realizada;
34
O Painel de Controle Inbound possui quatro colunas com sinalizadores para indicar se a
NF-e possui XML ou o estado do último evento de Manifesto que lhe foi atribuído.
Coluna XML
Botão Utilização
Não possui XML
Possui XML
Colunas, Ciência, Confirmação, Desconhecimento ou Não Realizada
Botão Utilização
Evento autorizado
O novo filtro que determina os campos que serão utilizados, se torna mais rápido na
busca pelas NF-es;
36
Para que a busca pelos critérios seja realizada, é necessário selecionar os mesmos e
adiciona-los com o botão , assim como a figura acima.
Caso deseje remover algum parâmetro da busca, apenas clique no botão .
É utilizado para realizar o download do arquivo XML de uma NF-e que esteja com a coluna
XML indicada com o sinalizador , não possui XML. Pode-se selecionar várias NF-es e
solicitar o download, mesmo selecionando NF-es com XML, o download será comandado
apenas para os registros sem XML.
38
Botão > Desconhecimento em Lote
Realiza o Manifesto do Destinatário para uma ou várias NF-es, incluindo um evento de
Desconhecimento da Operação para as NF-es selecionadas. Caso uma NF-e selecionada já possua
o evento, o mesmo não será criado. Este botão apenas cria o evento, é necessário o seu
acompanhamento para verificar que o evento pedido foi corretamente autorizado.
40
Botão > Exibir Eventos
Tela para gerenciar os eventos de segunda geração que pertencem a uma NF-e, esta tela também
esta presente no Painel de Controle Nota Fiscal:
o Funcionalidades disponíveis:
“Enviar” ;
Para cancelar o envio de um evento é necessário clicar no botão “Cancelar”
42
Painel de Controle Nota Fiscal
Esta função auxilia no gerenciamento das Notas Fiscais, através do Status.
Nesta operação, pode-se visualizar o controle de mensagens, efetuado pelo sistema, de acordo
com informações enviadas pela SEFAZ.
Atalho: PAINELCOM
É através do Painel de Controle que o usuário pode gerenciar todo o ciclo de vida de um registro
de Nota Fiscal. Este Painel permite o acompanhamento do estado de um determinado registro e
pode ser utilizado tanto para Notas Fiscais de Outbound (emitidas), quanto para Notas Fiscais e
Conhecimento de Transporte de Inbound (recebidas) e arquivamento. Além disso, também é
possível visualizar, de maneira integrada, NF-es, ePin (Notas Fiscais da Suframa) e NFS-e
(somente para emissão).
Aba > Envio / Recebimento:
São exibidas as notas fiscais que foram pré-validadas e estão com erro de validação,
notas fiscais rejeitadas e denegadas pela SEFAZ, que possuem erro de impressão, erro na
geração do XML e erro de transmissão em geral.
São apresentadas as notas fiscais que estão em contingência, ou seja, que não estão com
o tipo de emissão Normal.
Botão Utilização
Impressão do DANFE
Processo concluído
44
Esta transação possui as seguintes funções:
Filtro: utilizado para realizar uma busca por Notas Fiscais. As opções são as
seguintes:
Seleção Múltipla: utilizando esse botão é possível selecionar mais de um
registro de um mesmo tipo de filtro.
46
Limpar Filtro: utilizado para limpar as informações do filtro anterior;
48
Imprimir por lote de impressão: O último ícone de impressora – ‘Impressão de Lotes’
o Colunas disponíveis:
Lote: Número do lote;
Total de Notas: Total de notas que compõem o lote;
Notas Processadas: Quantidade de notas processadas para este lote;
Status: Pendente- Está faltando Notas para completar o lote. OK- todas as
notas deste lote foram processadas;
50
Para impressão do DACTE manualmente, selecione o registro e a opção “Imprimir
DACTE”. O sistema solicitará a escolha da opção "Oficial" (com validade legal) ou "Não
Oficial" (com a marca “Sem validade Legal” no DACTE) e a definição da impressora que
receberá o documento.
o Escolha o modo de exportação: Lote XML, exporta todo o grid, porém, somente
quando o filtro está ativado. Já a opção Notas Selecionadas somente exporta as
NF-es selecionadas no grid:
Exportar XML de NFS-e: Para exportar o XML de uma NFS-e, selecione um grupo de
registros no Grid e a opção . Observação: Este botão somente estará ativo caso os
registros selecionados sejam do tipo NFS-e.
Exportar XML de DPEC: Para exportar o XML do DPEC, selecione um grupo de registros no
Grid e a opção . Observação: Este botão somente estará ativo caso a NF-e
selecionada estiver com o tipo de emissão DPEC.
Exportar XML de CT-e: Para exportar o XML do CT-e, selecione um grupo de registros no
Grid e a opção . Observação: Este botão somente estará ativo caso os registros
selecionados sejam do tipo CT-e.
52
O Painel de Controle possui a função (Reprocessamento de Nota Fiscal), que
permite configurar um grupo de Notas Fiscais para uma etapa de processamento anterior
ou posterior à atual, de acordo com o seu status. Ao selecionar um grupo de registros no
Grid o sistema verificará se alguma Nota Fiscal do grupo permite reprocessamento, se
permitir o botão ficará ativo, caso contrário será desativado e nenhuma ação pode ser
realizada. Ao clicar no botão, quando ativo, será exibida a tela de processamento de NF-
es:
Ao clicar sobre o botão (Reprocessar), todas as Notas Fiscais que estavam com o
campo “Reprocessamento” selecionado, serão reprocessadas. Existe ainda um campo
que auxilia a visualizar o estado da NF-e: “A Nota foi reprocessada com sucesso”,
“Permite Reprocessamento” e “NF-e não permite reprocessamento”;
o Funcionalidades disponíveis:
“Enviar” ;
Para cancelar o envio de um evento é necessário clicar no botão “Cancelar”
56
Gerenciar Eventos na Framework
No componente Framework é possível visualizar, criar, editar e gerenciar Eventos.
Para acessar os eventos de uma determinada NF-e é necessário acessar o Painel de Controle de
NF-e através do Menu: Painel de Controle > Notas Fiscais.
Com a NF-e selecionada é necessário clicar no botão “Exibir Eventos”. Conforme abaixo:
o Colunas disponíveis:
Enviar: Flag de Envio de E-mail.
Endereço de Email: E-mail que será enviado o XML.
Número: Número da NF-e;
Série: Série da NF-e;
58
O filtro poderá ser realizado por:
o Matriz: Filtro por Matriz;
o Filial: Filtro por Filial;
o Número da Nota: Filtro por Número de Nota;
o Série: Filtro por Série;
60
Painel de Controle Nota Fiscal de Serviço
Para visualizar a funcionalidade acessar o menu abaixo:
Atalho: NFSPCO
É através do Painel de Controle que o usuário pode gerenciar todo o ciclo de vida de um registro
de Nota Fiscal de Serviço. Este Painel permite o acompanhamento do estado de um determinado
registro.
São demonstradas as Notas Fiscais de Serviço em processo de: Geração do XML, Validação,
Transmissão, Impressão, aprovadas pelos municípios, aguardando retorno, Cancelamento e Notas
Fiscais autorizadas.
62
Reprocessar: A tela "Reprocessamento" permite, dada uma seleção realizada no Grid do
Painel de Controle do Módulo de NFS-e, definir para a etapa de processamento anterior
ou posterior à atual, de acordo com o status da nota. Para isso é necessário selecionar a
opção “Reprocessamento?” e o Status da Nota será alterado de acordo com o campo
“Status Futuro”. Para obter uma descrição detalhada do processo que será alterado é
Filtro: utilizado para realizar uma busca por Notas Fiscais de Serviço. As opções são
as seguintes:
64
Limpar Filtro: utilizado para limpar as informações do filtro anterior;
Exportar XML da NFS-e: Para exportar NFS-es em formato XML, selecione um grupo de
o Escolha o tipo de exportação: RPS, exporta o RPS emitido. Já a opção XML será
aberta as opções do tipo de XML. E deverá selecionar o caminho que o arquivo
será exportado :
66
Colunas disponíveis:
o Enviar: Flag de Envio de E-mail;
o Nro. da Nota: Número da NFS-e;
o Remetente: Endereço de e-mail do qual será enviado o e-mail;
o Data Inserção: Data de inserção da Nota Fiscal de Serviço;
Selecionados’ ;
Status Manifesto
Painel de Controle para acompanhamento do processamento das consultas de Documentos
Destinados. Cada filial parametrizada para o processo de Consulta Documentos Destinados é
indicada nesta tela, e por ela, podemos visualizar entre outras informações, o último número
sequencial consultado, o horário da próxima consulta e os status da consulta atual em anterior.
70
Consulta Situação Parceiro
Esta interface tem como objetivo atender o processo de consulta ao cadastro nacional de
contribuintes de ICMS, através da tecnologia WebService que a SEFAZ de cada estado do Brasil
oferece, permitindo que ao informar o CNPJ, CPF ou Inscrição Estadual seja possível receber as
informações cadastrais do parceiro.
Atalho: STATUSPARC
o UF: Estado do parceiro que será consultado. É utilizado como campo chave
juntamente com o campo Num. Docto. (Número do Documento Consultado);
o UF Atendida: Estado que respondeu a consulta de cadastro. Por default é a
mesma da coluna UF;
o Tipo Docto: Selecione o tipo de documento que será usado para a consulta do
parceiro;
o Num Docto: Insira os dados para a consulta do parceiro;
o Status Atual: Identifica o processo que está sendo executado no momento;
o Situação: Identifica o último evento respondido pela SEFAZ para um determinado
parceiro. O Evento Default é o 075 (Aguardando Consulta), o semáforo fica
amarelo, evento 111 (Consulta de cadastro com uma ocorrência) ou 112 (Consulta
cadastro com mais de uma ocorrência) são os eventos de sucesso na consulta, o
sistema apresentará a cor verde. Qualquer evento diferente desses, o semáforo
ficará vermelho indicando que existe alguma não-conformidade com determinada
consulta;
o Intervalo: Considera o prazo em dias para que o sistema realize uma nova
consulta;
o Próxima Atualização: É a data agendada para realizar uma nova consulta no
cadastro de parceiros. O agendamento é efetuado automaticamente ao realizar a
primeira ou nova consulta. Neste último caso, é determinada através do Intervalo
(em dias) a data da próxima consulta;
o Consulta Atual: É a data da última consulta realizada pelo processo de cadastro
de parceiros.
72
Caso não haja informações adicionais para determinado número de documento será
exibido o seguinte aviso:
Preencha os campos:
o UF: Estado do parceiro que será consultado;
o Tipo Documento: Selecionar o tipo de documento com o auxílio da lista;
o Intervalo: Considera o prazo em dias para que o sistema realize uma nova consulta;
o Número Documento: Quantidade de consultas. Esse número será utilizado para a
consulta do parceiro;
o Clique no botão .
Para alterar o parceiro, clique no botão - Editar Parceiro. Todos os campos estarão
disponíveis para alteração;
74
O Comply e-Docs permite realizar filtros de parceiros, neste caso, é necessário clicar no
botão - Filtrar;
Será apresentada a tela abaixo:
É possível escolher um ou mais itens desses filtros e em seguida executá-lo. Desta forma,
serão apenas exibidos os parceiros que atenderem aos critérios de seleção.
Atalho: PAINELSIS
Aba Processos:
Criar processo:
76
Para criar uma nova Thread (processo), clicar no botão - Incluir Processo:
Preencher os campos:
o Servidor: Selecione o servidor onde será executado;
o Módulo: Selecione o módulo (NF-e ou NFS-e) que será cadastrado;
o Processo: Determine o processo;
o Tipo de inicialização: Determine se o processo será iniciado manualmente ou
automaticamente:
Manual: Iniciar o processo manualmente;
Automático: Quando o servidor iniciar, automaticamente o processo será
iniciado.
o Tipo de Intervalo: Tipo de intervalo que o processo rodará em horas, minutos ou
segundos;
o Intervalo: Estipular o tempo para a Thread;
Filtro de Processos:
Para executar filtro por tipo de processo, clicar no botão - Filtrar Processos;
Será exibida a tela a seguir:
Preencher os campos:
o Processo: Selecionar o processo;
o Servidor: Determinar o servidor do processo;
Alterar Processo:
78
Excluir Processo:
Configurar Processo:
Permite a configuração de parâmetros especiais para alguns processos como, restringir o processo
a apenas uma ou várias UFs ou tipo de Notas Fiscais.
Para configuração especial por processo, clicar no botão - Configurar Processo. Caso o
botão esteja desabilitado, significa que o processo não possui parametrização especial.
80
Menu Cadastrar
Atalho: CADCMA
Preencha os campos:
o CNPJ: Nome do Usuário do sistema;
o Razão Social: Acesso do usuário ao aplicativo.
o Salve a operação .
Alteração de CNPJ:
Efetue a pesquisa;
Selecione o registro;
Escolha - Editar;
82
Exclusão de CNPJ:
Efetue a pesquisa;
Selecione o registro;
Escolha - Excluir;
O sistema apresentará a seguinte mensagem:
Antes de cadastrar a Faixa CEP, deve-se, primeiramente, inserir os municípios de cada Unidade
Federal (UF).
Atalho: MunicipioB
84
Inclusão de Município:
Preencha os campos:
o UF: Selecione a UF de acordo com a listagem;
o Código Município: Insira o código do município. Através do site:
http://www.ibge.gov.br/home/geociencias/areaterritorial/principal.shtm
o Campo "Informações Complementares":
Código SEF: Inserir Código SEF. (Preenchimento não obrigatório);
Ind Emite Rel: Quando selecionado, é emitido Relatório com informações
sobre Município;
Emite Re. Mov. ISS: Registrar se é emitente ou não (Preenchimento não
obrigatório);
Percentual de Rateio - DIC - SE: Inserir Percentual (Preenchimento não
obrigatório);
Cód. SIAFI: Insira o código do município. Através do site:
http://www.mi.gov.br/pt/c/document_library/get_file?uuid=3e343d1c-
d559-4845-bee6-20337340be53&groupId=10157
86
Ind Recibo ISS CNPJ: Caso possua Recibo de ISS por CNPJ, deve ser
selecionado;
Ind Imprime RG Termo: Marcando essa opção, é emitido Relatório de RG
Termo;
o Campo "Intervalo de CEP":
CEP Inicial: Código de Endereço Postal inicial do município informado;
CEP Final: Código de Endereço Postal final do município informado.
Salve a operação .
Alteração de Município:
Efetue a pesquisa;
Selecione o registro;
Exclusão de Município:
Efetue a pesquisa;
Selecione o registro;
88
Faixa de CEP
Para inserir o código de município do fator gerador, bem como do município do destinatário no
XML. O sistema verifica o número do CEP e de acordo com a faixa, é inserido o dado na NF-e.
Atalho: FACEP
Preencha os campos:
o Sigla UF: Selecione a UF;
o Município: Escolha o município com o auxílio da lista;
o CEP Inicial: Insira a faixa inicial do CEP;
o CEP Final: Registre a faixa final do CEP;
Salve a operação .
Efetue a pesquisa;
Selecione o registro;
Efetue a pesquisa;
Selecione o registro;
92
Preencher os campos, conforme indicado:
o Localidade: Informe o município desejado;
o UF: Escolha o estado em que se encontra a cidade;
Em seguida, clicar no botão BUSCAR para pesquisar a faixa de CEP da localidade
informada:
Será apresentado o resultado da pesquisa:
94
Registre o resultado no cadastro da Faixa de CEP no Comply e-Docs.
Usuário Inbound
Cadastro de usuários e senhas para autorização de uso do Client Inbound. O componente Client
Inbound ou o WS Inbound são ferramentas para inserção de XMLs no banco de dados do Comply e-
Docs, devido a sua criticidade esta operação necessita de um senha para autorização.
Atalho: USUINB
Inclusão de Usuário:
Salve a operação .
Alteração de Usuário:
Efetue a pesquisa;
Selecione o registro;
Exclusão de Usuário:
Efetue a pesquisa;
Selecione o registro;
98
Representante Legal
Para identificar os representantes legais responsáveis pela integridade das informações enviadas
à Secretaria da Fazenda, cadastre os respectivos dados.
Atalho: REPLEGAL
Salve a operação .
Se o Representante Legal estiver vinculado a outros registros, não será permitida a exclusão do
registro.
102
Índice
Um índice mede a variação dos valores monetários. Para informar o índice no qual a Matriz se
enquadra, deverão ser cadastrados os índices monetários.
Atalho: INDC
Inclusão de Índice:
104
Preencher os campos conforme indicado a seguir:
Valor Índice: Informar o Valor do Índice;
Qtd. Dias: Informar a quantidade de dias para o Índice;
Valor Rateio Dia: Informar o Valor de Rateio Diário;
Valor Rateio Mês: Informar o Valor de Rateio Mensal;
Taxa Acumulada: Informar a Taxa Acumulada;
Campo "Vigências":
Início Vigência: Data inicial de Vigência do Índice;
Término Vigência: Data Final de Vigência do Índice.
Salvar a operação .
Todos os campos são de preenchimento obrigatório.
Alteração de Índice:
Efetue a pesquisa;
Selecione o registro;
Escolha - Editar ou - Exibir detalhes do registro corrente;
Salve a operação .
Exclusão de Índice:
Efetue a pesquisa;
Selecione o registro;
Se o índice estiver vinculado a outros registros, não será permitida a exclusão do registro.
106
Matriz
A Matriz é fundamental para que o sistema localize e envie as notas fiscais à Secretaria da
Fazenda, providencie a definição de validações, prioridades de envio dos documentos e outras
funcionalidades.
Atalho: MATBSC
Inclusão de Matriz:
108
o Campo "Informações Principais":
o Razão Social: Razão Social da Matriz;
o Início Vigência: Início da Vigência do CNPJ;
o CNPJ: Número do Cadastro Nacional de Pessoa Jurídica da Matriz;
o Término da Vigência: Término da Vigência do CNPJ;
o Campo "Endereço":
Tipo Logradouro: Rua, Avenida, Via, etc.;
Logradouro: Nome da Rua, Avenida, Via onde a Matriz se situa;
Número: Número do estabelecimento onde a Matriz se situa;
Bairro: Bairro do estabelecimento onde a Matriz se situa;
Complemento: Apto, Sala, etc.;
CEP: Código de Endereço Postal da Matriz;
UF: Unidade de Federação da Matriz (selecionar na lista de auxilio ao
preenchimento);
Município: Descrição do Município conforme tabela do IBGE;
Caixa Postal: Número da Caixa Postal da Matriz;
CEP Caixa Postal: CEP da Caixa Postal da Matriz.
o Campo "Inscrições":
Código CAEF: Código de Atividade Econômica Federal referente à Matriz;
Código CNAE: Código Nacional de Atividade Estadual referente à Matriz;
Inscrição NIT: Número da Inscrição Número de Inscrição do Trabalhador
referente à Matriz;
Inscrição SUFRAMA: Número da Inscrição SUFRAMA referente à Matriz;
Inscrição Estadual: Número da Inscrição no Estado referente à Matriz;
Inscrição CEI: Número da Inscrição CEI referente à Matriz;
Dt. Opção Conv ICMS: Data da opção de Inscrição do ICMS na Junta
Comercial;
Município: Descrição do Município;
Inscrição Junta: Código de Inscrição na Junta Comercial;
Data Inscrição Junta: Data de Inscrição na Junta Comercial;
Data Inscrição Junta Conv: Data de Inscrição do Convênio na Junta
Comercial.
110
o Início Vigência: Informar a data de início da vigência do Representante Legal;
o Término Vigência: Informar a data de término da vigência do Representante
Legal;
Alteração de Matriz:
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Exclusão da Matriz:
Uma Matriz não pode ser excluída, o sistema permite a alteração do status para ‘inativo’
caso a mesma não exista no cadastro.
Filial
Para o sistema localizar as notas fiscais e enviá-las à Secretaria da Fazenda, é necessário além de
uma Matriz, uma Filial na qual será utilizada também para definição de validações, prioridades
de envio dos documentos e outras funcionalidades deste sistema.
Atalho: MNTFIL
Inclusão de Filial:
112
Preencha os campos:
o Matriz: Selecionar a Matriz a qual a Filial a ser cadastrada pertence;
o Código Filial: Criar um código que facilite a identificação da Filial;
o Nome Fantasia Filial: Informar o nome fantasia da Filial;
o E-mail: Informar o endereço eletrônico; da Filial;
o Status: Selecionar o código de uma das situações disponíveis na lista de seleção
do campo;
o DDD - Tel: Informar o código de área do telefone;
o Telefone: Informar o número do telefone;
o DDD - Fax: Código de área do telefone do fax;
o Fax: Informar o número do telefone do fax;
o Segmento de Negócio: Informar a natureza da atividade que a empresa exerce
perante o Estado.
o Aba "Centralizadora":
Clicar em - Novo;
Será exibida a tela abaixo:
Preencher os campos, conforme indicado a seguir:
Tipo Obrigação: Selecionar o Tipo de Obrigação;
Filial Associada: Selecionar a Filial Associada à Obrigação;
Início Vigência: Inicio da Vigência da Filial;
Término Vigência: Término da Vigência da Filial.
o Aba "Representantes":
Clicar em - Novo;
Será exibida a tela abaixo:
114
Preencher os campos, conforme indicado a seguir:
Tipo Representante: Selecionar o tipo de representante.
Exemplo: Representante Legal Federal;
Nome: Selecionar o nome do Representante Legal;
Início Vigência: Informar a data de início da vigência do
Representante Legal;
Término Vigência: Informar a data de término da vigência do
Representante Legal.
Clicar em - Novo;
Será exibida a tela abaixo:
Alteração de Filial:
Efetue a pesquisa;
Selecione o registro;
Altere os campos;
Salve a operação .
116
Exclusão de Filial:
Uma Filial não poderá ser excluída, o sistema permitirá a alteração do status para ‘inativo’
caso a mesma não exista no cadastro.
Inscrição ST
Quando for operação de mercadorias que se reserva para filiais que possuem Inscrições Estaduais
de Substituição Tributária, será necessário efetuar o cadastro por filial e unidade de federação
correspondente.
Atalho: INSCSTBSC
118
Será exibida a tela abaixo:
Preencha os campos:
o Matriz: Código da Matriz e Nome da Matriz;
o Filial: Filial: Código da Filial e Nome da Filial;
o Inscrição/UF: Unidade de Federação da Filial (selecionar na lista de auxilio ao
preenchimento), Inscrição Estadual Sub. Tributária: Número da Inscrição no
Estado do Substituto Tributário referente à Filial e Status: Status e descrição do
status referente ao cadastro de Inscrição Estadual de Subst. Tributária
relacionada à Filial;
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Selecione o registro;
Clique em ‘OK’.
120
Configuração de Filial
Para determinar as particularidades de cada filial, deverá ser configurado os campos na tela
“Configuração de Filial".
Atalho: CFGFIL
122
Número: Número do Credenciamento do emissor de nota fiscal
eletrônica;
Data: Determinar a data do Credenciamento;
Código do Regime Tributário: Determinar o código do Regime Tributário:
1 – Simples Nacional, 2 – Simples Nacional – excesso de sublimite de
receita bruta e 3 – Regime Normal.
o Campo "Impressão de DANFE em PDF": Marcar umas das opções disponíveis:
PDF: Somente para envio de DANFE via pdf por e-mail;
Normal: Somente envio de XML de Distribuição;
Ambos: Envio de PDF e XML de Distribuição via e-mail.
o Campo "Tipo de Emissão": Selecionar uma das opções disponíveis:
DPEC: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é DPEC;
SCAN: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é SCAN;
FS: Determina que o tipo de emissão que deve ser utilizado para aquela
filial caso o sistema Comply e-Docs esteja configurado para contingência
automática é Formulário de Segurança;
FS-DA: Determina que o tipo de emissão que deve ser utilizado para
aquela filial caso o sistema Comply e-Docs esteja configurado para
contingência automática é FS-DA;
Nenhum: Determina que não sera utilizado nenhum tipo de emissão para
contingência automática;
o Campo NFS-e Incentivador Cultural:
Determina para notas fiscais de serviço se possui incentivador cultural sim
ou não;
o Campo "E-pin":
Cadastrar diretório / local para o E-pin.
o Campo Manifesto de Destinário:
Indicador NF-e Consultada: Parâmetro utilizado para a seleção das NF-es
que serão consultadas na SEFAZ. Seus valores possíveis são: 0 – Todas as
NF-e; ou 1 – Somente as NF-e que ainda não tiveram manifestação do
destinatário (Desconhecimento da operação, Operação não Realizada ou
Confirmação da Operação); ou 2 – Idem anterior, incluindo as NF-e que
também não tiveram a Ciência da Operação;
Indicador de Emissor da NF-e: Parâmetro utilizado para a seleção de quais
Emissores serão selecionados para as NF-es consultadas na SEFAZ. Seus
valores possíveis são: 0 – Todos os Emitentes / Remetentes; ou 1 –
Somente as NF-e emitidas por emissores / remetentes que não tenham a
mesma raiz do CNPJ do destinatário (para excluir as notas fiscais de
transferência entre filiais);
Consulta Documentos Destinados: Habilita a Filial visualizada ao
Download de Documentos Destinados, ou seja, as NF-es emitidas para
esta filial serão consultadas e trazidas ao sistema.
Utiliza Manifesto Temporário: Funcionalidade em desenvolvimento.
Os campos: Matriz; Filial e Inscrição Estadual Sub. Tributária são de preenchimento obrigatório; A
prioridade para definição de contingência é a seguinte: FS, DPEC, SCAN e DPEC.
Personalização de Email
Introdução
A funcionalidade de personalização de email permite ao cliente customizar o formato como seus
emails são enviados aos destinatários da NF-e.
Os emails personalizados são criados em formato HTML e durante o processo de geração do Email,
eles recebem informações do XML de NF-e que será anexado neste mesmo email. Estas
informações podem ser utilizadas no arquivo HTML, permitindo assim, utilizar quase todas as tags
de um determinado arquivo XML para entregar mais informações da NF-e descritas no corpo do
email.
Configurações Necessárias
Para estar habilitado a enviar um email personalizado são necessárias algumas configurações no
sistema Comply e-Docs.
Configuração de Filial:
É necessário configurar o nome dos arquivos HTMLs utilizados para a geração do email
personalizado em HTML.
124
Os nomes destes arquivos devem bater com os arquivos encontrados na pasta HTML do Comply e-
Docs Server:
Personalizar o HTML
É possível personalizar o arquivo HTML com qualquer ferramenta de mercado de
desenvolvimento. Em nosso exemplo utilizaremos o MS Visual Studio 2010.
• Para Email de Distribuição de NF-e: Somente informações disponíveis até o terceiro grupo
hierárquico. Exemplo:
[dest].[xNome] – Neste caso será extraído a Razão Social do destinatário;
[total].[ICMSTot].[vNF] – Neste caso será extraído o Valor Total da Nota.
*Não recomendamos utilizar as tags do grupo prod dado que não é possível extrair informações
em nível de item.
126
Alteração de Configuração da Filial:
Efetue a pesquisa;
Selecione o registro;
Selecione o registro;
Clique em "OK".
Configuração de Matriz
Para determinar as particularidades de cada Matriz, deverão ser configurados os campos na tela
“Configuração de Matriz”.
Atalho: CFGMAT
128
Selecione a opção - Novo;
Será exibida a tela abaixo:
Preencha os campos:
o Matriz: Selecionar o Código da Matriz;
o Campo "Usar certificado global": Determina se o certificado utilizado para
assinatura de XMLs é global, ou seja, se é utilizado para assinar XMLs emitidos por
todas as filiais relacionadas a ela. Caso a configuração seja não, será necessário
possuir um certificado para cada filial. Selecionar uma das opção disponíveis:
"Sim" ou "Não";
o Campo "Usar nome fantasia": o Determina se será utilizado nome fantasia para a
matriz selecionada. Selecionar uma das opção disponíveis: "Sim" ou "Não";
o Campo "HSM":
o Usuário: Determina se o usuário de autenticação no Servidor HSM;
o Senha: Determina a senha do usuário de autenticação no Servidor HSM;
o URL: Determina o endereço do Servidor HSM;
o Chave do Certificado: Determina a Chave Pública do Certificado no
Servidor HSM;
o Identificação do Certificado: Determina o Identificador do Certificado de
autenticação no Servidor HSM.
o Campo "Encriptado": Determina se o método de comunicação com o Servidor
HSM utiliza criptografia. Selecionar uma das opção disponíveis: "Sim" ou "Não";
o Campo "Utiliza Load Balance": Determina se o método de comunicação com o
Servidor HSM utiliza balanceamento de carga. Selecionar uma das opção
disponíveis: "Sim" ou "Não";
o Biblioteca: Determina a biblioteca (.dll) a ser utilizada pelo sistema para acesso
ao sistema ao HSM;
o Classe: Determina a biblioteca (.dll) a ser utilizada pelo sistema para acesso ao
sistema ao HSM.
Os campos: Matriz, Usar Certificado Global e Usar Nome Fantasia são de preenchimento
obrigatório; A utilização de HSM não é obrigatória. As configurações descritas são compatíveis
apenas com o HSM da True Access modelo Net-D Fence.
Efetue a pesquisa;
Selecione o registro;
130
Exclusão de Configuração da Matriz:
Selecione o registro;
Clique em ‘OK’.
Configuração Municipal de Filial
Para determinar as particularidades de cada filial para cada município, deverá ser configurado os
campos na tela “Configuração Municipal de Filial".
Atalho: NFSCFILIAL
132
Selecione a opção - Novo;
Será exibida a tela abaixo:
Preencha os campos:
134
o Matriz: Código da Matriz e Nome da Matriz;
o Filial: Código da Filial e Nome da Filial;
o Ambiente: Selecionar o ambiente que a filial se posiciona no momento
(Homologação/Produção);
o AEDF: Código da AUTORIZAÇÃO DE EMISSÃO DE DOCUMENTOS FISCAIS;
o Regime Especial de Tributação: Campo de seleção do Regime Especial de
Tributação, utilizado para o município que possui leiaute ABRASF;
o Op. Simples Nacional: Selecionar se a filial é Simples Nacional;
o Impressão de Nota Fiscal de Serviço: Opções de “Imprimir”, “Salvar e PDF”, os
dois tipos, ou nenhum deles;
o Impressão de Recibo Provisório de Serviços: Opções “Impressão Automática”,
para a impressão automática do RPS, “Para Processo no Caso de Erro”, para a
paralização do processo caso ocorra erro de impressão do RPS;
o Nome do Logo: Preencher com o nome do logo salvo na pasta “...\Comply e-Docs
Server 4.0\NFS\Imagens” para ser impresso na Nota Fiscal de Serviço e RPS;
o Brasão da Prefeitura: Preencher com o nome do logo do brasão da prefeitura
salvo na pasta “...\Comply e-Docs Server 4.0\NFS\Imagens” para ser impresso na
Nota Fiscal de Serviço e RPS;
o Envio de E-mail:Opções de envio de “PDF”, “XML”, os dois tipos e nenhum deles;
o E-mail Remetente: Campo para cadastrar o e-mail do Remetente para o envio da
Nota;
o E-mail Destinatário: Campo para cadastrar o e-mail do Destinatário do envio da
Nota;
o Assunto E-mail: Campo para cadastrar o assunto do e-mail;
Efetue a pesquisa;
Selecione o registro;
Selecione o registro;
Clique em "OK".
136
Servidor
Local onde se encontra o Comply e-Docs Server da NF-e.
Atalho: CADSERV
Inclusão de Servidor:
Selecione o botão - Novo;
Será exibida a seguinte tela:
Preencha os campos:
o Código Servidor: Código do servidor no sistema;
o Descrição: Descrição do servidor no sistema;
o URL: É o nome (hostname) do servidor;
o Número máximo de threads: Informação que define o limite de Threads que o
servidor suporta;
o Salve a operação .
Alteração de Servidor:
Efetue a pesquisa;
Seleciono registro;
138
Salvar a operação .
Exclusão de Servidor:
Selecionar o registro;
Clique em "OK".
Atalho: USU
Inclusão de Usuário:
140
Preencha os campos:
o Usuário: Nome do Usuário do sistema;
o Login: Acesso do usuário ao aplicativo;
o Senha: Senha do usuário novo;
o Active Directory Id: Identificador utilizado quando o usuário acessa o sistema
diretamente após ter efetuado o login na rede (poderá ser usado o mesmo login
de rede do usuário);
o Endereço Eletrônico: E-mail do usuário;
o Grupo: Restringe o acesso às funções do sistema;
o Unidade de Negócio: Filial do usuário.
o Ativo: Opção utilizada para definir se o usuário é ativo no sistema, caso
contrário, não marque este campo.
o Salve a operação .
Os campos: Usuário e Login são de preenchimento obrigatório.
Alteração de Usuário:
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Exclusão de Usuário:
Efetue a pesquisa;
Selecione o registro;
Se o usuário estiver vinculado a outras operações do sistema, como a uma filial, não será
permitida a exclusão do registro.
142
Usuário x Filial
Para atrelar as filiais de acesso por usuário, deverá ser realizadas algumas parametrizações na
tela "UsuárioXFilial".
Atalho: ASCUSUFIL
Selecione o Usuário que deverá ter acesso às filiais;
Escolha a Matriz;
O sistema listará todas as filiais existentes para a Matriz selecionada;
Replique os dados do campo “Filiais Não Selecionadas” para “Filiais Selecionadas”
através da opção ;
Para selecionar todas as filiais e direcionar para a coluna à esquerda ‘Filiais Selecionadas’,
clique em , permitindo o acesso a todas as filiais para o usuário; para retirar a autorização
das filiais do usuário, faça o mesmo procedimento da inclusão, na direção dos campos Filiais Não
Selecionadas, através das opções ou .
144
Impressora
Para impressão automática do DANFE, é necessário determinar a impressora que irá emitir o
documento, ela deverá estar vinculada a uma Matriz/ Filial e / ou a um usuário e um local de
expedição para que o aplicativo efetue esta operação.
Nesta operação ocorre também a determinação do tipo de DANFE que será impresso na
impressora cadastrada, Normal ou em Contingência.
Atalho: IMP
Inclusão de Impressoras:
Selecione a opção - Novo;
Será exibida a tela a seguir:
Preencha os campos:
o Código Impressora: Código informado pelo usuário ao criar um cadastro novo de
Impressora;
o URL: Endereço da rede onde a impressora está localizada;
o Nome da Impressora: Nome da impressora cadastrada na rede da empresa;
Alteração de Impressoras:
Efetue a pesquisa;
Selecione o registro;
Todos os campos estarão disponíveis para alteração, exceto o campo Código Impressora.
Altere os campos;
146
Salve a operação .
Exclusão de Impressoras:
Selecione o registro;
Se a impressora estiver vinculada a uma Matriz / Filial, não será permitida a exclusão do
registro.
Impressora x Filial
Cada impressora deverá ser parametrizada, para garantir maior flexibilidade e disponibilidade de
impressoras nas filiais.
Atalho: IMF
148
Preencha os Campos:
o Cód. Impressora: Código da Impressora já determinado no ato de cadastrar a
impressora;
o Usuário Nota Fiscal: Usuário que emitiu a nota fiscal na origem;
o Local de Expedição: Local de expedição do sistema de origem;
o Tipo de Impressão: Tipo de documento que será impresso na impressora, Todos,
Normal, FS (Formulário de Segurança), SCAN, DPEC, FSDA;
o Vias: Quantidade de Vias para a impressão;
o Matriz: Código da Matriz (selecionar na lista de auxilio ao preenchimento);
o Filial: Código da Filial (selecionar na lista de auxilio ao preenchimento);
o Salve a operação .
Todos os campos são de preenchimento obrigatório, exceto os campos: Usuário da Nota Fiscal
e Local de Expedição.
Efetue a pesquisa;
Selecione o registro;
Escolha - Editar ou - Exibir detalhes do registro corrente;
Altere os campos;
Salve a operação .
Selecione o registro;
150
Web Services Estadual
Para a comunicação entre o emitente de Nota Fiscal Eletrônica e a SEFAZ, em função de envio e
recepção de mensagens/ lotes de notas fiscais gerados pelo aplicativo por WebServices da
Secretaria da Fazenda, será necessária a definição de um endereço, que deverá estar vinculado a
UF da SEFAZ que processará as notas fiscais eletrônicas.
O pw. NF-e disponibiliza duas (02) opções de cadastramento, uma cadastra o endereço do
WebService e outra que vincula este WebService a Unidade de Federação.
Atalho: WS
Selecione os campos no filtro de pesquisa para listar as impressoras cadastradas no
sistema:
Inclusão do WebService:
Selecione a opção - Novo;
Será exibida a tela a seguir:
Preencha os campos:
o Código Serviço: Código informado pelo usuário;
o Status: Status do Serviço;
152
o Código de WS Manifesto: Utilizado para redirecionar os envios de Eventos para
NF-es de Inbound e os Métodos de Documentos Destinados e Download NF-e.
Atualmente a única UF que possui ambiente para estes tipos de envio é “RS”. As
demais UFs devem utilizar o Ambiente Nacional. Abaixo um exemplo de
preenchimento do Ambiente Nacional.
o Descrição: Descrição do serviço;
o Cabeçalho: Definir cabeçalho Padrão;
o Método de Envio de Lote: Endereço (IP, URL etc.) para envio de lote;
o Método de Solicitação do Lote: Endereço (IP, URL etc.) para solicitação de lote;
o Método de Cancelamento: Endereço (IP, URL etc.) para cancelamento de lote;
o Método de Consulta: Endereço (IP, URL etc.) para consulta de lote;
o Método de Consulta do Status: Endereço (IP, URL etc.) para verificação de status
do lote;
o Método de Inutilização: Endereço (IP, URL etc.) para inutilização do lote;
o Método de Consulta Situação Cliente: Endereço (IP, URL etc.) para verificação
da situação do cliente na SEFAZ;
o Método de Evento: Endereço (IP, URL etc.) para verificação do Método utilizado;
o Metodo de Consulta Documentos Destinados: Endereço (IP, URL etc.) para
verificação do Método utilizado;
Metodo de Download NF-e: Endereço (IP, URL etc.) para verificação do Método
utilizado;
Salve a operação .
Exemplo de Preenchimento do WS do Ambiente Nacional:
Alteração de WebService:
154
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Selecione o registro;
Se a WebService estiver vinculada a uma UF, não será permitida a exclusão do registro.
WebService x UF
Cada Estado do Brasil possui seus respectivos WebServices, para associá-los por Unidade Federal,
parametrize a tela WebService por UF.
Atalho: WSUF
Associar UF a um WebService:
o Salve a operação .
158
WebService x Filial
Cada Estado do Brasil possui seus respectivos WebServices, para associá-las por Filial,
parametrize a tela WebService por Filial.
Somente realize este cadastro caso seja estritamente necessário para o negócio da empresa.
Atalho: WSF
Preencha os Campos:
o Holding: Selecione a Holding;
o Matriz: Selecione a Matriz;
o Filial: Selecione a Filial;
o WebService: Selecione o WebService parametrizado no cadastro de WebServices,
no subitem 1 do item 7 deste manual (selecione na lista de auxilio ao
preenchimento);
o Tipo de Ambiente: Selecione o Tipo de Ambiente;
o Tentativas: Defina o número de tentativas de conexão com o WebService. No
caso de falha na comunicação com a SEFAZ, o Comply e-Docs tentará o número
de vezes determinado neste parâmetro antes de determinar que uma NF-e não
pode ser transmitida;
o Ordem: Defina a Ordem de prioridade deste WebService.
o Salve a operação .
Todos os campos são de preenchimento obrigatório.
160
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Efetue a pesquisa;
Selecione o registro;
Atalho: NFSWEBSER
162
Inclusão do WebService:
Preencha os campos:
o Cód. Serviço: Código informado pelo usuário;
o Status: Status do Serviço;
o Descrição Serviço: Descrição do serviço;
o URL Envio: Endereço para envio do lote;
o URL Consulta: Endereço para consulta do lote;
o URL Cancelamento: Endereço para cancelamento do lote;
Salve a operação .
Alteração de WebService:
Efetue a pesquisa;
Selecione o registro;
Todos os campos estarão disponíveis para alteração, exceto o campo "Cód. do Serviço".
Altere os campos;
Salve a operação .
Selecione o registro;
Atalho: WSUF
166
Selecione a opção - Novo;
Será exibida a tela a seguir:
Preencha os Campos:
o Cód. Serviço: Determinar qual serviço no qual está vinculadas as WebService;
o UF: Unidade de Federação do WebService (selecione na lista para auxilio ao
preenchimento do município);
o Município: Determinar qual município será vinculado ao Serviço;
o Número Tentativas: Defina o número de tentativas de conexão com o
WebService. No caso de falha na comunicação com o município, o sistema tentará
o número de vezes determinado neste parâmetro antes de determinar que uma
NFS-e não pode ser transmitida;
o Intervalo Tentativas: Defina o número de intervalos, em segundos, para cada
tentativa de conexão com a WebService;
Salve a operação .
Altere os campos;
Salve a operação .
Efetue a pesquisa;
Selecione o registro;
168
Menu Relatórios
Eventos
Para a geração de relatório por eventos das notas fiscais, o aplicativo disponibiliza critérios para
a visualização das informações. Este relatório deve ser utilizado quando se deseja verificar um
determinado tipo de status e quais NF-es apresentaram esse status.
Atalho: RELEVEN
Aba Parâmetros:
Preencher os campos conforme indicado a seguir:
Matriz: Escolha a Matriz;
Filial: Selecione Filial;
Data Emissão inicial: Marque a data da emissão da nota inicial;
Data Emissão final: marque a data da emissão da nota final;
Nota Fiscal: Insira o número da Nota Fiscal Eletrônica;
Evento: Selecione o evento;
Tipo Nota: Determine 0 (zero) para Entrada e 1 (um) para Saída;
Grupo Evento: Determine o grupo de eventos do sistema;
Série: Número da série da nota fiscal;
Tipo de Emissão: Informe N para nota fiscal normal e C para nota fiscal
contingência.
170
Aba Opções do Relatório:
Aba Agendamento:
Preencher os campos conforme indicado a seguir:
Tipo de Agendamento:
Executar agora: Imediatamente a execução do relatório.
Agendar: Agende o horário para executar o relatório. Ao
selecionar esta opção, será habilitado o campo “Informações de
Agendamento”.
Condicional: Insira uma condição para o relatório. Ao selecionar
esta opção, será habilitado o campo “Condições para execução”.
Ao selecionar esta opção o sistema exibe o campo "Condição para
execução":
172
Intervalo entre verificações (minutos): Determine em quanto
tempo o relatório irá utilizar a condição descrita na "Função de
verificação":
Função de verificação (C#): Insira a rotina de programação para
o relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
Clicar em “OK”.
Relatório:
174
Relatório de Manifesto
Este relatório deve ser utilizado para verificar NF-es de Inboun juntamente com seus eventos de
Manifesto do Destinatário.
Atalho: RELMAN
176
Clicar no botão - Novo, para gerar o relatório;
Aba Parâmetros:
Atalho: RELOGNOTAS
Aba Parâmetros:
178
Preencher os campos conforme indicado a seguir:
o Matriz: Escolha o dado solicitado;
o Filial: Selecione a Filial;
o Data Inicio: Data que se iniciou o log;
o Data Final: Data que se finalizou o log;
o Nota Fiscal: Insira o número da nota fiscal eletrônica;
o Tipo Nota: Determine 0 (zero) Entrada e 1 (um) Saída;
o Grupo Evento: informe o grupo de eventos do sistema;
o Descrição: Insira a descrição do log;
Aba Agendamento:
180
Preencher os campos conforme indicado a seguir:
Tipo de Agendamento:
Executar agora: Imediatamente a execução do relatório.
Agendar: Agende o horário para executar o relatório. Ao
selecionar esta opção, será habilitado o campo “Informações de
Agendamento”.
Condicional: Insira uma condição para o relatório. Ao selecionar
esta opção, será habilitado o campo “Condições para execução”.
Ao selecionar esta opção o sistema exibe o campo "Condição para
execução":
Intervalo entre verificações (minutos): Determine em quanto
tempo o relatório irá utilizar a condição descrita na "Função de
verificação":
Função de verificação (C#): Insira a rotina de programação para
o relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
Clicar em “OK”.
182
Notas Reimpressas
Este relatório deve ser utilizado para verificar quais NF-es foram reimpressas pelos usuários.
Atalho: RELNOTREI
Aba Parâmetros:
Preencher os campos conforme indicado a seguir:
Matriz: Selecione o dado solicitado;
Filial: Escolha a Filial;
Data de emissão inicial: Data de emissão da nota inicial;
Data de emissão final: Data de emissão da nota final;
Data de reimpressão inicial: Data de reimpressão da nota inicial;
Data de reimpressão final: Data de reimpressão da nota final;
Evento: Selecione o evento;
Usuário: Determine o usuário;
Tipo de emissão: Informe N para nota normal e C – NF contingência.
Nota Fiscal: Insira o número da nota fiscal eletrônica;
Série: Insira o número da série;
Impresso (S - Sim/ N - Não): Selecionar se a nota foi impressa ou não.
184
Aba Opções do Relatório:
Aba Agendamento:
Preencher os campos conforme indicado a seguir:
Tipo de Agendamento:
Executar agora: Imediatamente a execução do relatório.
Agendar: Agende o horário para executar o relatório. Ao selecionar esta
opção, será habilitado o campo “Informações de Agendamento”.
Condicional: Insira uma condição para o relatório. Ao selecionar esta
opção, será habilitado o campo “Condições para execução”. Ao
selecionar esta opção o sistema exibe o campo "Condição para
execução":
186
Intervalo entre verificações (minutos): Determine em quanto tempo o
relatório irá utilizar a condição descrita na "Função de verificação":
Função de verificação (C#): Insira a rotina de programação para o
relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
Clique em “OK”.
Menu Gerência
Regras de Validação Por Filial
Determinam as informações da Nota Fiscal que devem ser pré-validadas, antes do envio a SEFAZ.
O Comply e-Docs possui regras definidas que não permitem que uma nota fiscal com
inconsistências seja inserida em um lote e emitida à Secretaria da Fazenda. Estas validações são
opcionais.
Atalho: VALIDAINF
Clique em - Editar;
Escolha uma Matriz de acordo com a listagem;
188
Selecione uma ou todas as Filiais de acordo com a listagem;
Replique as Validações das Configuráveis para Validações Configuradas através da opção
;
Salve a operação .
O sistema permite a inclusão de todas as validações para as filiais, desta forma selecione a opção
; é possível retirar a validação da nota fiscal para determinadas filiais, neste caso efetue o
mesmo procedimento utilizado para inclusão, na direção dos campos Validações Configuradas
para Validações Configuráveis e selecione as opções ou ; as configurações podem ser
efetuadas para todas as filiais em um mesmo cadastro, selecione a Filial. O Comply e-Docs
considera que todas as filiais da Matriz possuem as regras de validações determinadas; os
preenchimento dos campos Matriz e Filial são obrigatórios.
Versão Municipal de XML
Este parâmetro define as versões de XML que são utilizadas pelo sistema para comunicação e
validação de acordo com o Schema XSD.
Atalho: NFSVERSIMU
Preencha os Campos:
190
o UF: Unidade de Federação de vinculo com o leiaute do XSD e de geração de XML
(selecione na lista para auxilio ao preenchimento do município);
o Município: Determinar qual município será vinculado ao leiaute XSD e de geração
do XML;
o Nome da Dll: Descrição da Dll;
o Nome do Objeto: Nome do Objeto que utilizará essa Versão de XML;
o Ação: Descrição da Ação do XML;
o Versão XSD: Versão do XSD;
o Caminho XSD: Caminho da máquina onde se localiza o XSD desta versão de XML
na máquina onde o Serviço: “Comply e-Docs Server da NFS-e” é executado;
o Caminho XML: Caminho da máquina onde se salvar o XML gerado;
Salve a operação .
Selecione o registro;
Clique em - Editar;
Altere os campos;
Salve a operação .
Regras de Priorização
As regras de priorização servirão para definir a prioridade de envio do lote para a Secretaria da
Fazenda, de acordo com esta parametrização, o pw. NF-e gera o lote fiscal e o insere na fila de
saída. As prioridades podem ser definidas também pelos atributos mais importantes do
documento, ou seja, informações que determinam a importância da Nota Fiscal quanto ao
negócio do contribuinte (Exemplo: CFOP de vendas, CNPJ do cliente de maior faturamento,
Matriz / Filial que possui maior movimento de faturamento, etc.).
Atalho: PRIORI
192
Inclusão da Prioridade:
Alteração da Prioridade:
Selecione o registro;
Clique em - Editar;
Salvar a operação .
Exclusão da Prioridade:
Efetuar a pesquisa;
Selecionar o registro;
O sistema não permite a exclusão de uma regra de prioridade, somente a alteração das regras já
existentes.
Selecione o registro;
Aba CFOP:
Selecione a opção - Novo;
Preencha os Campos:
Cód. CFOP: Código Fiscal da Operação da nota fiscal;
Dígito: Digito do Código fiscal de operação;
Salve a operação .
O campo CFOP é de preenchimento obrigatório; para exclusão de um ou mais CFOP,
selecione o registro e "Excluir".
Aba Matriz/Filial:
196
Selecione a opção - Novo;
Escolha a Matriz de acordo com a listagem;
Filial de acordo com a listagem;
Salvar a operação .
o Salve a operação .
Para exclusão de uma ou mais Filiais, selecione o registro e "Excluir".
198
Selecione a opção - Novo;
Preencha os Campos:
o Tipo de Ordem: Relacionado à venda da operação;
o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".
Aba Série:
Selecione a opção - Novo;
Preencha os Campos:
o Série: número da série da nota fiscal;
o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".
200
Selecione a opção - Novo;
Preencha os Campos:
o Tipo de Nota Fiscal: Tipo de nota fiscal que determinada pela Categoria no
sistema de origem;
o Salve a operação .
Para excluir uma ou mais Filiais, selecione o registro e clique no botão "Excluir".
Atalho: PARAMPAD
Alteração de Regras:
202
Selecione o grupo e em seguida o registro que será alterado;
Preencha campo ‘Valor’ de acordo com o parâmetro:
204
Parâmetros do Grupo Contingência:
Código do WebService
Inbound que contém os
cod_ws_scan_inbound_prd endereços para Alfanumérico
comunicação com o SCAN
no ambiente de produção.
Determina que se o
sistema estiver em
contingência automática 'N' ou 'S'
utiliza_scan
os tipos de emissão das
NF-es serão convertidos
para SCAN.
206
Parâmetros do Grupo - Configuração de Desempenho:
208
Parâmetros do Grupo - Configuração de E-mail:
210
Parâmetros do Grupo - Configurações de Impressão:
Determina o intervalo em
segundos entre tentativas
impressoes_danfe_logo Numérico
de conexão com um
WebService.
Determina se será
utilizado HTML ou Crystal “HTML” ou
visualizacao_impressao_danfe
para visualizar e imprimir “CRYSTAL”
DANFEs.
Parâmetros do Grupo - Configurações de Log do Sistema:
212
Parâmetros do Grupo - Configurações do Painel de Controle:
214
Parâmetros do Grupo - Configurações de SMTP:
216
Parâmetros do Grupo - Configurações de WebService:
Determina o tipo de
tipo_cliente_oil Cliente Oil R - Refinaria ou ‘R’ ou ‘D’
D – Distribuidora.
Determina se o campo
NUM_NF será utilizado para
utiliza_chave_acesso_num_nf ‘S’ ou ‘N’
a geração da chave de
acesso.
220
Parâmetros do Grupo - Configurações de NFSE:
Determina o número
máximo de registros
maximo_registros_timeout Numérico
selecionados pelo processo
de Time-out.
Maximo de registros para
serem selecionadas pelo
maximo_registros_cancelamento Numérico
Gerenciador de
Cancelamento de NFSe.
Nome do XSD de
xsd_cancelamento_nfse Alfanumérico
Cancelamento de NFSe.
Parâmetros do Grupo - Configurações de INTEG:
Determina o número
máximo de registros
maximo_processamento_retorno_lote_nfse Numérico
selecionados pelo processo
de retorno de lote NFS-e.
Determina o número
máximo de registros
maximo_processamento_lote_nfse Numérico
selecionados pelo processo
de envio de lote NFS-e.
Determina o número
maximo de tentativas de
conexao com um
maximo_tentativas_nfse Numérico
WebService de NFS-e antes
de alterar a nota para
status de erro.
Determina a observação
mensagem_padrao_nfse padrão para o XML do NFS- Alfanumérico
e.
Determina o intervalo em
segundos entre tentativas
intervalo_retry_nfse Numérico
de conexao com um
WebService de NFS-e.
Determina o número
máximo de registros
maximo_cancelamento_nfse Alfanumérico
selecionados pelo processo
de Cancelamento de NFS-e.
222
Determina a mensagem
mensagem_padrao_cancelamento_nfse padrão para a justificativa Alfanumérico
de Cancelamento do NFS-e.
Parâmetros do Grupo INBO - Configurações de Inbound:
Salve a operação .
Informações do Sistema de Origem
Nesta transação é configurada a conexão entre o sistema Comply e-Docs e os mais diversos
sistemas, incluindo o ERP da SAP.
São configuradas interfaces de entrada e saída de informações, além de uma interface padrão
para o recebimento de XMLs de Inbound.
226
Inclusão de Parâmetro para Informações do Sistema de Origem:
Selecione o registro;
Clique em - Editar;
Todos os campos estarão disponíveis para alteração, exceto o campo "Cód. Interface".
Altere os campos;
Salve a operação .
Selecione o registro;
230
Confirme ou não a exclusão.
Eventos por Usuário
Esta transação permite configurar o envio de email a um usuário quando ocorrem determinados
status no sistema Comply e-Docs.
Por exemplo, se for necessário o aviso de quando uma NF-e é cancelada, é possível determinar
que um usuário deva receber uma notificação por email.
Atalho: EVENTOUSU
Preencha os Campos:
232
o Matriz: Matriz;
o Filial: Filial;
o Usuário: Usuário;
o Grupos de Eventos: Grupo de Eventos para a verificação;
Selecione o registro;
Clique em - Editar;
Selecione os Status desejados;
Salve a operação .
Gerenciar Versão de XML
Este parâmetro define as versões de XML que são utilizadas pelo sistema para comunicação e
validação de acordo com o Schema XSD.
Atalho: GVXML
Preencha os Campos:
o Ação: Descrição da Ação do XML;
o Versão: Versão do XSD;
o Nome da Dll: Descrição da Dll;
o Nome do Objeto: Nome do Objeto que utilizará essa Versão de XML;
o Caminho do XSD: Caminho da máquina onde se localiza o XSD desta versão de
XML na máquina onde o Serviço: “Comply e-Docs Server da NF-e” é executado;
o Salve a operação .
234
Selecione o registro;
Clique em - Editar;
Todos os campos estarão disponíveis para alteração.
Altere os campos;
Salve a operação .
Controle de Acesso
Deve existir um Grupo para cada usuário que será determinado no Controle de Acesso. Este estará
associado a uma atividade que possui determinadas transações (operações e funções) que serão
acessadas. Inicialmente cria-se um Grupo e uma Atividade, associa transações a esta Atividade e
vincula o Grupo à Atividade.
Grupo
Para visualizar a funcionalidade acesse o menu indicado abaixo:
Atalho: GRP
Inclusão do Grupo:
Preencha os campos:
o Grupo: Informe o nome do Grupo;
o Ativo: Define se o Grupo está ativo ou inativo no sistema;
o Salve a operação .
236
O preenchimento do campo Grupo é obrigatório.
Alteração de Grupo:
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Exclusão de Grupo:
Efetue a pesquisa;
Selecione o registro;
Atalho: ROLE
Inclusão da Atividade:
o Salve a operação .
O preenchimento de todos os campos é obrigatório.
Alteração da Atividade:
Efetue a pesquisa;
Selecione o registro;
Salve a operação .
Exclusão da Atividade:
Efetue a pesquisa;
Selecione o registro;
240
Atividade x Transação
Para visualizar a funcionalidade acesse o menu abaixo:
Atalho: ROT
Clique em - Editar;
Replique as "Transações Não Selecionadas" para "Transações Selecionadas", através da
opção ;
Salve a operação .
Para acesso às transações como Somente Leitura, escolha no campo "Transações
Selecionadas" o (s) item (s) que serão somente visualizados pelo usuário e em seguida a
opção "Somente Leitura". O usuário não terá acesso à inclusão, alteração e exclusão da
tela;
O sistema lista todos os objetos pertencentes ao Painel de Controle e será necessário
selecioná-las de acordo com os acessos permitidos pela atividade cadastrada e salvar.
242
Selecione a opção para ter acesso a todas as transações; Para retirar as transações
relacionadas à atividade, efetue o mesmo procedimento adotado para inclusão, na direção do
campo Transações Selecionadas para Transações Não Selecionadas, através das opções ou
os campos Atividade e Aplicação são obrigatórios.
Salve a operação .
244
Atividade x Grupo
Para visualizar a funcionalidade, acesse o menu abaixo:
Atalho: GRPROLE
Escolha o Grupo;
Selecione o grupo;
Clique em - Editar;
246
Altere a Atividade que fará parte do Grupo;
Salve a operação .
Selecione o Grupo;
Escolha a Atividade;
Clique em - Excluir;
O sistema apresentará a seguinte mensagem:
Confirme ou não a exclusão.
248
Processar Data Clean
Esta transação pode ser utilizada para realizar uma limpeza das NF-es armazenadas no banco de
dados quando já armazenadas.
Caso não nenhum processo de Arquivamento esteja configurado a transação não excluirá nenhum
registro da base de dados, mesmo executando o Job.
Atalho: DTC
Aba Parâmetros:
Preencher os campos conforme indicado a seguir:
Número Limite de Registros: É a quantidade máxima de registros que serão
excluídos por execução do Job;
Apagar Notas Anteriores: É a quantidade de dias anteriores à execução do Job
que será considerada para a exclusão dos registros;
Aba Agendamento:
250
Preencher os campos conforme indicado a seguir:
Tipo de Agendamento:
Executar agora: Imediatamente a execução do relatório.
Agendar: Agende o horário para executar o relatório. Ao selecionar esta
opção, será habilitado o campo “Informações de Agendamento”.
Condicional: Insira uma condição para o relatório. Ao selecionar esta
opção, será habilitado o campo “Condições para execução”. Ao
selecionar esta opção o sistema exibe o campo "Condição para
execução":
Intervalo entre verificações (minutos): Determine em quanto tempo o
relatório irá utilizar a condição descrita na "Função de verificação":
Função de verificação (C#): Insira a rotina de programação para o
relatório, na linguagem C#.
o Executar: Quando será executado;
o Data: A data que será executada a geração do relatório;
o Hora: A hora que será executado a geração do relatório;
Clique em “OK”.
252
Modelo Operacional SAP
O componente ABAP é constituído pelo programa extrator, responsável pela extração de
informações de NF-e; pelo painel de controle, que é o programa que auxilia a visualização do
status atual de envio da NF-e; por parâmetros que definem quais notas fiscais devem ser
extraídas e a determinação de contingência e demais constantes do sistema; e por alguns
programas adicionais que facilitam a verificação e correção de erros.
O extrator permite que as informações sejam enviadas ao componente Comply e-Docs Server do
sistema Comply e-Docs.
O Comply e-Docs Server, por sua vez, realiza a tarefa de gerar o arquivo XML, gerenciar o envio e
retorno do arquivo XML à SEFAZ ou ao Módulo de Nota Fiscal Eletrônico de Serviço, e enviar o
status de retorno ao sistema de origem. O sistema Comply e-Docs pode se comunicar com
diversos sistemas de origem, porém, neste documento, trataremos apenas o SAP.
Quando executado, o extrator irá verificar se existem novas notas para envio. A extração é
realizada de forma sequencial através de um controle standard de docnum.
O usuário pode definir se o programa extrator deve ser executado manualmente ou
automaticamente. Se executado manualmente, as notas consideradas para extração deverão
estar definidas no range de docnum, configurado na transação de parâmetros.
Se o extrator for configurado para trabalhar automaticamente, as notas fiscais serão extraídas a
partir do último docnum extraído. Este docnum será gravado na transação de parâmetros. Neste
formato, o extrator apenas pode ser executado através de RFC (Remote Function Call). O
componente responsável por realizar a chamada da RFC é o Comply e-Docs Server do sistema
Comply e-Docs.
Quando extraídas, as notas fiscais são recebidas pelo componente Comply e-Docs Server que as
enviará à SEFAZ ou ao Módulo de Nota Fiscal Eletrônico de Serviço. No momento em que a SEFAZ
ou o Módulo NFS-e retorna as informações ao Comply e-Docs Server, o status da nota é
encaminhado ao SAP via RFC. O componente Comply e-Docs Server executará uma função -
deverá gravar o status de retorno da nota fiscal.
Além do retorno das informações, a função de retorno tem a capacidade de chamar programas de
impressão, como, por exemplo, um programa SAP Script ou ainda um formulário Smart Forms,
que podem ser utilizados para a impressão do DANFE.
Parâmetros (/PWS/ZNFEM000)
A transação “Parâmetros” permite configurar informações para que o componente ABAP do
sistema e-Docs atenda diversos tipos de cenário de acordo com necessidades específicas. Nesta
transação, são configurados parâmetros referentes à interface, modo de extração e (outras)
informações para o programa “Painel de Controle”.
Código da Holding: Campo obrigatório. Campo chave nos produtos da Sonda utilizado
para identificar um cliente no banco de dados.
Tipo de Interface: A opção “e-Docs” deve ser selecionada para que as notas sejam
enviadas ao componente Comply e-Docs Server do sistema e-Docs através de RFC.
Nesta seção deverão ser parametrizados todos os códigos de Impostos que o cliente utiliza e a
descrição destes respectivos impostos. Estes códigos de imposto são padronizados nos produtos da
Sonda, portanto podem ser utilizados os mesmos códigos utilizados no programa pw.SATI.
256
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Código SAP X e-Docs
Nesta seção deverão ser parametrizado os de/para dos impostos entre o SAP e o código utilizado
pelo sistema e-Docs. Além disso, deverá ser cadastrada a modalidade de base de calculo para o
ICMS. O programa extrator efetua este de/para antes de enviar os dados de imposto ao
componente Comply e-Docs Server.
Grupo de Impostos SAP: Coluna de preenchimento obrigatório. Deve ser preenchida com
os impostos encontrados no SAP. É possível utilizar o Matchcode.
Nesta seção deverão ser parametrizados todos os códigos de Incoterms SAP e suas respectivas
modalidades de frete.
Nesta seção deverão ser parametrizados todos os códigos de tributação do IPI do SAP
correspondentes aos códigos de situação tributária do IPI da SEFAZ.
Tributação IPI SAP: Coluna de preenchimento obrigatório. Deve ser preenchida de acordo
com o código de tributação do IPI no SAP. O cliente deverá informar qual código é
utilizado para a tributação do IPI.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Seleção Empresa/Filial
260
Nesta seção deverão ser parametrizadas todas as empresas e suas respectivas filiais que o
extrator deverá considerar para a extração de Notas Fiscais.
Nesta seção deverão ser parametrizados todos os indicadores de pagamentos a serem tratados
pelo extrator.
Cond. Pgto: Coluna de preenchimento obrigatório. Deve ser preenchida com o código da
condição de pagamento no SAP.
Condição Conversão: Coluna de preenchimento obrigatório. Deve ser preenchida de
acordo com o indicador de pagamento da SEFAZ. Admite três valores: ‘0’ – à vista; ‘1’ – a
prazo; ‘2’ – Outros.
262
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Status e-Docs
Nesta seção deverão ser parametrizados os possíveis status da nota fiscal eletrônica.
Estes status são enviados pelo componente Comply e-Docs Server e devem estar cadastrados para
que possam ser interpretados pelo componente ABAP. Além disso, é possível determinar se
o status representa erro, se permite cancelamento e conversão para contingência.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Controle de
Contingência / Paralelo
Nesta seção deverão ser parametrizadas quais empresas e para quais locais de negócio e região
(UF) deverão ser emitidas notas fiscais eletrônicas. Além disso, pode-se inserir ou retirar uma
filial de contingência, sendo possível definir qual o tipo de contingência por filial e versão do XML
de contingência serão utilizados.
264
está em contingência. Quando este parâmetro for ativado, todas as NF-es emitidas ou
reprocessadas deste local de negócios possuirão o tipo de emissão de contingência.
Tp. Cont: Coluna de preenchimento facultativo. Deve ser preenchida com o tipo de
contingência utilizada pelo local de negócios. O tipo de contingência é relacionado a tag
“Tipo de Emissão” (tpEmis). Admite os valores “Vazio” (sem contingência), “C”
(Formulário de Segurança), “3” (SCAN), “4” (DPEC) e “5” (FS-DA).
Versão Cont: Coluna de preenchimento facultativo. Deve ser preenchida de acordo com a
versão do leiaute da NF-e utilizada pelo local de negócios. Este campo, quando
preenchido, determina o formato da chave de acesso - se no leiaute 1.10 ou 2.00. Admite
os valores “1” (1.10) ou “2” (2.00).
Cód. Msg: Coluna de preenchimento facultativo. Deve ser preenchido para emissão de
notas fiscais eletrônicas em contingência, sendo atribuído o texto de justificativa de
acordo com o Cód.Msg atrelada ao local de negócio. Cód.Msg possui relacionamento com
a aba Justificativa de Contingência.
Data de Contingência: Preenchimento pelo Componente Abap. Após selecionar o
parâmetro na coluna Contingência e salvar automaticamente, será incluído data e hora
da ativação da contingência.
Nesta seção, deverão ser parametrizadas quais exits o extrator deverá chamar durante sua
execução. Uma exit é um ponto específico dentro de um programa ABAP que permite a chamada
de outro programa configurado anteriormente. Assim que o programa chamado pela exit termina
seu processamento, o programa original dá continuidade a seu processo de execução.
266
Abaixo todas as exits que podem ser configuradas:
o Programa extrator: Esta exit sempre deve estar configurada. Ela é responsável pela
chamada do extrator. Para configurar esta exit é necessário configurar os seguintes
dados:
Código Holding: (Identificador do cliente).
Exit: ZNFEXTRAT
Programa: /PWS/ZNFERP002
Form: F_EXIT_001
Descrição: Exit para execução do extrator.
o Gravar informações nas tabelas Zs do e-Docs: Esta exit deve ser configurada
quando se deseja que as informações extraídas da NF-e permaneçam nas tabelas Zs
após a extração. É recomendado que esta exit esteja ativa. Para configurá-la, é
necessário parametrizar os seguintes dados:
Código Holding: (Identificador do cliente).
Exit: ZNFETABZ
Programa: /PWS/ZNFERFORM
Form: F_EXIT_001
Descrição: Gravação de dados em tabela Z.
o Alteração de dados da tabela de cabeçalho: Esta exit deve ser configurada quando
se deseja alterar alguma informação referente à tabela de cabeçalho de NF-e
(/PWS/ZNFET001). Para clientes que possuem o sistema pw.CE aplicado no SAP, é
possível ativar a exit padrão de exportação. Caso o cliente deseje alterar dados de
cabeçalho, mas utilizar o programa padrão para extração de informações de
exportação do pw.CE, é necessário criar um programa Z, realizar o tratamento na
tabela de cabeçalho e, em seguida, criar uma chamada para o programa padrão de
extração de informações de exportação do pw.CE:
Código Holding: (Identificador do cliente).
Exit: ZNFECAPA
Programa: (Definido pela empresa) ou com pw.CE /PWS/ZNFERFORM3.
Form: (Definido pela empresa) ou com pw.CE F_EXIT_001.
Descrição: Alteração de Informações de cabeçalho.
o Alteração de dados da tabela de duplicatas: Esta exit deve ser configurada quando
se deseja alterar alguma informação referente à tabela de duplicatas de NF-e
(/PWS/ZNFET007):
Código Holding: (Identificador do cliente).
Exit: ZNFEDUP
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
268
Descrição: Alteração de informações de duplicatas.
o Alteração de dados da tabela de cabeçalho de cana de açúcar: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
dados de cabeçalho de cana de açúcar de NF-e (/PWS/ZNFET016):
Código Holding: (Identificador do cliente).
Exit: ZNFECANA1
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de dados de cabeçalho de cana de
açúcar.
o Alteração de dados da tabela de item: Esta exit deve ser configurada quando se
deseja alterar alguma informação referente à tabela de item de NF-e
(/PWS/ZNFET002):
Código Holding: (Identificador do cliente).
Exit: ZNFEITEM
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de item.
o Alteração de dados da tabela de veículos: Esta exit deve ser configurada quando se
deseja alterar alguma informação referente à tabela de veículos de NF-e
(/PWS/ZNFET019):
Código Holding: (Identificador do cliente).
Exit: ZNFEVEIC
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de veículos.
270
o Alteração de dados da tabela de informações de combustíveis: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
combustíveis de NF-e (/PWS/ZNFET013):
Código Holding: (Identificador do cliente).
Exit: ZNFEIMPCOM
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de combustíveis.
o Alteração de Dados de Impostos de Gerais: Esta exit deve ser configurada quando
se deseja adicionar alguma linha de imposto não extraída ou inexistente no SAP
standard. Por este motivo, é possível alterar as tabelas de item (/PWS/ZNFET002) e
de imposto (/PWS/ZNFET003):
Código Holding: (Identificador do cliente).
Exit: ZNFEIMPGER
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de impostos não standard.
o Alteração de dados da tabela de imposto: Esta exit deve ser configurada quando se
deseja alterar alguma informação já extraída e tratada extrator referente à tabela
de imposto de NF-e (/PWS/ZNFET003):
Código Holding: (Identificador do cliente).
Exit: ZNFEIMP
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de imposto standard.
o Programa de impressão SAP: Esta exit deve ser configurada quando se deseja
realizar a chamada ao programa de impressão do DANFE no SAP. Esta exit é
executada pela função de retorno e pelo extrator, quando o status de retorno do
componente Comply e-Docs Server indicar autorização de NF-e, e através do Painel
de Controle, clicando no botão Impressão de DANFE:
Código Holding: (Identificador do cliente).
Exit: ZNFEDANFE
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Programa de impressão de DANFE.
272
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Programa de impressão de FS.
o Programa de impressão de SCAN no SAP: Esta exit deve ser configurada quando se
deseja realizar a chamada ao programa de impressão do DANFE autorizado pelo
SCAN no SAP. Esta exit é executada apenas pela função de retorno, quando o status
de retorno do componente Comply e-Docs Server é de autorização, o tipo de
emissão é 3 – SCAN, e através do painel de controle, clicando no botão “Tratamento
Automático de Contingência”. Essa impressão só ocorre quando há o status de
autorização:
Código Holding: (Identificador do cliente).
Exit: ZNFEDANF3.
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Programa de impressão de SCAN.
o Programa de impressão de DPEC no SAP: Esta exit deve ser configurada quando se
deseja realizar a chamada ao programa de impressão do DANFE autorizado pelo
DPEC no SAP. Esta exit é executada apenas pela função de retorno, quando o status
de retorno do componente Comply e-Docs Server é 124 – DPEC, recebido pelo
sistema de contingência eletrônica, e através do painel de controle, clicando no
botão “Tratamento Automático de Contingência”. Essa impressão só ocorre
quando há o status 124 ou status 100:
Código Holding: (Identificador do cliente).
Exit: ZNFEDANF4.
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Programa de impressão de DPEC.
o Gravar informações nas tabelas Zs do e-Docs: Esta exit deve ser configurada
274
quando se deseja que as informações extraídas da NF-e permaneçam nas tabelas Zs
após a extração. Para configurá-la, é necessário parametrizar os seguintes dados:
Código Holding: (Identificador do cliente).
Exit: ZNFETABZ2
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Gravação de dados em tabela Z.
o Retorno de NFS-e: Esta exit deve ser configurada para tratamento de retorno de
nota fiscal de serviço. Para configurá-la, é necessário parametrizar os seguintes
dados:
Código Holding: (Identificador do cliente).
Exit: ZNFSERET
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Retorno de NFS-e.
o Alteração de dados da tabela de construção para NFS-e: Esta exit deve ser
configurada quando se deseja alterar alguma informação referente à tabela de
dados de construção para NFS-e (/PWS/ZNFET021):
Código Holding: (Identificador do cliente).
Exit: ZNFSCONST
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Alteração de informações de dados de construção para NFS-e.
o Botão de estorno do painel de controle: Esta exit deve ser configurada quando se
deseja alterar o tratamento do botão de estorno do painel de controle:
Código Holding: (Identificador do cliente).
Exit: ZNFEEST
Programa: (Definido pela empresa).
Form: (Definido pela empresa).
Descrição: Botão de estorno.
276
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Categorias de NFe
Esta seção somente deve ser configurada caso o cliente utilize a função de conversão de NF-e
(/PWS/ZNFE_DETERMINA_NFE). Esta função tem o papel de verificar se a nota fiscal modelo 1/1A
representa NF-e e para qual categoria deve ser convertida para utilizar o modelo 55. Esta função
deve ser amarrada ao programa de determinação de numeração de nota fiscal standard do SAP.
Nesta seção deve ser parametrizado o de/para de categorias de nota fiscal no SAP. A função que
determina se a nota fiscal é eletrônica utiliza esta parametrização. Após verificar se a nota fiscal
pertence aos locais de negócio configurados como emissores de nota fiscal eletrônica, a função
verifica este de/para para então determinar qual a categoria a NF-e deve ser convertida para
possuir o modelo 55. A categoria de nota fiscal determina o modelo da nota fiscal, portanto é
através desta parametrização que temos a conversão de diversos modelos de nota fiscal ao
modelo 55.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Constantes do Produto
Nesta seção deverão ser parametrizadas as constantes do extrator. Estas constantes nos
permitem modificar a forma que uma variável é tratada pelo programa extrator. Além do
programa extrator, as exits desenvolvidas pelo cliente podem utilizar este cadastro.
278
o Campo de numeração de NF-e: Esta constante deve ser configurada quando se
deseja determinar qual campo da tabela de Cabeçalho de NF standard (J_1BNFDOC)
deve ser considerado para determinar a numeração da NF-e: O NFNUM (6 posições)
ou NFENUM (9 posições). O valor NFENUM somente deve ser configurado caso o
cliente já tenha realizado as configurações necessárias para que este campo seja
preenchido corretamente. Caso essa constante não exista, o campo considerado
será o NFNUM:
Nome do programa: /PWS/ZNFERP002.
Nome da variável: NFNUM.
Valor da variável: “NFNUM” ou “NFENUM”.
o Quantidade máxima de registro para extração normal: Esta constante deve ser
configurada quando existir a necessidade de determinar qual a quantidade máxima
de registros que devem ser extraídos a cada chamada RFC do componente Comply e-
Docs Server. Caso essa constante não exista, o valor padrão utilizado será “cem”:
Nome do programa: /PWS/ZNFERP002.
Nome da variável: EXTNREG.
Valor da variável: (Numérico). Recomenda-se estudar a quantidade ideal de
registros a serem extraídos. Por padrão é “100”.
o Data de emissão substituída pela data atual (somente para fase de teste
unitário): Esta constante deve ser configurada quando existir a necessidade de
realizar testes com NFs antigas que possuam a data de emissão muito atrasada e,
por esse motivo, seriam rejeitadas pela SEFAZ. Caso essa constante não exista, a
data de emissão considerada será a da NF-e:
Nome do programa: /PWS/ZNFERP002.
Nome da variável: TESTE.
Valor da variável: TESTE.
o Indica se o valor do produto do item deve ser somado ao total dos produtos,
apenas leiaute NF-e 2.00: Esta constante determina, por padrão, se o valor do
produto do item (tag vProd) deve ser somado ao grupo de totais do ICMS (ICMSTot,
tag vProd). Apesar de esta constante existir, recomendamos que os clientes
analisem seus cenários de emissão de NF-e, para verificar se existe algum caso em
que há a necessidade de não somar um item ao valor total de produtos. Com um
cenário assim, será necessário um desenvolvimento adicional, através da EXIT de
280
Item (ZNFEITEM). Caso essa constante não exista, haverá erro na geração do XML,
uma vez que a tag de indicador de total (indTot) no item não será preenchida:
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: NFITM_IND_TOT.
o Valor da variável: 0 (O valor do item (vProd) não compõe o valor total da NF-
e (grupo ICMSTot, vProd)) ou 1 (O valor do item (vProd) compõe o valor total
da NF-e (grupo ICMSTot, vProd)).
o Destinatário da NF-e no exterior – CEP: Esta constante determina, por padrão, qual
valor deve ser inserido no CEP do destinatário quando o destinatário da NF-e for no
exterior. É necessário preencher o valor desta constante com 99999999:
Nome do programa: /PWS/ZNFERP002.
Nome da variável: CEP.
Valor da variável: (Numérico). Recomendamos preencher com 99999999.
282
o Update tabela de controle: Esta constante determina a quantidade de vezes em
que a função de retorno executará o update na tabela /PWS/ZNFETB000. Caso não
esteja parametrizado, o update ocorre só uma vez.
o Nome do programa: /PWS/ZNFE_RETORNO_SAP.
o Nome da variável: NUM_UPD.
o Valor da variável: (Numérico).
o Buscar Número FCI: Esta constante se integra com o produto Sonda FCI e busca o
número FCI para o material extraído na NF-e. Apenas parametrize esta função se
utilizar o produto Sonda FCI.
o Nome do programa: /PWS/ZNFERP002.
o Nome da variável: INTEGRA_SONDA_FCI.
o Valor da variável: S ou N.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Código País
Nesta seção, deverão ser parametrizados todos os países do SAP e seus respectivos códigos
BACEN.
País: Coluna de preenchimento obrigatório. Preencher com a sigla do país existente no
SAP. Exemplo: BR, AR.
Código País: Coluna de preenchimento obrigatório. Preencher com código do país, de
acordo com a Tabela BACEN.
Nome do País: Coluna de preenchimento obrigatório. Preencher com o nome do país.
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Finalidade de
Documento
Nesta seção, deverão ser parametrizados os de/para das finalidades de documento no SAP para a
SEFAZ. Este cadastro determina qual valor deverá ser extraído para a tag finNFe. Esta tag possui
os seguintes valores: 1 - NF-e Normal, 2 - NF-e Complementar e 3 – NF-e de Ajuste.
284
De: Coluna de preenchimento obrigatório. Preencher com o tipo de documento
(document type) da categoria da NF-e no SAP. Para verificar quais são os tipos de
documentos cadastrados no SAP, é possível acessá-los através da transação SE16, verificar
a tabela J_1BNFDOC e, em seguida, clicar sobre o matchcode do campo “DOCTYP”.
Exemplo:
Para: Coluna de preenchimento obrigatório. Preencher com a finalidade de documento
relacionada ao tipo de documento no SAP. As finalidades de NF-e possíveis são: 1 - NF-e
Normal, 2 - NF-e Complementar e 3 – NF-e de Ajuste.
286
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > e-Pin - Parâmetros
Nesta seção, deverão ser parametrizados os critérios para definir se uma nota fiscal pertence ao
e-Pin. O e-Pin é um arquivo TXT, que possui um formato interno de XML, que deve ser enviado à
SUFRAMA para mercadorias que possuem como destino a zona franca de Manaus. É possível
realizar este cadastro através do CFOP do item da nota fiscal, domicílio fiscal e inscrição
SUFRAMA. Caso mais de uma opção seja utilizada, a nota fiscal deve atender a todos os critérios
para ser considerada e-Pin. Exemplo: CFOP 6109 e domicílio fiscal ‘ZN’. Caso este critério seja
configurado, será necessário que uma nota fiscal, para ser considerada e-Pin, possua este CFOP e
que o parceiro destinatário da nota fiscal possua o domicílio fiscal informado.
É importante destacar que, caso uma nota fiscal não seja considera NF-e, mas for considerada e-
Pin, será gerado o e-Pin convencional; caso ela seja considerada apenas NF-e, e não e-Pin,
somente será gerada a NF-e. Também existe a possibilidade da nota fiscal ser considerada NF-e e
e-Pin. Nesse caso, primeiro a NF-e deverá ser autorizada; em seguida, deverá ser gerado o
arquivo e-Pin eletrônico, lembrando sempre que uma NF-e somente gerará o e-Pin eletrônico
após sua autorização de uso, logo, se a NF-e for rejeitada, o arquivo e-Pin não será gerado. Isso
ocorre porque, ao realizar o upload de um arquivo e-Pin eletrônico, é verificada a existência da
NF-e na base de dados da SUFRAMA.
288
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Justificativa de
Contingência
Nesta seção deverão ser parametrizados dados de nota fiscal de serviço (NFS-e) de acordo com os
respectivos leiautes municipais. Esse cadastro determina por local de negócio: Natureza de
operação / Tributação, Tipo de Rps, Tipo de Recolhimento e Tipo de Operação.
Esta parametrização é somente para emissão de Nota fiscal de Serviço (NFS-e) com integração ao
Módulo NFS-e da Sonda IT.
Nesta seção deverá ser parametrizado o código de tributação do ISSQN que será atribuído nas
notas fiscais de serviço (NFS-es), vinculado ao código de lista de serviço. Na extração da nota
fiscal de serviço serão verificados: empresa, local de negocio e código de serviço da nota para
atribuir o cód. Tributação do ISSQN que estiver parametrizado.
Esta parametrização é somente para emissão de Nota fiscal de Serviço (NFS-e) com integração ao
Módulo NFS-e da Sonda IT.
292
Menu: /PWS/ZNFEM000 > Parâmetros Gerais > Parâmetros de Tabelas > Formas de Tributação
X NFS-e
Nat. op. município / tributação: Deve ser preenchido valor da natureza da operação do
município/tributação de acordo com o leiaute municipal de emissão de NFS-e.
Descrição nat. op. município / tributação: Deve ser preenchido com a descrição
correspondente ao tipo de natureza de operação do município/tributação.
Tipo recolhimento: Deve ser preenchido com o tipo de recolhimento.
Descrição recolhimento: Deve ser preenchido com a descrição correspondente ao tipo de
recolhimento.
Tipo operação: Deve ser preenchido com o tipo de operação.
Descrição operação: Deve ser preenchido com a descrição correspondente ao tipo de
operação.
Os parâmetros configurados nessa transação são globais, logo, se uma filial nesta transação for
configurada para a exclusão e na transação de Parâmetros for configurada para extrair, as NF-es
emitidas por esta filial não serão extraídas.
294
Direção NF: Informar se as notas fiscais de entrada/saída deverão ser consideradas para
emissão de nota fiscal eletrônica.
Parceiro: Informar quais os parceiros que deverão ser considerados para emissão de nota
fiscal eletrônica.
Série: Informar quais as séries de nota fiscal que deverão ser consideradas para emissão
de nota fiscal eletrônica.
Subsérie: Informar quais subséries de nota fiscal deverão ser consideradas para emissão
de nota fiscal eletrônica.
Modelo: Informar quais os modelos de nota fiscal que deverão ser considerados para
emissão de nota fiscal eletrônica.
CFOP: Informar quais os CFOPs que deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os Itens não relacionados àquele CFOP. Exemplo: Quando um CFOP está
configurado aqui, todos os demais serão desconsiderados; em uma nota fiscal com dois
CFOPs diferentes, um item seria mantido e o outro, excluído.
Material: Informar quais materiais deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os itens não relacionados àquele material.
Centro: Informar quais centros deverão ser considerados para emissão de nota fiscal
eletrônica. Atentar que esta configuração é em nível de item e, quando configurada,
exclui os itens não relacionados àquele centro.
Extrator NF-e - (/PWS/ZNFERP002)
A transação “Extrator NF-e” possibilita executar manualmente o programa extrator. O programa
extrator tem a função de realizar a seleção dos dados de nota fiscal nas tabelas standard do SAP,
executar os tratamentos necessários e gravar o resultado nas tabelas Zs do componente ABAP, do
sistema e-Docs.
Esta transação deve ser acessada somente para a realização de testes e pequenas intervenções
nos dados das tabelas Zs. O ideal é sempre trabalhar com extração automática, não utilizando
esta transação.
Caso o campo “Interface Normal S/N” seja definido como “N”, ao executar o programa extrator
serão levados em consideração os intervalos de notas fiscais definidos na transação de
parâmetros. Caso seja definido como “S”, o programa extrator irá extrair as notas fiscais a partir
do Último documento, que também está gravado na transação “Parâmetros”.
296
Caso o usuário selecione no botão seleção múltipla, é possível definir um intervalo de docnum
para a extração de NF-es.
298
Painel de Controle - (/PWS/ZNFEMP000)
A transação “Painel de Controle” possibilita visualizar o status e últimos eventos de uma NF-e
extraída pelo extrator. É possível acompanhar seu ciclo de vida, desde a extração até a
autorização de uso, bem como cancelamento e inutilizações executadas.
Além disso, é possível executar a impressão do DANFE e outros formulários (FS, FS-DA),
visualização de informações, reprocessamento, solicitação de cancelamento e visualizações de
mensagens enviadas ao contribuinte.
300
Botão executar (Atalho F8): Executará a seleção determinada e montará os
registros para exibição no painel de controle.
Abas: O painel de controle é divido em abas para facilitar a visualização do status atual
da NF-e, dado seu ciclo de vida. As abas são as seguintes:
Envio/Recebimento: Exibirá NF-es que já foram enviadas ao componente Comply e-
Docs Server. As NF-es nesta aba estarão com o farol amarelo, caso estejam com o
status pendente de retorno, e estarão verdes, caso o processo da NF-e já esteja
concluído;
Aguardando envio: Exibirá NF-es que já foram extraídas, mas ainda não foram
enviadas ao componente Comply e-Docs Server;
Envio/Recebimento - Erro: Exibirá NF-es que já foram enviadas ao componente
Comply e-Docs Server e retornaram com erro. Todas as NF-es nesta aba estarão com
o farol vermelho. A seção Status e-Docs, da transação parâmetros, permite
configurar se um evento representa erro. Com isso, caso o evento de retorno da NF-
e represente erro, ele será exibido nesta aba; caso contrário, será exibido na aba
“Envio/Recebimento”, com o farol verde;
Contingência: Exibirá NF-es que estão em contingência. As NF-es nessa aba possuem
o tipo de emissão diferente de normal. Se a NF-e estiver sendo processada em
contingência, sem retorno, estará com o farol amarelo. Caso haja algum erro no
processamento da contingência, ficará com o farol vermelho e, caso seja autorizada
em contingência, ficará com o farol verde;
Botão impressão DANFE : Permite imprimir o DANFE de uma nota fiscal, somente se
a NF-e estiver autorizada (status 100 – autorizado o uso da NF-e). Para que a impressão
ocorra é necessário que o programa de impressão, configurado na exit ZNFEDANFE,
funcione corretamente.
302
contrário, será inutilizada. Quando houver o retorno do status de cancelamento, será
verificado se a exit ZNFEATLZ está ativa; se estiver, os documentos relacionados a esta
NF-e serão cancelados (faturamento, documento de material ou nota fiscal writer).
Para acessar os eventos de uma determinada NF-e é necessário acessar o Painel de Controle de
NF-e através da transação: /PWS/ZNFEMP000 - Comply e-Docs - Painel de Controle.
Com a NF-e selecionada é necessário clicar no botão “Exibir Eventos”. Conforme abaixo:
304
Na tela acima possuímos os seguintes botões e campos:
o Atualizar: Para atualizar a informação disponível no Painel;
o Novo: Para a criação de um novo Evento de NF-e;
o Editar: Para editar o evento. Somente habilitado caso o status do evento permita
alteração;
o Salvar: Para enviar um novo evento ou uma alteração de evento;
o Na parte superior da tela está disponível o cabeçalho da NF-e que receberá o
evento em questão;
o No meio da tela no grid apresentado é possível verificar todos os eventos
relacionados à NF-e;
o No campo "Detalhes" é possível verificar o tipo de Evento e as informações
relacionadas a aquele evento.
Para editar um evento existente, é necessário que o mesmo se encontre com um status de erro.
Selecione o evento e em seguida clique sobre o botão “Editar”:
Após isso o grupo Detalhes será liberado e o usuário poderá corrigir o Evento.
Após isso o usuário deverá clicar no botão “Salvar” e com isso o evento será reenviado.
306
Limpar Tabelas de NF-e - (/PWS/ZNFECTAB)
A transação “Limpar Tabelas de NF-e” permite realizar a exclusão de registros gravados nas
tabelas Zs do componente ABAP do sistema e-Docs. Esta transação deve ser utilizada quando
existir a necessidade de excluir os registros das tabelas Zs do componente ABAP e não houver a
necessidade de manter um histórico, uma vez que os dados serão perdidos. Em todo caso, as
informações serão mantidas nas tabelas standard do SAP de notas fiscais e também no banco de
dados do sistema e-Docs.
É possível definir alguns filtros de seleção que permitem determinar quais NF-es deverão ser
excluídas das tabelas Zs.
Selecionar todas as notas: Permite selecionar todas as notas fiscais existentes nas
tabelas Zs. Todo conteúdo será excluído.
Definir parâmetros: Permite selecionar quais notas fiscais devem ser excluídas. Se esta
opção for ativada, os parâmetros abaixo serão levados em consideração no momento de
realizar a seleção de NF-es que deverão ser excluídas.
Código holding: Permite selecionar o código da holding, com possibilidade de definir um
intervalo ou seleção múltipla.
Código da matriz: Permite selecionar o código da matriz, com possibilidade de definir um
intervalo ou seleção múltipla.
Código da filial: Permite selecionar o código da filial, com possibilidade de definir um
intervalo ou seleção múltipla.
Número do documento: Permite selecionar o docnum da nota fiscal, com possibilidade
de definir um intervalo ou seleção múltipla.
Data de transmissão: Permite selecionar a data de transmissão da nota fiscal, com
possibilidade de definir um intervalo ou seleção múltipla. É possível a utilização
do matchcode.
Tipo de nota fiscal: Permite selecionar o tipo de nota fiscal, com possibilidade de definir
um intervalo ou seleção múltipla. Aceita os valores ‘0’ – entrada e ‘1’ – saída.
Grid: No grid, serão exibidas as NF-es que podem ser excluídas, de acordo com o filtro
realizado anteriormente. Para executar a exclusão, é necessário realizar a seleção das
308
Botões de ordenação - : Permite ordenar de forma crescente ou decrescente os
dados exibidos no Grid.
O Comply e-Docs Server pode ser utilizado tanto no módulo NF-e como NFS-e. Para tanto, apenas
é necessário ativar e configurar os processos responsáveis por cada módulo.
Para o NF-e, a função principal do Comply e-Docs Server é gerenciar o processo de emissão de
NF-e, para tanto, ele executa da interface de extração, processa as informações de NF-e,
enviando e recebendo os resultados da SEFAZ. Além disso, ainda existe a possibilidade de
imprimir o DANFE, enviar o DANFE e o XML de Distribuição por Email, retornar informações ao
sistema de origem, entre outros.
Para o NFS-e, sua função principal além do gerenciamento dos processos de emissões de NFS-e
para as prefeituras, também processar as informações, enviando e recebendo os resultados das
prefeituras. Além disso, possibilita a impressão automática do RPS, impressão da Nota Fiscal de
Serviço, enviar e-mail em PDF, e/ou XML, salvar a Nota Fiscal de Serviço em PDF, e/ou XML, e
integrada ao NF-e, realiza o retorno das informações, possibilitando a visualização dos status das
Notas Fiscais no Painel de Controle do NF-e e SAP.
Tecnicamente, o Comply e-Docs Server trabalha como uma máquina de estado, ou seja, seus
processos são disparados de acordo com o estado dos registros que devem ser manipulados por
ele.
O Comply e-Docs Server é um Windows Service (Serviço do Windows) e pode ser instalado em
mais de um Servidor Windows relacionando-se com o mesmo banco de dados. Esse procedimento
pode ser utilizado para aumento do desempenho do sistema Comply e-Docs.
Inicialização
Inicialização
Para que o Comply e-Docs Server passe a funcionar é necessário iniciar o Serviço do Windows do
Comply e-Docs Server.
312
Processos
O Comply e-Docs Server é constituído por uma série de processos. O processo principal,
denominado Gerenciador de Processos, é responsável pelo gerenciamento da execução de todos
os processos do Comply e-Docs Server.
Os processos são executados após a inicialização do serviço. Cada processo tem uma função
específica no sistema e realiza uma tarefa que, em alguns casos, é independente de outros
processos.
Código Processo
1 Gerenciador NF-e – Entrada
2 Gerenciador NF-e – Pendencias
3 Gerenciador NF-e – Email
4 Gerenciador NF-e - DANFE em PDF
5 Gerenciador NF-e – XML
6 Gerenciador NF-e - Integração XML
10 Gerenciador NF-e - Pré-validação
20 Gerenciador NF-e – Priorização
25 Gerenciador NF-e - Contingência DPEC
30 Gerenciador NF-e - Envio Lote
35 Gerenciador NF-e - Integração Envio Lote
40 Gerenciador NF-e – Retorno
45 Gerenciador NF-e - Integração Retorno
50 Gerenciador NF-e - Impressão DANFE
60 Gerenciador NF-e - Retorno ao Sistema de Origem
80 Gerenciador NF-e – Cancelamento
85 Gerenciador NF-e - Integração Cancelamento
90 Gerenciador NF-e – Inutilização
99 Gerenciador NF-e – Timeout
100 Gerenciador NF-e - XML e-PIN
110 Gerenciador NF-e - Lote e-PIN
120 Gerenciador NF-e - Consulta Status WebService
130 Gerenciador NF-e - Consulta Cadastro
140 Gerenciador NF-e - Consulta de Retorno de Notas
150 Gerenciador NF-e - Reprocessamento Parse Inbound
160 Gerenciador NF-e – Archive
165 Gerenciador NF-e - Consulta Archive
170 Gerenciador NF-e – Eventos
200 Gerenciador NF-e - Consulta Documentos Destinados
205 Gerenciador NF-e - Download NF-e
215 Gerenciador NF-e - Manifesto Automático
260 Gerenciador NF-e - Retorno Inbound Sist. de Origem
Código Processo
Gerenciador de Entrada/Recepção – Pré-validação
30 Gerenciador de Envio - Lote
40 Gerenciador de Envio - Retorno
80 Gerenciador de Envio – Cancelamento
3 Gerenciador de Envio de E-mail XML
3 Gerenciador de Envio de E-mail PDF
5/50 Gerenciador de Impressão
99 Gerenciador de Timeout
314
NF-e:
322
Se a NF-e for um ePin eletrônico, ou seja, que a Nota Fiscal é relacionada a SUFRAMA é
representa uma NF-e, então o seu XML será gerado por este processo.
324
Gerenciador NF-e - Consulta Documentos Destinados:
O processo de Eventos é responsável pelo processamento dos Eventos de NF-e. Este processo
busca Eventos pendentes de autorização, os transmite à SEFAZ e recebe o protocolo do Evento. O
primeiro evento que este processo suporta é a Carta de Correção Eletrônica (CC-e).
NFS-e:
Gerenciador de Entrada/Recepção - Pré-validação:
O Processo de entrada não executa interfaces de entrada. O processo expõe um WebService para
servir de interface com o sistema de origem.
O processo de Entrada realiza a Pré-validação que é responsável pela validação do arquivo XML.
Ele valida informações do arquivo XM, requisições e dos RPS’s gerados.
Em caso de erro, os dados do XML não entrarão na base de dados do NFS, deverá ser verificado no
histórico de evento do Painel de Controle – Nota Fiscal do componente Framework ou ABAP.
A principal validação é: Valida se o RPS é compatível com o modelo padrão definido pelo XSD.
Dessa forma, caso haja algum erro na estrutura do XML gerado, o sistema identificará este erro
antes do envio a tabela NFS_NF_CAPA.
Gerenciador de Envio - Lote NFS-e:
O processo de Envio de Lote NFS-e é responsável pelo envio de XMLs de NFS-es gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados ao município.
O processo de Envio de Lote é responsável pelo envio dos lotes de arquivos XMLs gerados. Ele
controla o envio e a recepção da confirmação de entrega dos arquivos enviados as prefeituras.
É importante dimensionar o tráfego de informações, os períodos do dia nos quais existem maior
emissão de NFS-es e o tráfego de rede para que não ocorra gargalos na transmissão de arquivos
XMLs. Também é interessante dada à infra-estrutura disponível ao projeto, utilizar links
dedicados redundantes, inclusive com operadoras diferentes para que em caso de queda do link
de uma operadora o cliente continue a autorizar NFS-es.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.
326
Gerenciador de Envio - Retorno:
O processo de Retorno de Lote é responsável pelo retorno dos lotes de arquivos XMLs gerados. Ele
controla a solicitação de retorno de status e a recepção do status dos lotes de XMLs enviados as
prefeituras.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.
Em caso de falha nesse processo o sistema irá gerar um evento para essa NFS-e informando que
não foi possível sua transmissão.
É possível que mesmo com o arquivo transmitido, a prefeitura rejeite a autorização de uso, nesse
caso será necessária uma análise funcional do erro ocorrido.
O certificado digital do cliente também é utilizado nesse processo e deve estar instalado na
mesma máquina que o Serviço “Comply e-Docs Server – Módulo NFS-e”.
É possível que mesmo com o arquivo transmitido, a prefeitura rejeite o cancelamento, nesse caso
será necessária uma análise funcional do erro ocorrido.
A principal tabela utilizada por este processo é a tabela NFS_NF_CAPA. O gerenciamento de
estado deste processo é realizado através do campo NFS_NF_CAPA.STATUS_PROCESSAMENTO: se
estiver como 80 está aguardando processamento, 81 em processamento e 82 erro de
processamento. Assim que o processo for finalizado o status de processamento do registro será
modificado para 83.
O processo de email em XML é responsável pelo envio de emails do Comply e-Docs Server. Ele
envia XMLs aos destinatários da NFS. Ele envia os XMLs aos endereços de e-mail configurados na
tabela NFS_CONFIG_FILIAL, caso esteja parametrizado para envio.
O processo de e-mail em PDF é responsável pelo envio de e-mails em PDF. Ele envia os PDFs aos
endereços de e-mail configurados na tabela NFS_CONFIG_FILIAL, caso esteja parametrizado para
envio.
O processo de Impressão é responsável pela impressão das NFS (Nota Fiscal de Serviço) e RPS
(Recibo Provisório de Serviços). Ele controla o envio para a fila de impressão.
Gerenciador de Timeout:
O processo de Timeout é responsável pelo controle de timeouts do sistema. Verifica o tempo que
a nota esta em processamento e em caso de ultrapassar o tempo limite retorna para o status de
processamento anterior para reprocessamento. Não avisa os atores parametrizados no sistema.
330
Interface EDI
EDI
Procedimentos de Contingência
Contingência
O sistema Comply e-Docs entende contingência como a impossibilidade de autorização de NF-es
em processo normal. A falha no processo pode ser ocasionada por problemas de infra-estrutura do
cliente ou da SEFAZ, cenários que apresentam inconsistências etc.
Caso a emissão normal não esteja disponível, o cliente deve optar pelos outros tipos de emissão
disponibilizados pela SEFAZ. São eles:
De acordo com o Manual de Contingência versão 1.01: “Em um cenário inconsistente que
impossibilita emissão da NF-e na modalidade normal, o emissor deverá escolher a emissão de
contingência que lhe for mais conveniente ou, se preferir, aguardar a normalização da situação
para emitir o referido documento normalmente, caso a emissão da NF-e não seja premente”.
332
Modalidades de Emissão
Modalidades de Emissão
O tipo de emissão é o que determina como será o processamento para a autorização de uso da
NF-e, se utilizará e qual o formato de contingência. O que define o tipo de emissão no XML da NF-
e é a tag tpEmis. Abaixo serão detalhadas as modalidades de emissão disponíveis até o momento.
Tipos:
“Nesta situação a emissão das NF-es é realizada normalmente com a impressão do DANFE em
papel comum, após o recebimento da autorização de uso da NF-e”.
O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão normal é o
seguinte:
334
Contingência FS
De acordo com o Manual de Contingência versão 1.01:
O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência FS é o
seguinte:
“A recepção das NF-es pelo SCAN é ativado pela UF interessada e uma vez acionada passa a
recepcionar as NF-es de série 900 a 999 dos emissores credenciados para emitir NF-e na UF.
Eventualmente um emissor credenciado recentemente pode não estar autorizado a emitir NF-e
no SCAN caso o Cadastro Nacional de Emissores não tenha sido atualizado pela UF interessada”.
“Ocorrendo à indisponibilidade, a SEFAZ origem acionará o SCAN para que ative o serviço de
recepção e autorização de NF-e em seu lugar. Finda a indisponibilidade, a SEFAZ origem acionará
novamente o SCAN, agora para desativar o serviço. A desativação do serviço de recepção e
autorização de NF-e pelo SCAN será precedida por um período de 15 minutos, em que ambos os
ambientes estarão simultaneamente disponíveis, de forma a minimizar o impacto da mudança
para o Contribuinte”.
O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência SCAN
é o seguinte:
336
Contingência DPEC
De acordo com o Manual de Contingência versão 1.01:
“O modelo de Contingência Eletrônica foi idealizado como alternativa que permita a dispensa do
uso do formulário de segurança para impressão do DANFE e a não alteração da série e numeração
da NF-e emitida em contingência”.
O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência DPEC
é o seguinte:
“Este procedimento de contingência será adotado pelos emissores que adquirirem o Formulário
de Segurança para impressão de Documento Auxiliar de Documento Fiscal – FSDA, e substitui a
contingência com o uso do formulário de segurança”.
O fluxo genérico utilizado pelo sistema Comply e-Docs para o tipo de emissão contingência FSDA é
o seguinte:
338
Modelo Operacional
Caso o sistema de origem não envie a NF-e com um tipo de emissão de contingência determinado,
o processo de entrada se encarregará de realizar a verificação da disponibilidade do WebService.
Se o processo de entrada identificar que o WebService não está ativo, status esse analisado pelo
processo de consulta de status de WebService anteriormente, o sistema irá adotar um dos fluxos
de contingência de acordo com a configuração do sistema Comply e-Docs.
Existem dois fluxos de contingência que podem ser seguidos: com ou sem determinação de
contingência automática. O que define isso é um parâmetro de sistema que deve ser configurado
por código de interface.
Essa mensagem pode variar de acordo com os parâmetros de sistema. Já se a interface estiver
definida como “determinação de contingência automática” o sistema converterá
automaticamente para o formato de contingência definido através dos parâmetros de sistema e
realizará o processamento dessa NF-e.
A seguir serão detalhados todos os tipos de emissão possíveis para o sistema Comply e-Docs e os
fluxos de informação trocados entre o sistema de origem, o Comply e-Docs e a SEFAZ.
Modelo Normal
Para que a NF-e seja processada e transmitida com o tipo de Emissão Normal, é necessário que o
sistema de origem não envie o campo “Tipo de Emissão” preenchido e que o status do
WebService para a UF da filial de emissão da NF-e esteja ativo. Esse modelo deve ser adotado
quando não houver falhas de comunicação.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
Fluxo Técnico:
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000 com o status
da NF-e, caso estiver irá imprimir o DANFE, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba de Envio / Recebimento do
Painel de Controle, com farol verde e evento 100.
342
Modelo Normal - Timeout de Envio de Lote
Existem momentos de instabilidade de Infra-estrutura que apesar do WebService estar ativo na
consulta de status, ocorre lentidão no envio do lote, gerando assim incertezas quanto ao
recebimento do lote pela SEFAZ. Isso ocorre por problemas de infra-estrutura como: lentidão de
link, instabilidade no processamento da recepção do lote pelo WebService da SEFAZ, etc.
Como não existe uma confirmação de recebimento (evento 103), mas há possibilidade da SEFAZ
ter recebido esta NF-e, não é recomendado que esta seja impressa em nenhum formato de
contingência, restando apenas a opção do reprocessamento ou cancelamento para geração de
uma nova NF-e.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
Somente para SAP: Quando o SAP receber o evento 096, irá atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 096. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 096. O usuário deverá realizar o
reprocessamento ou cancelamento para geração de uma nova NF-e.
344
Modelo Normal - Timeout de Retorno de Lote
Existem momentos de instabilidade de Infra-estrutura que apesar do WebService estar ativo na
consulta de status, ocorre lentidão no retorno do lote, gerando assim a certeza do recebimento
deste pela SEFAZ, porém a impossibilidade de consulta do seu Status. Isso ocorre por problemas
de infra-estrutura como: lentidão de link, instabilidade no processamento do lote pelo
WebService da SEFAZ, demora no processamento do pedido com vários retornos de Lote em
Processamento (evento 105) etc. Como existe a confirmação de recebimento (evento 103), mas
não há o retorno da SEFAZ, é possível que esta NF-e esteja autorizada, logo não é recomendado
que esta seja impressa em nenhum formato de contingência, restando apenas a opção do
reprocessamento ou cancelamento para geração de uma nova NF-e.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
346
Fluxo Técnico:
Somente para SAP: Quando o SAP receber o evento 098, irá atualizá-lo na tabela
/PWS/ZNFETB0000-COD_STATU = 098. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 098. O usuário deverá realizar o
reprocessamento ou cancelamento para geração de uma nova NF-e.
Contingência Manual - Não definida no Sistema de
Origem
Para que a NF-e seja processada com o tipo de emissão Contingência Manual Não Definida no
Sistema de Origem, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido e que a configuração de interface aponte para contingência manual. Esse modelo
deve ser adotado quando se deseja que o sistema de origem seja informado do problema de
comunicação e que posteriormente o mesmo defina qual o tipo de emissão que será utilizado.
Pré- Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
348
NFE_INTERFACE.CONTINGENCIA = ‘N’;
NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
utiliza_scan = Não aplicável;
utiliza_dpec = Não aplicável;
utiliza_fs = Não aplicável;
utiliza_fsda = Não aplicável.
Fluxo Técnico:
Somente para SAP: Quando o SAP receber o evento 097, irá atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 097. Visualmente este registro estará na aba Erro do
Painel de Controle, com farol vermelho e evento 097. O usuário neste caso deverá optar
por imprimir a NF-e em Contingência ou simplesmente processá-la novamente.
Lembramos que se a NF-e já foi impressa em tipo de emissão de contingência, nunca mais deve
voltar a ser normal.
350
Contingência FS Manual - Definida no Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FS Definida no
Sistema de Origem, é necessário que o sistema de origem apenas envie o campo “Tipo de
Emissão” preenchido com o valor ‘C’. Este modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso antes da emissão ou reprocessamento de
uma NF-e.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistemas:
Fluxo Técnico:
NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘C’;
Interface de Entrada com o sistema de Origem;
Processo de Entrada irá verificar os parâmetros citados;
Se o tipo de emissão estiver definido no sistema de origem com o valor ‘C’, a NF-e será
inserida com tipo de emissão FS (NFE_NF_CAPA-TIPO_EMISSAO = 'C', tag tpEmis = '2');
O XML será gerado;
A priorização será executada de acordo com parametrização do sistema;
O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, caso esta seja executada no componente Comply e-Docs Server o
Formulário de Segurança será impresso com as informações de Dados de NF-e (Segundo
Código de Barras);
Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
O processo de impressão irá verificar se o FS já foi impresso e se a impressão é executada
no sistema de origem, neste caso sabemos que a impressão já foi executada ou a mesma
ocorre no sistema de origem, logo somente será retornado ao sistema de origem o evento
100;
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver e o indicador de impressão estiver como ‘S’, somente irá
atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver e o indicador de
impressão estiver como ‘N’ irá imprimir o FS, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.
352
Contingência FS Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FS
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, que o WebService esteja fora do ar e que os parâmetros de sistema apontem para o
tipo de emissão FS. Esse modelo deve ser adotado quando se deseja que o sistema Comply e-Docs
ao perceber que um WebService não está ativo, emita automaticamente a NF-e em FS.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
NFE_INTERFACE.CONTINGENCIA = ‘S’;
NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
utiliza_scan = ‘N’;
utiliza_dpec = ‘N’;
utiliza_fs = ‘S’;
utiliza_fsda = ‘N’;
Fluxo Técnico:
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
em Formulário de Segurança está ativa. Caso não estiver e o indicador de impressão estiver
como ‘S’, somente irá atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso
estiver e o indicador de impressão apresentar ‘N’ irá imprimir o FS, gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
356
Contingência Scan Manual
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência SCAN Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie os campos “Tipo de
Emissão” preenchido com o valor ‘3’ e o Série entre 900 e 998. Este modelo deve ser adotado
quando já se sabe que existe um problema que irá impossibilitar a autorização de uso no
WebService do estado de emissão da NF-e e que a SEFAZ desse estado já solicitou a habilitação
ao SCAN e que essa UF já está ativa no SCAN.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
Fluxo Técnico:
NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘3’;
358
Interface de Entrada com o sistema de Origem;
Processo de Entrada irá verificar os parâmetros citados;
Se o tipo de emissão estiver definido no sistema de origem com o valor ‘3’, a NF-e será
inserida com tipo de emissão SCAN (NFE_NF_CAPA-TIPO_EMISSAO = '3', tag tpEmis = '3');
O XML será gerado;
A validação do XML será executada de acordo com parametrização do sistema;
A priorização será executada de acordo com parametrização do sistema;
Serão gerados os lotes de XML, a transmissão para o WebService SCAN e a recepção do
evento 103 (Lote Recebido com Sucesso);
O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService SCAN;
O processo de impressão irá verificar se o DANFE é impresso no sistema de origem, caso
seja executada no componente Comply e-Docs Server o DANFE será impresso, além disso,
será retornado ao sistema de origem o evento 100.
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000 com o evento
da NF-e, caso estiver irá imprimir o DANFE, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.
360
Contingência Scan Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência SCAN
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, que o WebService esteja fora do ar, que os parâmetros de sistema apontem para o
tipo de emissão SCAN e o WebService SCAN esteja ativo para a UF onde a NF-e foi gerada. Esse
modelo deve ser adotado quando se deseja que o sistema Comply e-Docs, ao perceber que um
WebService não está ativo, informe ao sistema de origem que o SCAN está ativo para aquela UF,
permitindo assim ao usuário decidir se irá emitir o SCAN convertendo o tipo de emissão e série da
NF-e.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
NFE_INTERFACE.CONTINGENCIA = ‘S’;
NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
utiliza_scan = ‘S’;
utiliza_dpec = ‘N’;
utiliza_fs = ‘N’;
utiliza_fsda = ‘N’.
Fluxo Técnico:
NF-e é gerada no sistema de origem;
Interface de Entrada com o sistema de Origem;
Processo de Entrada irá verificar os parâmetros citados;
Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS), se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) será verificado o
status do WebService SCAN para essa UF (NFE_WEB_SERVICE_STATUS_SCAN) e a NF-e será
inserida com um status de processamento estático, ou seja, seu processamento será
impedido. Além disso, será registrada para retornar o evento 079 (Nota fiscal não pode
ser transmitida, SCAN ativo) ao sistema de origem.
Somente para SAP: Quando o SAP receber o evento 079, ele entenderá que esse evento
corresponde a erro. Dessa forma, somente irá atualizar a tabela /PWS/ZNFETB000 com o
evento da NF-e. Visualmente este registro estará na aba Erro do Painel de Controle, com
farol vermelho e evento 079. O usuário neste caso deverá optar por cancelar esta NF-e e
emitir uma nova já utilizando a categoria de NF-e correta amarrada à série desejada ou
simplesmente processá-la novamente para que o sistema realize uma nova tentativa de
autorização de uso.
362
Contingência DPEC Manual - Definida pelo Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência DPEC Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie o campo "Tipo de
Emissão" preenchido com o valor ‘4’. Esse modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso no WebService do estado de emissão da
NF-e, mas é possível transmitir arquivos através da rede e não se deseja modificar a série para a
utilização do SCAN.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistemas:
Fluxo Técnico:
364
NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘4’;
Interface de Entrada com o sistema de Origem;
Processo de Entrada irá verificar os parâmetros citados;
Se o tipo de emissão estiver definido no sistema de origem com o valor ‘4’, a NF-e será
inserida com tipo de emissão DPEC (NFE_NF_CAPA-TIPO_EMISSAO = '4', tag tpEmis = '4');
O XML será gerado;
A validação do XML será executada de acordo com parametrização do sistema;
A priorização será executada de acordo com parametrização do sistema;
O processo de Contingência DPEC irá gerar o lote DPEC, transmiti-lo ao WebService DPEC
e receber a autorização: evento 124 (DPEC recebido pelo Sistema de Contingência
Eletrônica);
O processo de impressão irá verificar se o DANFE já foi impresso e a impressão é
executada no sistema de origem, caso seja executada no componente Comply e-Docs
Server o DANFE será impresso com as informações de Número do Protocolo de
Autorização DPEC, além disso, será retornado ao sistema de origem o evento 124 - (DPEC
recebido pelo Sistema de Contingência Eletrônica);
Somente para SAP: Quando o SAP receber o evento 124, irá verificar se a Exit de
Impressão está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000
com o evento da NF-e, caso estiver irá imprimir o DANFE e gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 124. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e o evento 124.
Serão gerados os lotes de XML, a transmissão para o WebService e a recepção do evento
103 (Lote Recebido com Sucesso);
O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService;
O processo de impressão irá verificar se o DANFE é impresso no sistema de origem ou se
já ocorreu, caso nenhuma das alternativas sejam realizadas, a impressão acontecerá,
além disso, será retornado ao sistema de origem o evento 100.
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
DPEC está ativa e se o DANFE já foi impresso. Caso não estiver, somente irá atualizar a
tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver irá imprimir o DANFE, gravar o
indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
366
Contingência DPEC Automática
Para que a NF-e seja processada e transmitida com o Tipo de Emissão Contingência DPEC
Automática, é necessário que o sistema de origem não envie o campo "Tipo de Emissão"
preenchido, que o WebService esteja fora do ar, que os parâmetros de sistema apontem para o
tipo de emissão DPEC. Esse modelo deve ser adotado quando se deseja que o sistema Comply e-
Docs ao perceber que um WebService não está ativo, autorize o DPEC e permita a impressão do
DANFE.
Pré-Requitos:
Dados Técnicos:
Parâmetros de Sistema:
NFE_INTERFACE.CONTINGENCIA = ‘S’;
NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
utiliza_scan = ‘N’;
utiliza_dpec = ‘S’;
utiliza_fs = ‘N’;
utiliza_fsda = ‘N’.
Fluxo Técnico:
368
Processo de Entrada irá verificar os parâmetros citados;
Se o tipo de emissão não estiver definido no sistema de origem, será verificado o status
do WebService (NFE_WEB_SERVICE_STATUS) e se não estiver em operação e a Interface
utilizar contingência automática (NFE_INTERFACE.CONTINGENCIA = ‘S’) a NF-e será
inserida com tipo de emissão igual a DPEC (NFE_NF_CAPA-TIPO_EMISSAO = '4', tag tpEmis
= '4');
O XML será gerado;
A validação do XML será executada de acordo com parametrização do sistema;
A priorização será executada de acordo com parametrização do sistema;
O processo de Contingência DPEC irá gerar o lote DPEC, transmiti-lo ao WebService DPEC
e receber a autorização: evento 124 (DPEC recebido pelo Sistema de Contingência
Eletrônica);
O processo de impressão irá verificar se o DANFE já foi impresso e se é executada no
sistema de origem, caso a seja no componente Comply e-Docs Server o DANFE será
impresso com as informações de Número do Protocolo de Autorização DPEC, além disso,
será retornado ao sistema de origem o evento 124 - (DPEC recebido pelo Sistema de
Contingência Eletrônica);
Somente para SAP: Quando o SAP receber o evento 124, irá verificar se a Exit de
Impressão está ativa. Caso não estiver, somente irá atualizar a tabela /PWS/ZNFETB000
com o evento da NF-e, caso estiver irá imprimir o DANFE e gravar o indicador de
impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 124. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e o evento 124.
Serão gerados os lotes de XML, a transmissão para o WebService e a recepção do evento
103 (Lote Recebido com Sucesso);
O processo de consulta de lote irá verificar o status o lote e receberá o evento 100
(Autorizado o Uso da NF-e) do WebService;
O processo de impressão irá verificar se o DANFE é impresso no sistema de origem ou se
já ocorreu, caso nenhuma das alternativas sejam realizadas, a impressão acontecerá ,
além disso, será retornado ao sistema de origem o evento 100;
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa e se o DANFE já foi impresso. Caso não estiver, somente irá atualizar a tabela
/PWS/ZNFETB000 com o evento da NF-e, caso estiver irá imprimir o DANFE, gravar o
indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela
/PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba Contingência
do Painel de Controle, com farol verde e evento 100.
370
Contingência FSDA Manual - Definida pelo Sistema de
Origem
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FSDA Definida
no Sistema de Origem, é necessário que o sistema de origem apenas envie o campo "Tipo de
Emissão" preenchido com o valor ‘5’. Esse modelo deve ser adotado quando já se sabe que existe
um problema que irá impossibilitar a autorização de uso antes da emissão ou reprocessamento de
uma NF-e e não existe mais estoque de FS.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistema:
Fluxo Técnico:
NF-e é gerada no sistema de origem com o tipo de emissão com o valor ‘5’;
Interface de Entrada com o sistema de Origem;
Processo de Entrada irá verificar os parâmetros citados;
372
Se o tipo de emissão estiver definido no sistema de origem com o valor ‘5’, a NF-e será
inserida com tipo de emissão FSDA (NFE_NF_CAPA-TIPO_EMISSAO = '5', tag tpEmis = '5');
O XML será gerado;
A priorização será executada de acordo com parametrização do sistema;
O processo de impressão irá verificar se o FSDA já foi impresso e se esta é executada no
sistema de origem, caso seja executada no componente Comply e-Docs Server o FSDA
será impresso com as informações de Dados de NF-e (Segundo Código de Barras);
Serão gerados o lote de XML, a transmissão e a recepção do evento 103 (Lote Recebido
com Sucesso);
O processo de consulta de lote irá verificar o status deste e receberá o evento 100
(Autorizado o Uso da NF-e);
O processo de impressão irá verificar se o FSDA já foi impresso e se esta é executada no
sistema de origem, neste caso sabemos que ou a impressão já foi executada ou ocorrerá
no sistema de origem, logo, somente será retornado ao sistema de origem o evento 100;
O processo de impressão irá verificar se o FSDA é impresso no sistema de origem, caso
seja executada no componente Comply e-Docs Server o FSDA será impresso, além disso,
retornará ao sistema de origem o evento 100;
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
está ativa. Caso não estiver e o indicador de impressão estiver como ‘S’, somente irá
atualizar a tabela /PWS/ZNFETB000 com o evento da NF-e, caso estiver e o indicador de
impressão estiver como ‘N’ irá imprimir o FSDA, gravar o indicador de impressão = 'S'
(/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na tabela /PWS/ZNFETB0000-
COD_STATU = 100. Visualmente este registro estará na aba Contingência do Painel de
Controle, com farol verde e evento 100.
374
Contingência FSDA Automática
Para que a NF-e seja processada e transmitida com o tipo de emissão Contingência FSDA
Automática, é necessário que o sistema de origem não envie o campo “Tipo de Emissão”
preenchido, o WebService esteja fora do ar e que os parâmetros de sistema apontem para o tipo
de emissão FSDA. Este modelo deve ser adotado quando se deseja que o sistema Comply e-Docs
ao perceber que um WebService não está ativo, emita automaticamente a NF-e em FSDA.
Pré-Requisitos:
Dados Técnicos:
Parâmetros de Sistemas:
NFE_INTERFACE.CONTINGENCIA = ‘S’;
NFE_PARAMETROS.NOME ou NFE_CONFIG_FILIAL:
utiliza_scan = ‘N’;
utiliza_dpec = ‘N’;
utiliza_fs = ‘N’;
utiliza_fsda = ‘S’.
Fluxo Técnico:
Somente para SAP: Quando o SAP receber o evento 100, irá verificar se a Exit de Impressão
em Formulário de Segurança Documento Auxiliar está ativa. Caso não estiver e o indicador
de impressão estiver como ‘S’, somente irá atualizar a tabela /PWS/ZNFETB000 com o
evento da NF-e, caso estiver e o indicador de impressão apresentar ‘N’ irá imprimir o FSDA,
gravar o indicador de impressão = 'S' (/PWS/ZNFETB000-IMPRESSO) e atualizar o evento na
tabela /PWS/ZNFETB0000-COD_STATU = 100. Visualmente este registro estará na aba
Contingência do Painel de Controle, com farol verde e evento 100.
376
378
Serviço Web WCF (Inbound)
O sistema Comply e-Docs atende ao processo de recebimento de XML de Distribuição através do
Serviço Web disponibilizado pelo Comply e-Docs Server. Esse processo é chamado de Inbound.
Nas versões anteriores do sistema Comply e-Docs era necessário publicar um WebService em um
IIS Server. A partir da versão 4.00 isto não é mais necessário dado que o próprio Comply e-Docs
Server disponibiliza um Serviço Web que trabalha em um formato muito similar ao do WebService
tradicional.
Para ativar esse Serviço Web apenas é necessário iniciar o Serviço do Comply e-Docs Server.
Quando o Comply e-Docs Server é iniciado dois Serviços Web são publicados: com compactação e
sem compactação. Cada um desses serviços tem sua própria URL. O que diferencia estas URLs é a
porta na qual está sendo executado o Serviço. Para realizar esta configuração apenas é
necessário acessar o Assistente de Configuração e modificar as Chaves “PORT” (sem
compactação) e “PORT_COMPACTATION” (com compactação).
A diferença entre utilizar compactação ou não é relacionada ao método HTTP que será utilizado
para a comunicação com o Serviço Web. Recomendamos utilizar o Serviço com Compactação.
http://HOST:PORT/RecebimentoNFe
Onde HOST é a máquina onde o Comply e-Docs Server está instalado e PORT a porta utilizada.
Exemplo: http://localhost:1236/RecebimentoNFe.
Em caso de dúvidas, é possível verificar a URL que está sendo executada, para isso é necessário
acessar o “Event View” do Windows do Servidor. Após os eventos de inicialização do Serviço,
será gravado um log informando o caminho que o Serviço Web foi publicado. A mensagem é neste
formato: “Serviço http://localhost:1236/RecebimentoNFe iniciado com sucesso
(COMPACTAÇÂO)”.
Esta URL que deve ser utilizada para a transmissão de arquivos XMLs de distribuição.
380
Logo que o serviço do Comply e-Docs Server é iniciado, os serviços WCF são disponibilizados. As
mensagens com o log do início do funcionamento podem ser localizadas no Event Viewer do
Servidor em que a aplicação esta rodando.
382
Com Compactação ou Sem Compactação
A diferença entre os serviços com e sem compactação, é que a compactação prove uma
criptografia para os dados trafegados.
384
Modelo Operacional Inbound
Após a autorização de uso, o sistema emissor de NF-e do parceiro deverá enviar o XML no formato
de Distribuição para a URL do Serviço Web do sistema Comply e-Docs disponibilizada pelo cliente.
Estrutura do XML;
Validação do Schema XSD;
Desmembramento do XML em dados;
Inserção no Banco de Dados.
No término desse processo será gerada uma mensagem de retorno ao sistema que executou a
chamada do Serviço Web.
Caso o arquivo XML esteja autorizado a NF-e será registrada com o Status de Processamento 299
(Processo de Entrada de Nota Fiscal Concluído), caso não esteja autorizado a NF-e será registrada
com o Status de Processamento 212.
O meio físico de comunicação utilizado será a Internet, com o uso do protocolo HTTP. Para a
realização da conexão é necessário somente o Login do usuário.
A autenticação é definida através de usuário e senha que devem ser definidos na tabela
NFE_PARCEIRO_USUARIO.
O modelo de comunicação segue o padrão de WebServices definido pelo WS-I Basic Profile. A
troca de mensagens entre sistema emissor da NF-e e sistema Comply e-Docs será realizada no
padrão SOAP versão 1.2, com troca de mensagens XML no padrão Style/Enconding:
Document/Literal, wrapped. A opção “wrapped” representa a chamada aos métodos disponíveis
com a passagem de mais de um parâmetro.
Anexo a este documento existem as mensagens SOAP de envio de XML e retorno de evento.
388
Mensagens do WebService
Após o envio do arquivo XML ao Serviço Web do sistema Comply e-Docs podem ocorrer as
seguintes mensagens para o NF-e:
390
Verificando o Serviço Web
Para verificar se o Serviço Web está funcionando corretamente é possível adicionar a URL do
Serviço em um Browser de Internet. O exemplo abaixo é usando o Google Chrome:
Validação da Chave de Acesso na SEFAZ
É possível configurar uma regra de validação para que ao receber arquivos XMLs do Inbound, seja
realizada uma consulta na SEFAZ para verificar a autenticidade da NF-e. Para tanto é necessário
ativar um parâmetro. Este parâmetro deve ser executado através da transação do componente
Framework.
Atalho: VALIDAINF
É necessário configurar todas as filiais que se deseja verificar a autenticidade com a regra
“Valida se a NF-e está autorizada”.
A imagem a seguir ilustra como configurar para a filial EMP1 da empresa EMP1:
392
Anexo – NF-e
Exemplo de uma mensagem dentro do SOAP de envio de XML completa:
394
uYnIvbGNyL1NlcmFzYS9yZXBvc2l
0b3Jpby9sY3Ivc2VyYXNhY2R2MS5jcmwwgZcGCCsGAQUFBwEBBIGKMIGHMDwGCCsGAQUFBzABhjBod
HRwOi8vb2NzcC5jZXJ0aWZpY2F
kb2RpZ2l0YWwuY29tLmJyL3NlcmFzYWNkdjEwRwYIKwYBBQUHMAKGO2h0dHA6Ly93d3cuY2VydGlm
aWNhZG9kaWdpdGFsLmNvbS5ici9
jYWRlaWFzL3NlcmFzYWNkdjEucDdiMA0GCSqGSIb3DQEBBQUAA4IBAQA2fZkSQ4yLh6hq9bx1awAzk6u
LrSdlh7iNieC9YMMS4CAQlfcNoM
7xqakYSzpe+DJtm5udvVC3smzy8pJVsdlKJfcNRQVhNSAw57G2aH+af6jHplQn2Pulu9K23Y8sZQTvvMAy
3wJhj3DwUKLRf2AQANzRTt0rAO
j5pshjtfw/wcPtZeCjHZjbzzhJNGe9PegT8TaZbELggIqtF2ORw1ifK13z74ujWnqtOCOOByUgN9zXFGwp
JApP09tSX6bR+9GSxIOogD+RNVI
urRGzq29i+TH5z9FflzpxtzYCnyuuQ/jdtoFvVKZBSAa/qPEPwpwHrB6Vzi/MGKn6Tlc1UbiH</X509Certi
ficate></X509Data></KeyInfo>
</Signature></NFe><protNFe versao="1.10"
xmlns="http://www.portalfiscal.inf.br/nfe"><infProt><tpAmb>2</tpAmb><verAplic>SP_NFE_PL_0
05d</verAplic><chNFe>
35090859275792000150550000000029330002386870</chNFe><dhRecbto>2009-09-
15T16:15:37</dhRecbto><nProt>135090013179264</nProt><digVal>EKGdBzeqUojTuwJRzH97RfcZZ
YU=</digVal><cStat>100</cStat>
<xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></nfeProc> </xml>
</Recebimento>
</soap:Body>
</soap:Envelope>
Segue abaixo um exemplo de uma mensagem dentro do SOAP de retorno de evento do XML
enviado:
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<RecebimentoResponse xmlns="http://recebimento.pw-nfe.procwork.com.br/">
<RecebimentoResult>
<CodigoMensagem>3</CodigoMensagem>
<Mensagem>CNPJ não cadastrado - Filial Inexistente</Mensagem>
<NumeroDocumento>
35090859275792000150550000000029330002386870</NumeroDocumento>
</RecebimentoResult>
</RecebimentoResponse>
</soap:Body>
</soap:Envelope>
396
Client Inbound
O Client Inbound é um programa que pode ser utilizado para realizar o envio de XMLs de
Distribuição ao Serviço Web Inbound do componente Comply e-Docs Server.
Após a autorização de uso, o sistema emissor de NF-e deverá disponibilizar o XML no formato de
Distribuição para posterior envio ao Serviço Web Inbound. O usuário poderá utilizar o Client
Inbound para transmitir o arquivo XML destinado a parceiros que possuem o Serviço Web Inbound
do sistema Comply e-Docs.
O Client Inbound irá transmitir o XML de Distribuição ao Serviço Web Inbound do componente
Comply e-Docs Server que, por sua vez, irá realizar a verificação da estrutura do XML, validação
do Schema XSD, desmembramento do XML em dados e a inserção no Banco de Dados. Ao término
desse processo será gerada uma mensagem de retorno ao Client Inbound que a registrará e
passará para o processamento do próximo arquivo XML a ser enviado.
O envio e retorno de mensagem do Serviço Web Inbound é através de processo síncrono, ou seja,
o processamento da solicitação de serviço e o retorno são concluídos na mesma conexão, com a
devolução de uma mensagem informando o resultado do processamento do serviço solicitado.
O diagrama a seguir ilustra o fluxo de comunicação entre o Client Inbound e o Serviço Web
Inbound do Sistema Comply e-Docs:
398
Padrões Técnicos
Documento XML:
Os padrões técnicos utilizados pelo sistema Comply e-Docs para os documentos XML de
Distribuição estão definidos no Manual do Contribuinte 4.0.1. Este padrão abrange a codificação
do XML (UTF-8), Namespace do XML, otimizações para a geração do arquivo e validação do
Schema XSD (é interessante antes do envio do XML para o Serviço Web Inbound, que o mesmo
seja validado de acordo com o Schema XSD pela aplicação emissora).
Comunicação:
A comunicação entre o Client e o Servidor Inbound do sistema Comply e-Docs é baseada em
Serviço Web WFC (Windows Communication Foundation) disponibilizados pelo cliente a seus
parceiros.
O meio físico de comunicação utilizado será a Internet, com o uso do protocolo HTTP. Para que a
conexão seja realizada com sucesso, somente é necessário o Login do usuário.
A autenticação é definida através de usuário e senha que devem ser disponibilizados pelo Cliente
detentor do Inbound.
O modelo de comunicação segue o padrão de WebServices definido pelo WS-I Basic Profile. A
troca de mensagens entre Client e o Server Inbound do sistema Comply e-Docs é realizada no
padrão SOAP versão 1.2.
Pré-Requisitos Instalação Client Inbound
Software:
Sistema Operacional:
3.5 ou Superior
Hardware:
Processador:
400MHz Pentium ou equivalente (mínimo), 1GHz Pentium ou equivalente (Recomendado).
Memória:
128 MB (mínimo), 512 MB (recomendado). Utilização média 40 MB.
Armazenamento:
400
Instalação
O Client Inbound do Sistema Comply e-Docs pode ser instalado em Servidores e Clients do
Windows.
2. Iniciar o Wizard clicando sobre o botão "Avançar". O sistema apresentará a seguinte tela:
3. Selecionar o caminho para instalação dos programas do Client Inbound, definir quais
usuários devem possuir acesso a este aplicativo, Todos ou Somente eu, e em seguida
clicar sobre o botão "Avançar":
4. Iniciar a Instalação clicando sobre o botão “Avançar”:
402
5. Aguardar a finalização da instalação:
6. E em seguida clicar sobre o botão "Fechar":
404
Configuração
Configuração
Antes de utilizar o Client Inbound do sistema Comply e-Docs é necessário configurar quais
Serviços Web serão utilizados. Dessa forma, para configurar o Client Inbound é necessário seguir
os seguintes passos:
1. Acessar o Client Inbound através do atalho “Client Inbound Comply e-Docs” localizado
na Área de Trabalho do Windows:
406
3. Clicar sobre o botão “Adicionar Nova Credencial”. Nomear a Nova Credencial e Clicar
sobre o botão “Salvar”:
Configurar os campos de acordo com a descrição abaixo e Clicar sobre o botão “Salvar”:
o Usuário: Usuário do Serviço Web;
408
o Senha: Senha do Usuário do Serviço Web;
o CNPJ do Destinatário: CNPJ dos Destinatários relacionados a aquele Serviço Web
Inbound;
o URL Compactação: URL do Serviço Web Inbound se o Serviço usar Compactação;
o URL: URL do Serviço Web Inbound se o Serviço não usar Compactação;
o Habilitar Framework: Informa que o Serviço Web Inbound está usando a
publicação de URL a partir do componente Framework. (Normalmente esta
função não está disponível).
o URL Compactação Framework: URL do Serviço Web Inbound publicada pelo
componente Framework Compactação;
o URL Framework: URL do Serviço Web Inbound publicada pelo componente
Framework Sem Compactação.
Configurar Proxy
1. Clicar sobre o botão “Configurar Proxy”:
410
Operação
Transmitir
Para realizar a transmissão de XMLs de Distribuição é necessário seguir os seguintes passos:
412
6. Será exibida uma mensagem de conclusão de transmissão com sucesso:
ou erro:
Exportar Resultados
Para realizar a exportação dos resultados dos XMLs de Distribuição transmitidos é necessário
seguir os seguintes passos:
1. Clicar sobre o botão “Exportar Resultados”:
414
Importar Resultado
Para realizar a importação de resultados de transmissão anteriores é necessário seguir os
seguintes passos:
Modo Texto
Para realizar a transmissão de XMLs de Distribuição em modo texto é necessário seguir os
seguintes passos:
1. Criar um diretório para inserir XMLs de Distribuição pendentes de envio e que não foram
transmitidos por erro de comunicação. Este exemplo utilizará a pasta
"C:\Inbound_XML\Exporta\" e “C:\Inbound_XML\Erro”;
2. Criar um arquivo texto com extensão .bat (arquivo de linha de comando) na pasta que o
Client Inbound foi instalado. Esta pasta normalmente é encontrada no caminho:
“C:\Program Files\Sonda Procwork\Client Inbound NF-e”. O arquivo .bat deve possuir o
seguinte conteúdo:
É necessário que o usuário configurado para executar o arquivo .bat tenha acesso aos diretórios
mencionados anteriormente.
3. Criar uma tarefa agendada para a execução do arquivo criado anteriormente. Para isso é
necessário acessar o “Painel de Controle” do Windows. O caminho normalmente é “Iniciar
> Painel de Controle > Tarefas Agendadas”. Em seguida selecione a opção “Adicionar uma
nova tarefa agendada”.
418
4. Inserir as informações solicitadas. É necessário configurar a freqüência do disparo da
tarefa e o programa a ser executado. O programa deve ser o arquivo .bat criado
anteriormente:
5. Concluir o Assistente.
420
Integração e Requisitos Técnicos Comply e-Docs
Introdução
A finalidade deste documento é prover informações sobre os requisitos necessários para a
implementação do sistema Comply e-Docs.
3. Comply e-Docs Server: trata-se do servidor no qual são realizados todos os processos de
comunicação com o mundo externo. É nesse servidor que são executados os vários
processos em Batch responsáveis por:
É importante ressaltar que esse servidor não realiza nenhum tipo de comunicação com o cliente,
portanto ele pode estar em uma DMZ fora da rede, desde que tenha comunicação com o banco de
dados.
8. Emissores de notas fiscais são os sistemas ERPs responsáveis pela emissão dos documentos
fiscais da empresa. Existe um canal de comunicação entre o Comply e-Docs Server e ERP
para realizar a operação de extração da nota fiscal;
9. São os outros sites da empresa que realizam comunicação com a filial onde está
localizado o servidor do sistema Comply e-Docs. Essa comunicação pode ser feita através
de protocolo TCP/IP ou http.
10. Impressora – meio pelo qual é feita a impressão do DANFE, caso a opção de impressão
seja feita a partir do sistema Comply e-Docs, e não do sistema de origem. Nesse caso,
deve estar liberada a comunicação entre a impressora e o Servidor de aplicação, Comply
e-Docs Server e Clientes.
422
A instalação do sistema Comply e-Docs não requer servidores físicos distintos para serem
executados. Ambos os serviços, Aplicação e Processos, podem estar instalados no mesmo
equipamento, porém a redundância dos equipamentos com dois serviços instalados nos dois
servidores garante ao sistema um balanceamento da carga e maior disponibilidade do serviço,
visto que, caso haja algum defeito no equipamento, o outro se manterá on-line, havendo apenas
uma pequena sobrecarga no serviço. O gerenciamento da alta disponibilidade e o balanceamento
de carga são 100% gerenciados pela aplicação, não havendo a necessidade de nenhum outro
equipamento ou software, como, por exemplo, um cluster.
A instalação do NFS-e, não requer servidores físicos distintos para serem executados, ambos os
serviços, Aplicação e Processos, podem estar instalados no mesmo equipamento, porém, a
redundância dos equipamentos com os serviços instalados nos 2 servidores, garante ao sistema
um balanceamento da carga e maior disponibilidade do serviço, visto que caso haja algum defeito
no equipamento, o outro irá manter-se on-line havendo apenas uma pequena sobrecarga no
serviço.
O gerenciamento da alta disponibilidade e balanceamento de carga são 100% gerenciado pela
aplicação, não havendo a necessidade de nenhum outro equipamento ou software, como por
exemplo, um cluster.
424
Servidor de Banco de Dados
Requisitos:
Banco de Dados Oracle (versão 10 g ou superior) ou Microsoft SQL Server (versão 2000
com Service Pack 4 ou superior);
Sistema operacional que atenda aos requisitos do banco de dados requeridos pelo
fabricante para as versões citadas acima;
Configuração de hardware mínima: um processador e 2GB de memória (pode variar em
função do volume de dados);
O espaço necessário para armazenamento de dados depende do volume de informações a
serem tratadas pelo produto.
426
Servidor de Aplicação
Requisitos:
Sistema Operacional Windows 2003 Server ou Superior, 32 ou 64 Bits;
Microsoft .NET Framework 4.0;
"Client" do banco de dados definido pelo cliente (Oracle 11g ou SQL Server 2000);
Configuração de hardware mínima: dois processadores e 4Gb de memória (pode variar em
função do volume de dados);
Espaço livre em disco para instalação do framework das aplicações da Procwork: 150 MB;
Microsoft DTC (Coordenador de transações distribuídas) ativado no servidor;
Somente para impressão através de Cristal Reports: SAP Crystal Report 2010 SP2;
Somente para impressão através de PDF: Adobe Reader 8 ou superior;
Somente se houver Sistema de Origem SAP: SAP .Net Connector 3.0.
Portas:
Servidor de Aplicação: 9500 (Entrada/Saída). (Esta porta pode ser modificada de acordo
com a configuração executada durante o projeto).
Para o módulo NFS-e o Servidor de Aplicação: 9000(Entrada/Saída).
Desktop do Usuário
Requisitos:
Sistema Operacional Windows (versão XP Professional ou superior);
Microsoft .NET Framework 4.0;
Memória mínima de 256MB;
Resolução de vídeo de 1024x768 pixels;
Espaço livre em disco para instalação do runtime framework das aplicações da Procwork:
200 MB;
Somente para impressão através de Cristal Reports: SAP Crystal Report 2010 SP2;
Somente para impressão através de PDF: Adobe Reader 8 ou superior.
Portas:
Servidor de Aplicação: 9500 (Entrada/Saída). (Esta porta pode ser modificada de acordo
com a configuração executada durante o projeto).
Para o módulo NFS-e o Servidor de Aplicação: 9000(Entrada/Saída).
428
Outros Requisitos do Produto
Informações Sobre os Servidores de Banco de Dados:
Endereço do Servidor;
Nome do Banco de Dados;
Usuário do Banco;
Senha do Usuário do Banco de Dados.
O usuário de banco de dados deve possuir permissão para executar comandos DDL e DML. É
necessário que o consultor que realize a implantação possua as mesmas permissões DML e DDL
nos ambientes de DEV e QA.
Todas as impressoras devem dar suporte a Post-Script quando se deseja imprimir em formato
PDF, tanto para impressão automática quanto para a impressão manual executada pelo usuário.
Eventos de NF-e
Evento de NF-e
Um evento de NF-e é um documento adicional que será anexado a uma NF-e existente ou
pendente de autorização de uso. A SEFAZ planeja adicionar outros documentos digitais e associá-
los a NF-e.
O primeiro Evento de segunda geração (NF-e 2G) se chama Carta de Correção Eletrônica.
Acreditamos que o segundo evento a ser utilizado será o Evento de Cancelamento de NF-e.
430
CC-e (Carta de Correção Eletrônica)
A Carta de Correção Eletrônica é um evento para corrigir as informações da NF-e. O autor do
evento é o emissor da NF-e. A mensagem XML do evento será assinada com o certificado digital
que tenha o CNPJ base do Emissor da NF-e.
O evento será utilizado pelo contribuinte e o alcance das alterações permitidas é definido no § 1º
do art. 7º do Ajuste SINIEF S/N, que transcrevemos a seguir:
“Art. 7º Os documentos fiscais referidos nos incisos I a V do artigo anterior deverão ser extraídos
por decalque a carbono ou em papel carbonado, devendo ser preenchidos a máquina ou
manuscritos a tinta ou a lápis-tinta, devendo ainda os seus dizeres e indicações estar bem
legíveis, em todas as vias.
(...)
§ 1º-A Fica permitida a utilização de carta de correção, para regularização de erro ocorrido na
emissão de documento fiscal, desde que o erro não esteja relacionado com:
I - as variáveis que determinam o valor do imposto tais como: base de cálculo, alíquota, diferença
de preço, quantidade, valor da operação ou da prestação;
O registro de uma nova Carta de Correção substitui a Carta de Correção anterior, assim a nova
Carta de Correção deve conter todas as correções a serem consideradas.
Configurações Necessárias
Para estar habilitado a emitir uma Carta de Correção Eletrônica é necessário algumas
configurações no sistema Comply e-Docs.
Após essa configuração, apenas é necessário reiniciar o componente Comply e-Docs Server que o
sistema Comply e-Docs já estará apto a trabalhar com eventos de NF-e.
432
WebService de Eventos de NF-e:
Enviando Eventos:
Para enviar um Evento de NF-e através de Interface EDI é necessário preencher a tabela
NFE_NF_CAPA_EVENTO_EDI. A tabela deve ser preenchida de acordo com o leiaute abaixo:
Para buscar o resultado de um evento é necessário utilizar a mesma tabela utilizada hoje em dia
para NF-es: a tabela NFE_NF_RET_ORIGEM_EDI. A diferença neste caso é que o campo EVENTO
estará marcado com um “X” informando assim que se trata de uma resposta do Evento de uma
NF-e e não de uma NF-e.