Você está na página 1de 111

Manual de Integração WS

InvoiCy NFS-e

Versão 2.19.0.0

Fevereiro/2014
Sumário

ÍNDICE DE FIGURAS ............................................................................................. 4

1 INFORMAÇÕES GERAIS ..........................................................................6

1.1 APRESENTAÇÃO......................................................................................... 6
1.2 VISÃO GERAL DO SISTEMA ........................................................................... 6
1.3 PROPÓSITO DO DOCUMENTO ........................................................................ 6
1.4 LISTA DE ABREVIATURAS, SIGLAS E TERMOS...................................................... 7

2 PASSOS PARA INTEGRAR O ERP COM O INVOICY NFS-E .......................8

2.1 ACESSO AO SISTEMA .................................................................................. 8


2.2 CADASTRO DA EMPRESA .............................................................................. 8
2.3 INTEGRAÇÃO COM O ERP .......................................................................... 17
2.3.1 Segurança nos Web Services ........................................................... 17
2.3.2 Estrutura do Web Service ................................................................ 18
2.3.3 Tabela de siglas e definições............................................................ 19
2.3.4 Cadastro do prestador ..................................................................... 20
2.3.4.1 Campos do XML de envio do cadastro do prestador ..................... 21
2.3.4.2 Campos do XML do retorno do cadastro do prestador .................. 27
2.3.5 Envio de RPS .................................................................................. 30
2.3.5.1 Campos do XML de envio ........................................................... 31
2.3.5.2 Retorno do envio de RPS ........................................................... 53
2.3.5.3 Campos do XML de retorno do envio .......................................... 53
2.3.6 Consulta de RPS ............................................................................. 56
2.3.6.1.1 Campos do XML de consulta do RPS ..................................... 57
2.3.6.1.2 Retorno da consulta de RPS ................................................. 60
2.3.6.1.3 Campos do XML de retorno da consulta ................................ 60
2.3.7 Cancelamento de NFS-e .................................................................. 63
2.3.7.1.1 Campos do XML para cancelamento da NFS-e ....................... 64
2.3.7.1.2 Retorno do cancelamento da NFS-e...................................... 66
2.3.8 Espelho do RPS ............................................................................... 68
2.3.8.1.1 Campos do XML do envio do espelho do RPS ........................ 69
2.3.8.1.2 Campos do XML do retorno do espelho do RPS ..................... 71
2.3.9 Download do XML da NFS-e ............................................................. 73
2.3.9.1.1 Campos do XML para o download da NFS-e .......................... 74
2.3.9.1.2 Campos do XML para o retorno do download da NFS-e ......... 76
2.3.10 Orientaçãoes aos municípios que integram com o InvoiCy NFS-e
através de arquivo ................................................................................................... 78
2
Manual de Integração WS InvoiCy NFS-e
3 INFORMAÇÕES ESPECÍFICAS DE PADRÕES .........................................80

3.1 ÁBACO.................................................................................................. 80
3.2 DFSNET .............................................................................................. 80
3.3 E-NOTA PORTAL PÚBLICO .......................................................................... 82
3.4 E&L .................................................................................................... 83
3.5 IPM..................................................................................................... 83
3.6 ISS.NET ............................................................................................... 84
3.6.1 Como enviar RPS para o layout do ISS.NET?..................................... 84
3.6.1.1 Solicitação para ambiente de Homologação (Testes) ................... 84
3.6.2 Solicitação para ambiente de Produção (Oficial) ................................ 85
3.7 LENÇOIS PAULISTA................................................................................... 86
3.8 SIGCORP – LONDRINA ............................................................................. 86
3.9 E-CAUCAIA ............................................................................................ 87
3.10 FREIRE ................................................................................................. 88
3.11 MUNICÍPIOS QUE INTEGRAM COM O INVOICY NFS-E ATRAVÉS DE ARQUIVO ............ 88
3.11.1 Arquivo TXT .................................................................................. 88
3.11.2 Arquivo XML/CSV .......................................................................... 89
3.12 NFWEB ............................................................................................... 89
3.13 NF PAULISTANA ...................................................................................... 90
3.14 ISSWEB - FIORILLI ................................................................................. 90
3.15 CECAM ................................................................................................ 91
3.16 GOIÂNIA ............................................................................................... 92
3.17 SIGCORP – TXT..................................................................................... 93

4 ANEXOS .................................................................................................93

4.1 VALIDAÇÃO DE ARQUIVOS XML ................................................................... 93


4.2 EXEMPLO DE GERAÇÃO DE CK EM C# ........................................................... 96
4.3 EXEMPLO DE GERAÇÃO DE CK EM JAVA.......................................................... 97
4.4 RESERVED CHARACTERS IN HTML ............................................................... 98
4.5 ISO 8859-1 SYMBOLS ............................................................................. 98
4.6 ISO 8859-1 CHARACTERS ........................................................................ 98
4.7 MATH SYMBOLS SUPPORTED BY HTML ........................................................ 100
4.8 GREEK LETTERS SUPPORTED BY HTML ........................................................ 101
4.9 CÓDIGOS PARA A REPRESENTAÇÃO DE NOMES DOS PAÍSES ................................. 102
4.10 ATIVIDADES DE ITENS DE SERVIÇOS COM MARCAÇÃO NÃO TRIBUTÁVEL – DSFNET .. 108
4.11 MUNICÍPIOS INTEGRADOS ......................................................................... 110
4.12 EXEMPLO DE DECODIFICAÇÃO DE BASE64 PARA ARQUIVO .................................. 110

3
Manual de Integração WS InvoiCy NFS-e
Índice de Figuras

Figura 1 - Cadastro de uma nova empresa - Dados da empresa ............................. 9


Figura 2 - Cadastro de uma nova empresa – Certificado ...................................... 11
Figura 3 - Selecionar dispositivo ......................................................................... 12
Figura 4 - Cadastro de uma nova empresa – Licenciamento ................................. 12
Figura 5 - Notificação......................................................................................... 13
Figura 6 - Cadastro de uma nova empresa - Lista de usuários .............................. 13
Figura 7 - Selecionar usuários ............................................................................ 14
Figura 8 - Usuário adicionado ............................................................................. 14
Figura 9 - Cadastro de uma nova empresa - Novo usuário ................................... 15
Figura 10 - Cadastro de uma nova empresa - Final .............................................. 15
Figura 11 - Cabeçalho com PK e CK .................................................................... 17
Figura 12-- Estrutura do XML do cadastro do prestador ....................................... 20
Figura 13 - Estrutura do XML de envio para o cadastro do prestador .................... 21
Figura 14 - Estrutura do XML do envio de RPS .................................................... 30
Figura 15 – Conteúdo da TAG “EntradaXML” ....................................................... 31
Figura 16 - XML de retorno após o envio ............................................................. 53
Figura 17 - Estrutura do XML da consulta de RPS ................................................ 56
Figura 18 - XML de retorno após a consulta do RPS ............................................. 60
Figura 19 - Estrutura do XML do cancelamento da NFS-e ..................................... 63
Figura 20 - XML do retorno do cancelamento ...................................................... 66
Figura 21 - Espelho do RPS ................................................................................ 69
Figura 22 - Estrutura do XML do download do XML .............................................. 73
Figura 23 - Estrutura do XML de envio para o download do XML .......................... 74
Figura 24 - XML enviado para o InvoiCy NFS-e .................................................... 83
Figura 25 - XML enviado para o InvoiCy NFS-e .................................................... 94
Figura 26 - Validação do XML ............................................................................. 94
Figura 27 - Selecionar arquivo XSD ..................................................................... 95
Figura 28 – Erro na estrutura do XML ................................................................. 96
Figura 29 - Validação com sucesso (XML sem erro) ............................................. 96
Figura 30 - Exemplo de geração de MD5 em C# .................................................. 97
Figura 31 - Exemplo de geração de MD5 em Java................................................ 97
Figura 32 - Municípios integrados ...................................................................... 110
Figura 33 - Exemplo de decodificação de base64 para arquivo ........................... 110

4
Manual de Integração WS InvoiCy NFS-e
Tabela de Revisões

Nº versão do sistema Data Descrição da Revisão


2.0.0.0 28/04/2013 Novo layout do InvoiCy NFS-e
2.1.1.0 27/05/2013 Integração de municípios do padrão
ISS.net
2.2.1.0 14/06/2013 Integração de municípios do padrão
Dueto. Inclusão do web service do
cadastro do prestador e download do
xml da NFS-e
2.3.0.0 14/07/2013 Integração de municípios dos padrões
Ábaco e ISS 4R
2.4.0.0 30/07/2013 Integração de municípios dos padrões
E&L e WebISS. Retirado o motivo do
cancelamento. Inserido novos botões:
validar esquema XSD e Enviar todos os
RPS
2.5.0.0 01/08/2013 Integração de municípios do padrão
PRODATA
2.6.0.0 12/08/2013 Integração de municípios do padrão
FGMAISS
2.7.0.0 02/09/2013 Integração de municípios do padrão
Lençóis Paulista
2.8.0.0 11/09/2013 Integração de municípios dos padrões:
FintelISS, Goiânia, Sumaré e São
Leopoldo. Melhorias no espelho do RPS
2.9.0.0 27/09/2013 Integração de municípios dos padrões:
Awatar, Generativa e NFWEB
2.10.0.0 11/10/2013 Alteração de layout de integração do
InvoiCy NFS-e para atender o
parcelamento no padrão Betha
2.11.0.0 23/10/2013 Integração de municípios dos padrões:
DSFNET e IPM
2.12.0.0 04/11/2013 Integração de municípios do padrão
Smarpd Sil
2.13.0.0 11/11/2013 Integração de municípios dos padrões
Nota Carioca e NF Paulistana
2.14.0.0 02/12/2013 Integração de municípios dos padrões
ISSe e SIGCorp – Londrina
2.15.0.0 12/12/2013 Integração de municípios dos padrões e-
nota Porta Público e JFISS Digital
2.16.0.0 20/12/2013 Integração de Municípios do padrão E-
Caucaia e Freire.
2.17.0.0 06/01/2014 Melhorias na interface web e correção
de bugs.
2.18.0.0 16/01/2014 Novos campos no cadastro de Prestador
e a integração com novo padrão:
ISSWEB Fiorilli.
2.19.0.0 12/02/2014 Integração de Municípios do padrão
CECAM e SIGCorp - TXT

5
Manual de Integração WS InvoiCy NFS-e
1 Informações gerais

Nesta seção são descritas as informações gerais do software InvoiCy


NFS-e, uma breve apresentação, a visão geral do sistema, o propósito deste
documento e alguns termos e abreviaturas utilizados no manual.

1.1 Apresentação

Esse manual foi elaborado pela empresa Migrate Company Sistemas de


Informação Ltda. e todos os Direitos Autorais são Reservados. Não é
autorizada à distribuição ou reprodução desta publicação.

O conteúdo tem por objetivo servir como instrumento de auxílio para a


integração de ERPs com o sistema InvoiCy NFS-e.

1.2 Visão geral do sistema

O InvoiCy NFS-e é uma solução complementar ao ERP do cliente, que


permite o gerenciamento completo do ciclo de envio e retorno do RPS à
prefeitura.

1.3 Propósito do documento

Este documento é voltado para o usuário do software, a fim de prover


informações suficientes para a utilização do InvoiCy NFS-e para o envio de
RPS à prefeitura. O manual deve ser utilizado como meio de consulta ao
InvoiCy NFS-e.

6
Manual de Integração WS InvoiCy NFS-e
1.4 Lista de abreviaturas, siglas e termos

Para sua melhor compreensão, aqui são listados alguns termos e


abreviaturas utilizadas neste manual.

Abreviatura/sigla/termo Definição
CK Communication key
CSV Comma Separated Values. Tipo de arquivo texto
com campos separados pelo caractere ‘;’.
ERP Enterprise Resource Planning (SIGE – Sistemas
Integrados de Gestão Empresarial)
MD5 O MD5 (Message-Digest algorithm 5) é
um algoritmo de hash de 128 bits unidirecional
desenvolvido pela RSA Data Security, Inc.,
descrito na RFC 1321, e muito utilizado
por softwares com protocolo ponto-a-ponto (P2P,
ou Peer-to-Peer, em inglês) na verificação de
integridade de arquivos e logins
NFS-e Nota Fiscal de Serviço Eletrônica
PK Chave de parceiro
RPS Recibo Provisório de Serviço
SOAP Simple Object Access Protocol (protocolo para
troca de informações estruturadas baseado em
XML utilizado pelo InvoiCy NFS-e)
TAG “Tag” em inglês quer dizer etiqueta. Auxiliam na
hora de organizar e classificar informações,
agrupando aquelas que receberam a mesma
marcação, facilitando encontrar outras
relacionadas.
WS Web Service – Um serviço que fica rodando na
web aguardando que uma aplicação solicite sua
execução. É um procedimento que recebe
valores, processa e dá um retorno
XML Extended Markup Language (estruturas utilizadas
para envio de dados através de comunicação
web)

7
Manual de Integração WS InvoiCy NFS-e
2 Passos para integrar o ERP com o InvoiCy NFS-e

2.1 Acesso ao sistema

O acesso ao sistema deve ser realizado através de navegador para


internet no endereço: https://gnfse.gnfe.com.br/

2.2 Cadastro da empresa

Para cadastrar uma nova empresa no InvoiCy NFS-e é necessário


seguir alguns passos de configuração conforme está descrito a seguir.

Este procedimento pode ser realizado do wizard de nova empresa, de


acordo com o caminho abaixo:

Menu inicial –

O cadastro de uma nova empresa apresenta várias telas para


preenchimento, explanadas a seguir:

1.Dados da empresa

Para a realização do cadastro de uma empresa, é necessário realizar o


preenchimento de: Dados básicos, Localização e Avançadas.

8
Manual de Integração WS InvoiCy NFS-e
Figura 1 - Cadastro de uma nova empresa - Dados da empresa

Dados básicos

- Tipo = preenchimento obrigatório, deve ser informado o tipo da


pessoa: física ou jurídica;
- CPF/CNPJ = preenchimento obrigatório;
- Inscrição estadual
- Inscrição municipal
- Adesão ao simples nacional
- Nome fantasia = preenchimento obrigatório;
- Razão social = preenchimento obrigatório;
- Apelido = preenchimento obrigatório;
- Site
- E-mail
- Telefone

9
Manual de Integração WS InvoiCy NFS-e
Localização

- Tipo de endereço = preenchimento obrigatório, por exemplo Rua,


avenida, etc;
- Logradouro = preenchimento obrigatório;
- Número
- Complemento
- Bairro = preenchimento obrigatório;
- UF = preenchimento obrigatório;
- Município = preenchimento obrigatório, deve ser informado o
município do prestador do serviço, pelo fato que os RPS serão emitidas
neste município;
- CEP = preenchimento obrigatório;

Ambiente
- Ambiente = deve ser informado o ambiente atual da empresa
(homologação ou produção);
- Versão do WS = deve ser informado a versão do WS. A orientação é
utiilizar sempre a versão mais nova;
- MAX RPS por lote = deve ser informado o número máximo de RPS
que deve ser enviado por lote. A orientação é que seja configurada =
1;
- Processamento = deve ser informado Síncrono ou Assíncrono;
- Usuário Autent e Senha Autent = são informações que devem ser
preenchidas quando a prefeitura exige que essas informações (login e
senha) sejam enviadas na emissão via webservice.

Avançadas

- Imprime NFSE se efetivada = caso for informado “Sim”, após o RPS


for efetivado, ao imprimir o espelho do RPS, é troca texto RPS por NFS-
e, e é removido o texto "Este documento não é válido como nota fiscal
de serviços, mas apenas como recibo provisório de serivço e deverá
obrigatoriamente ser convertido em nota fiscal eletrônica de serviço no
prazo máximo de 10 (dez) dias, conforme decreto municipal. Consulte a
10
Manual de Integração WS InvoiCy NFS-e
conversão deste documento em nota fiscal eletrônica de serviço no site
da prefeitura.”
- Consultar ao enviar = por padrão sempre consulta. Caso seja Não,
não será realizada uma consulta ao enviar (recepção) o RPS. Dessa
forma, a consulta do RPS será realizada apenas quando chamado o
webservice de consulta;
- Observação = este campo deve ser utilizado para inserir observações
relacionadas a empresa.

Após preencher todos os campos clicar em “Avançar”.

2.Certificado

Figura 2 - Cadastro de uma nova empresa – Certificado

Nesta opção deverá ser informado o caminho do certificado digital A1.

O arquivo a ser informado no campo Certificado é o .pfx.

No campo “Certificado” é necessário clicar no botão “Selecionar


Arquivo”, após isso será aberta outra tela onde será necessário localizar o
arquivo com extensão .pfx.

11
Manual de Integração WS InvoiCy NFS-e
Figura 3 - Selecionar dispositivo

Após selecionado o arquivo, basta clicar no botão “Abrir” que essa tela
será fechada, pode ser observado que o campo “Arquivo PFX” estará
preenchido, e após é necessário informar a senha do certificado e por fim
basta clicar no botão “Avançar” e poderá avançar para o próximo passo.

3.Licenciamento

Figura 4 - Cadastro de uma nova empresa – Licenciamento

12
Manual de Integração WS InvoiCy NFS-e
O terceiro passo do cadastro é onde deve ser solicitado o
licenciamento para a empresa, nessa etapa deve ser inserida a Chave de
parceiro da empresa no campo “Chave de parceiro”, logo abaixo, no campo
“Nome do solicitante” deve ser inserido o nome de quem está fazendo a
solicitação, bem como o e-mail do mesmo.

Após ser realizado o preenchimento de todos os campos, clicar em


Solicitar licença, após este procedimento é mostrado mensagem de
empresa licenciada com sucesso, conforme figura abaixo:

Figura 5 - Notificação

Após clicar em “Avançar”. Este botão somente é habilitado se a


solicitação da licença foi realizada.

4.Usuários

Nesta etapa é possível inserir os usuários da respectiva empresa. Nesta


tela são mostrados as opções de Selecionar usuário e Novo usuário.

= nesta opção são mostrados todos os usuários


que estão cadastrados na base de dados para esta empresa.

Figura 6 - Cadastro de uma nova empresa - Lista de usuários

13
Manual de Integração WS InvoiCy NFS-e
Essa tela possui filtros por nome, podendo ser inserido o nome do
usuário desejado. Feito isso clique em “Pesquisar” para que a tabela contida
na tela seja filtrada de acordo com a informação inserida.

Na tabela contida nessa tela estão os logins e os nomes dos usuários.

Para selecionar o usuário desejado deve-se clicar no ícone encontrado


ao lado do nome do mesmo, conforme figura abaixo:

Figura 7 - Selecionar usuários

Após selecionar o usuário desejado a tela poderá ser fechada. A tabela


contida na tela anterior agora irá conter o usuário recém adicionado, conforme
figura abaixo:

Figura 8 - Usuário adicionado

O usuário adicionado na empresa nessa tela poderão ser removidos,


clicando na opção de “X”.

Caso deseja cadastrar um novo usuário, isso também poderá ser feito

através dessa tela, clicando no botão , conforme figura


abaixo:

14
Manual de Integração WS InvoiCy NFS-e
Figura 9 - Cadastro de uma nova empresa - Novo usuário

Caso não for possível cadastrar um novo usuário nesta etapa, é possível
ao acessar a opção de Painel de controle – Empresa - Usuários. Para mais
informações consulte o Manual do Usuário do InvoiCy NFS-e.

Após clicar em “Avançar”.

Final

Figura 10 - Cadastro de uma nova empresa - Final

Esta tela permite apenas realizar a visualização de informações, como


código da empresa no InvoiCy NFS-e, CNPJ, descrição da empresa e chave
de acesso, informações que serão utilizadas na segurança dos web services,
conforme descrito no tópico de Segurança nos Web Services.
15
Manual de Integração WS InvoiCy NFS-e
Após clicar em “Concluir”.

A partir deste evento a empresa está cadastrada no InvoiCy NFS-e.

Nota: Após o cadastro da empresa ser finalizado é necessário verificar


qual é o layout de integração do município do prestador. Esta
informação pode ser verificada ao acessar o tópico Municípios
integrados. Caso o munícipio utilize o layout de integração ISS.NET,
orientamos a acessar o tópico de
Como enviar RPS para o layout do ISS.NET?

16
Manual de Integração WS InvoiCy NFS-e
2.3 Integração com o ERP

Uma das formas de integração entre o ERP e o InvoiCy NFS-e é


através da integração via WS utilizando o protocolo SOAP. Os dados do RPS
são gerados no ERP em formato XML, processados no InvoiCy NFS-e e
posteriormente enviados para a prefeitura de ocorrência da prestação do
serviço.

2.3.1 Segurança nos Web Services

O InvoiCy NFS-e trabalha com um sistema de segurança em cada


web service, trata-se de uma chave de segurança de 128 bits.

Cada nova empresa cadastrada no sistema recebe uma chave de


acesso que, no momento de envio de algum XML será concatenada com o
conteúdo do XML e criptografada em MD5, gerando a CK que será enviada
dentro da tag “<EmpCK>”.

Cada cliente do InvoiCy NFS-e recebe uma PK que deve ser enviada
em todos os XML dentro da tag “<EmpPK>” , essa chave é a mesma usada
para solicitar licenças e fará parte do processo de segurança do InvoiCy
NFS-e.

Exemplo do cabeçalho de um XML contendo a chave de parceiro e a


chave de comunicação:

Figura 11 - Cabeçalho com PK e CK

17
Manual de Integração WS InvoiCy NFS-e
Obs: Para gerar a CK concatena-se a chave de acesso com o XML,
porém não é usado o cabeçalho do XML, apenas o conteúdo após a tag
“</Cabecalho>”.

De uma forma simplificada, a empresa precisa seguir os passos abaixo


para criar um XML válido:

1. Gerar o XML a ser comunicado;

IMPORTANTE: O XML deve ser linearizado;

2. Concatenar a chave de acesso com a tag abaixo da tag


cabeçalho (abaixo, em cada serviço, está definida qual a tag correta).
String = ChavedeAcesso + XML;

3. Calcular o HASH MD5 dessa string;

4. Montar o restante do XML, com o XML gerado no passo 1 sendo


inserido após o cabeçalho, a CK gerada na tag “EMPCK” e as outras
tags do cabeçalho sendo informadas também;

5. Todo esse XML deve ser convertido para texto (convertendo


sinais <> para &lt; &gt;);

6. Substituir os caracteres especiais/símbolos pela Entity number


correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;

7. Comunicar esse XML dentro da tag “EntradaXML”.

2.3.2 Estrutura do Web Service

Nesta seção estão descritos a estrutura dos WS de envio, consulta,


cancelamento e os campos necessários para a construção dos arquivos XML
para realizar estas integrações.

18
Manual de Integração WS InvoiCy NFS-e
2.3.3 Tabela de siglas e definições

A tabela abaixo deve ser utilizada como legenda, para a realização da


interpretação dos campos do XML.

Referência Descrição

Ele Grupo do Elemento


G – Grupo
E – Elemento
Ocorrência 0-1 - Opcional, com uma possibilidade
0-N - Opcional, com N possibilidades
1-1 - Obrigatório, com uma possibilidade
1-N - Obrigatório, com N possibilidades
Pai tag raiz do XML da integração entre o ERP e InvoiCy NFS-e
Seq Sequencial
Tipo Tipo do campo
N – Numérico
D – Data time
C – Caracter
V - Varchar
XML Nome do campo no XML

Para facilitar a busca de informações relacionadas aos web services


existentes na integração, abaixo disponibilizado um índice na sequencia que
estes estão apresentados no manual de integração:

- Cadastro do prestador;

- Envio de RPS;

- Consulta do RPS;

- Cancelamento do RPS;

- Espelho do RPS;

- Download do arquivo XML.

19
Manual de Integração WS InvoiCy NFS-e
2.3.4 Cadastro do prestador

Para a realização do cadastro do prestador no InvoiCy NFS-e, o ERP


deverá realizar o envio do XML para o endereço web abaixo:

Web service de cadastro do prestador:

https://gnfse.gnfe.com.br/apnuc208.aspx?wsdl

É necessário enviar os parâmetros de acordo com os itens


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML de envio do cadastro do prestador. Vale destacar também
que o XML que será enviado não deve conter erros de estrutura. Para validá-lo
com o serviço correspondente, orientamos a consultar o tópico Validação de
arquivos XML. Abaixo listado o processo para gerar o XML para o cadastro do
prestador:

1. Linearizar o XML gerado;


2. Transformar o XML em string (convertendo sinais <> para &lt;
&gt;)
3. Substituir os caracteres especiais/símbolos pela Entity number
correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;
4. Comunicar string dentro da tag “EntradaXML”, conforme figura
abaixo:

Figura 12-- Estrutura do XML do cadastro do prestador

Abaixo é mostrada uma parte da estrutura do XML que deve ser


inserida dentro da tag “EntradaXML”:
20
Manual de Integração WS InvoiCy NFS-e
Figura 13 - Estrutura do XML de envio para o cadastro do prestador

2.3.4.1 Campos do XML de envio do cadastro do prestador

A documentação abaixo descreve os campos do arquivo XML de envio


do cadastro do prestador:

21
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 A01 SDTCadastroEmpresaEnvio G - 1-1 - 2.2.1.0
02 A02 ListaEmpresas G - 1-1 A01 2.2.1.0
03 A03 Empresa G 1-N A02 2.2.1.0
04 A04 EmpCNPJ CNPJ do prestador CE Var(14) 1-1 A03 2.2.1.0

05 A05 EmpCPF CPF do prestador CE Var(11) 1-1 A03 2.2.1.0

06 A06 EmpCodigo Código da empresa E N(5.0) 1-1 A03 Enviar o campo em 2.2.1.0
no cadastro do branco para um novo
InvoiCy NFS-e (É cadastro e enviar o
informado ao código da empresa
cadastrar a para atualizar as
empresa no informações
InvoiCy NFS-e)
07 A07 EmpNome Nome fantasia E Var(210) 1-1 A03 2.2.1.0

08 A08 EmpRazaoSocial Razão social do E Var(255) 1-1 A03 2.2.1.0


prestador
09 A09 EmpIM Inscrição municipal E Var(20) 1-1 A03 2.2.1.0
do prestador
10 A10 EmpIE Inscrição estadual E Var(15) 1-1 A03 2.2.1.0
do prestador

22
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
11 A11 EmpTpEnd Tipo de logradouro E Var(255) 1-1 A03 Tipo do logradouro 2.2.1.0
do prestador do tomador (Rua,
Avenida, Travessa,
etc.)
12 A12 EmpLgr Logradouro E Var(255) 1-1 A03 2.2.1.0
13 A13 EmpNumero Número do E Var(10) 1-1 A03 2.2.1.0
endereço
14 A14 EmpBairro Bairro do prestador E Var(50) 1-1 A03 2.2.1.0

15 A15 EmpCompl Complemento do E Var(100) 0-1 A03 2.2.1.0


endereço do
prestador
16 A16 EmpcMun Código do E N(7.0) 1-1 A03 Código de 2.2.1.0
município do identificação do
prestador município de
prestação do serviço,
conforme tabela do
IBGE
17 A17 EmpUF Estado do E N(2) 1-1 A03 Código do Estado 2.19.0.0
prestador conforme tabela do
IBGE.
18 A18 EmpPais País do prestador E N(4) 1-1 A03 2.2.1.0
19 A19 EmpCEP CEP do prestador E Var(8) 1-1 A03 2.2.1.0
20 A20 EmpSite Site do prestador E Var(255) 0-1 A03 2.2.1.0
21 A21 EmpFone Fone do prestador E Var(11) 0-1 A03 2.2.1.0
22 A22 EmpEmail E-mail do prestador E Var(255) 0-1 A03 2.2.1.0
23 A23 EmpObs Observação E Var(4000 0-1 A03 2.2.1.0
)
24 A24 EmpAdesSN Data de adesão ao E Datatime 0-1 A03 Formato: AAAA-MM- 2.2.1.0
simples nacional DD

23
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
25 A25 EmpCertificado Certificado E V(2M) 1-1 A03 O arquivo .pfx deve 2.2.1.0
ser enviado
convertido para
base64. Para mais
informações consulte
o tópico Exemplo de
decodificação de
base64 para arquivo

26 A26 EmpSenhaCert Senha do E Var(100) 1-1 A03 2.2.1.0


certificado

27 A27 EmpAmbiente Tipo de ambiente E N(1.0) 1-1 A03 2– Homologação 2.2.1.0


3 - Produção
28 A28 ChaveParceiro Chave do parceiro E Var(60) 1-1 A03 2.2.1.0

29 A29 UsrLogin Login do usuário a E Var(20) 0-1 A03 2.2.1.0


ser criado para a
empresa

30 A30 UsrSenha Senha do usuário E Var(32) 0-1 A03 2.2.1.0

31 A31 UsrNome Nome do usuário E Var(120) 0-1 A03 2.2.1.0

32 A32 UsrEmail E-mail do usuário E Var(80) 0-1 A03 2.2.1.0

33 A33 EmpUsuarioAutent Usuário para E Var(100) 0-1 A03 Não obrigatório 2.18.0.0
autenticação no com Ressalvas:

24
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
sistema da Alguns padrões
prefeitura exigem a informação
para realizar a
emissão.
34 A34 EmpSenhaAutent Senha para E Var(100) 0-1 A03 Não obrigatório 2.18.0.0
autenticação no com Ressalvas:
sistema da Alguns padrões
prefeitura. exigem a informação
para realizar a
emissão.
35 A35 EmpTipProcessamento Tipo de E V(1) 1-1 A03 S – Síncrono 2.18.0.0
Processamento da A – Assíncrono
Empresa. Síncrono: Caso não seja
para envio de informado, assumirá
pequenos lotes por por padrão Síncrono.
requisição e
resposta em tempo
real (depende do
tempo de
processamento da
prefeitura. Muitas
prefeituras não
processam a nota
em tempo real) e
Assíncrono: para
envio de grandes
lotes por
requisição, e
resposta em uma
segunda requisição.

25
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
36 A36 EmpApelido Apelido da E Var(255) 0-1 A03 Denominação 2.18.0.0
Empresa. Irá informal, pois o
caracterizar a nome fantasia e
empresa no razão social são
sistema, podendo enviadas à
utilizar qualquer prefeitura. Caso não
denominação. seja enviado, será
preenchido com o
nome fantasia.
37 A37 ParceiroUsrLogin Login do usuário do E Var(20) 0-1 A01 2.2.1.0
parceiro, utilizado
para vincular a
nova empresa ao
usuário do parceiro,
permitindo
gerenciar a
empresa

26
Manual de Integração WS InvoiCy NFS-e
2.3.4.2 Campos do XML do retorno do cadastro do prestador

A documentação abaixo descreve os campos do arquivo XML de


retorno do cadastro do prestador:

27
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 B01 SDTCadastroEmpresaRetorno G - 1-1 - 2.2.1.0
02 B02 GNFSeVer E C(14) 1-1 B01 2.2.1.0
03 B03 Mensagem G - 1-1 B01 2.2.1.0
04 B04 MsgCod E N(3.0) 0-1 B03 2.2.1.0
05 B05 MsgDescricao E C(4000) 0-1 B03 2.2.1.0
06 B06 ListaEmpresas G - 0-1 B01 2.2.1.0
07 B07 Empresa G - 0-N B06 2.2.1.0
08 B08 EmpCNPJ CNPJ da empresa CE Var(14) 1-1 B07 2.2.1.0
cadastrada
09 B09 EmpCPF CPF do prestador CE Var(11) 1-1 B07 2.2.1.0
cadastrado
10 B10 EmpCodigo Código da empresa E N(5.0) 1-1 B07 2.2.1.0
cadastrada
11 B11 EmpStatCad Status do E N(1.0) 1-1 B07 0 – Erro no cadastro 2.2.1.0
cadastramento da da empresa
empresa 1 – Cadastro
Realizado com
Sucesso
12 B12 EmpStatCert Status da instalação E N(1.0) 1-1 B07 0 – Erro na 2.2.1.0
do certificado instalação do
certificado
1 – Certificado
instalado com
sucesso
2 – Certificado não
instalado devido ao
nâo envio ou falta de
Arquivo/Senha.
13 B13 EmpStatLic Status do E N(1.0) 1-1 B07 0 – Erro no 2.2.1.0
licenciamento da licenciamento da

28
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
empresa Empresa
1 – Licenciamento
Realizado com
Sucesso
14 B14 EmpStatUsuario Status da criação do E N(1.0) 1-1 B07 0-Erro no 2.2.1.0
usuário cadastramento do
usuário
1-Usuário cadastrado
com sucesso
15 B15 EmpChvAcesso Chave de acesso - E V(200) 1-1 B07 2.2.1.0
Utilizada para
geração da EmpCK
16 B16 Erros G - 0-1 B01 2.2.1.0
17 B17 ErrosItem G - 1-N B16 2.2.1.0
18 B18 ErrDesc Descrição do Erro E V(4000) 1-1 B17 2.2.1.0
19 B19 ErrCod Código do Erro E C(4) 1-1 B17 2.2.1.0
20 B20 ErrOrigem Origem E N(1.0) 1-1 B17 1-Cadastro 2.2.1.0
2-Certificado
3-Licenciamento
4-CadUsuario

29
Manual de Integração WS InvoiCy NFS-e
2.3.5 Envio de RPS

Para a realização do envio do RPS para a prefeitura, o ERP deverá


realizar o envio do XML para o endereço web abaixo:

Web service de integração

https://gnfse.gnfe.com.br/apnuc134.aspx?wsdl

É necessário enviar os parâmetros de acordo com os itens


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML de envio. Vale destacar também que o XML que será enviado
não deve conter erros de estrutura. Para validá-lo com o serviço
correspondente, orientamos a consultar o tópico Validação de arquivos
XML.Abaixo listado o processo para gerar o XML de integração – envio:

5. Linearizar o XML gerado;


6. Gerar a CK (utilizando a tag <Lista>), conforme tópico
Segurança nos Web Service;
7. Transformar o XML em string (convertendo sinais <> para &lt;
&gt;)
8. Substituir os caracteres especiais/símbolos pela Entity number
correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;
9. Comunicar string dentro da tag “EntradaXML”, conforme figura
abaixo:

Figura 14 - Estrutura do XML do envio de RPS

30
Manual de Integração WS InvoiCy NFS-e
Abaixo é mostrada uma parte da estrutura do XML que deve ser
inserida dentro da tag “EntradaXML”:

Figura 15 – Conteúdo da TAG “EntradaXML”

2.3.5.1 Campos do XML de envio

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa enviar o RPS à prefeitura.

31
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 C01 SDTRecepcaoRPSEnvioV2 G - 1-1 - 2.0.0.0
02 C02 Cabecalho G - 1-1 C01 2.0.0.0
03 C03 EmpPK Chave de Parceiro do E V(200) 1-1 C02 2.0.0.0
Prestador (Mesma chave
utilizada no licenciamento
da Empresa)

04 C04 EmpCK Chave de Comunicação: E V(200) 1-1 C02 2.0.0.0


Deve ser gerada utilizando
o requisito de segurança
descrito no manual,
conforme tópico Segurança
nos web service
05 C05 EmpCnpj CNPJ do Prestador E V(14) 1-1 C02 2.0.0.0
06 C06 EmpCodigo Código da empresa no E N(5.0) 1-1 C02 2.0.0.0
cadastro do InvoiCy NFS-
e (É informado ao cadastrar
a empresa no InvoiCy
NFS-e)
07 C07 Lista G - 1-1 C01 2.0.0.0
08 C08 RPS G - 1-1 C07 2.0.0.0
09 C09 Inf G - 1-N C08 2.0.0.0
10 C10 RPSNumero Número do RPS E N(15.0) 1-1 C09 2.0.0.0
11 C11 RPSSerie Série do RPS E C(5) 1-1 C09 2.0.0.0
12 C12 RPSTipo Tipo do RPS E N(1.0) 1-1 C09 1 – Recibo 2.0.0.0
Provisório de
Serviços
2 – RPS Nota Fiscal
Conjugada (Mista)
3 – Cupom

32
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
13 C13 dEmis Data de emissão E DateTime 1-1 C09 Formato: AAAA- 2.0.0.0
MM-DDTHH:MM:SS
14 C14 dCompetencia Data da competência E Date 0-1 C09 Formato: AAAA- 2.3.0.0
MM-DD
15 C15 natOp Código da Natureza de E N(2.0) 1-1 C09 Nas integrações 2.0.0.0
Operação / Exigibilidade de baseadas no Layout
ISS ABRASF 1.0 o
Campo é Natureza
da Operação. Já na
ABRASF 2.0, o
campo é chamado
de Exigibilidade
ISS.
Para os padrões
DFSNET e SIGCorp
- Londrina consultar
valores especifícos
no tópico
Informações
específicas de
padrões
16 C16 Operacao Operação de tributação E C(2) 1-1 C09 Exclusivo do padrão 2.11.0.0
DSFNET.
A–Sem dedução
B–Com
dedução/materiais
C-Imune/Isenta de
ISSQN
D-Devolução
J-Intermediação
17 C17 NumProcesso Número do processo E V(30) 0-1 C09 Número do 2.3.0.0
processo judicial ou

33
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
administrativo de
suspensão da
exigibilidade. É
obrigatório e
informado somente
quando declarada a
suspensão da
exigibilidade do
tributo
18 C18 RegEspTrib Código de identificação do E N(1.0) 0-1 C09 1-Microempresa 2.0.0.0
regime especial de Municipal
tributação 2-Estimativa
3-Sociedade de
Profissionais
4-Cooperativa
5-MEI – Simples
Nacional
6-ME EPP – Simples
Nacional
19 C19 OptSN Optante Simples Nacional E N(1.0) 1-1 C09 1-Sim 2.0.0.0
2-Não
7 - Simples Federal
(Alíquota 1,0%)
8 - Simples Federal
(Alíquota 0,5%)
9- Simples
Municipal
NFPAULISTA
As opções 7, 8 e 9
são exclusivos para
o uso no padrão NF
Paulista – município

34
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
de São Paulo/SP)
20 C20 IncCult Incentivador Cultural E N(1.0) 1-1 C09 1-Sim 2.0.0.0
2-Não
21 C21 Status Status do RPS E N(1.0) 1-1 C09 1-Normal 2.0.0.0
2-Cancelada
3-Extraviado (esta
opção é exclusiva
do padrão NF
Paulista – município
de São Paulo/SP)

22 C22 cVerificaRPS Código de Verificação de E C(30) 0-1 C09 Campo exclusivo do 2.16.0.0
RPS padrão E-Caucaia
23 C23 RPSSubs G - 0-1 C09 2.0.0.0
24 C24 SubsNumero Número do RPS a ser E N(15.0) 1-1 C23 Número do RPS 2.0.0.0
substituído que será
substituído. O RPS
informado neste
campo, deverá ter
sido convertido
para NFS-e na
prefeitura
Alguns padrões
podem exigir que
neste campo seja
informado o
número da NFS-e
25 C25 SubsSerie Série do RPS a ser E C(5) 1-1 C23 2.0.0.0
substituído

35
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
26 C26 SubsTipo Tipo do RPS a ser E N(1.0) 1-1 C23 2.0.0.0
substituído

27 C27 SubsNFSeNumero Número da NFS-e E N(15.0) 0-1 C23 Exclusivo do padrão 2.11.0.0
substituída DSFNet
28 C28 SubsDEmisNFSe Data de emissão de NFSe E DateTime 0-1 C23 Formato: AAAA- 2.11.0.0
Substituída MM-DD
Exclusivo do padrão
DSFNet
29 C29 ListaItens G - 0-1 C09 A orientação é 2.0.0.0
preencher
sempre essa tag,
bem como a tag
valores (mesmas
informações,
mas agrupadas
em 1 item). Nas
prefeituras que
aceitam N itens,
serão enviados
os N itens, caso
contrário, será
enviado somente
1 item agrupado.
30 C30 Item G - 1-N C29 2.0.0.0
31 C31 ItemSeq Número sequencial do item E N(4.0) 1-1 C30 2.0.0.0

32 C32 ItemCod Código do item E C(255) 1-1 C30 2.0.0.0

36
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
33 C33 ItemDesc Descrição do item E C(4000) 1-1 C30 2.0.0.0

34 C34 ItemQtde Quantidade do item E N(16.2) 1-1 C30 2.0.0.0

35 C35 ItemvUnit Valor unitário E N(16.2) 1-1 C30 2.0.0.0

36 C36 ItemuMed Código da unidade de E C(10) 0-1 C30 2.0.0.0


medida do item

37 C37 ItemvlDed Valor de dedução do item E N(16.2) 0-1 C30 2.0.0.0

38 C38 ItemTributavel Item tributável E C(2) 0-1 C30 Exclusivo do padrão 2.11.0.0
DSFNET
S – Item Tributável
N – Não tributável
Para o
preenchimento do
campo orienta-se a
consultar o tópico
DSFNET e
Atividades de itens
de serviços com
marcação Não
tributável –
DSFNET
39 C39 ItemcCnae Código CNAE do item E N(7) 0-1 C30 2.4.0.0

40 C40 ItemcServMunic Código de tributação do E N(4.0) 0-1 C30 2.4.0.0

37
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
município

41 C41 ItemnAlvara Numero do alvara do item E C(15) 0-1 C30 2.4.0.0

42 C42 ItemvISS Valor do ISS do item E N(16.2) 1-1 C30 2.4.0.0

43 C43 ItemvDesconto Valor do desconto do item E N(16.2) 0-1 C30 2.4.0.0

44 C44 ItemAliquota Valor da alíquota do item E N(6.4) 1-1 C30 2.4.0.0

45 C45 ItemVlrTotal Valor total do item E N(16.4) 0-1 C30 É o resultado da 2.11.0.0
multiplicação do
valor unitário pela
quantidade,
subtraído das
deduções do item.
No padrão IPM o
preenchimento
deste campo é
obrigatório
46 C46 ItemBaseCalculo Base de cálculo do item E N(16.2) 1-1 C30 2.17.0.0

47 C47 ItemvlrISSRetido Valor do ISS Retido do item E N(16.2) 0-1 C30 2.17.0.0

48 C48 ItemIssRetido ISS Retido do item E N(1.0) 1-1 C30 1 - Sim 2.17.0.0
2 - Não
49 C49 ItemRespRetencao Responsável pela retenção E N(1.0) 0-1 C30 Informado somente 2.17.0.0
se ItemIssRetido

38
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
do item igual a “1 – Sim”.
1 – Tomador;
2 – Intermediário
50 C50 ItemIteListServico Código do item da lista de E C(5) 1-1 C30 Enviar separado 2.17.0.0
serviço do item com “.”. Ex.: 8.01

51 C51 ItemExigibilidadeISS Código da Natureza de E N(2.0) 1-1 C30 2.17.0.0


Operação / Exigibilidade de
ISS do item

52 C52 ItemcMunIncidencia Município de incidência do E N(7.0) 0-1 C30 Código do 2.17.0.0


item município onde é a
incidência do
imposto (Tabela do
IBGE)
53 C53 ItemNumProcesso Número do processo do E V(30) 0-1 C30 Número do 2.17.0.0
item processo judicial ou
administrativo de
suspensão da
exigibilidade. É
obrigatório e
informado somente
quando declarada
a suspensão da
exigibilidade do
tributo
54 C54 ListaParcelas G - 0-1 C09 Atualmente, 2.10.0.0
somente o
padrão Betha
recebe estas
informações

39
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
55 C55 Parcela G - 0-N C00 2.10.0.0

56 C56 PrcSequencial Sequencial da parcela E N(8.0) 0-N C55 2.10.0.0

57 C57 PrcValor Valor da parcela E N(16.2) 0-N C55 2.10.0.0

58 C58 PrcDtaVencimento Data de vencimento E Date 0-N C55 2.10.0.0

59 C59 Servico G - 1-1 C09 2.0.0.0


60 C60 Valores G - 1-1 C59 2.0.0.0
61 C61 ValServicos Valor dos serviços E N(16.2) 1-1 C60 2.0.0.0

62 C62 ValDeducoes Valor das deduções E N(16.2) 0-1 C60 O valor da dedução 2.0.0.0
refere-se à compra
de materiais
envolvidos na
prestação do
serviço, e deve ser
descontada da base
de cálculo do
ISSQN.
63 C63 ValPIS Valor do PIS E N(16.2) 0-1 C60 2.0.0.0

64 C64 ValCOFINS Valor do COFINS E N(16.2) 0-1 C60 2.0.0.0

65 C65 ValINSS Valor do INSS E N(16.2) 0-1 C60 2.0.0.0

40
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
66 C66 ValIR Valor do IR E N(16.2) 0-1 C60 2.0.0.0

67 C67 ValCSLL Valor da CSLL E N(16.2) 0-1 C60 2.0.0.0

68 C68 ISSRetido ISS Retido E N(1.0) 1-1 C60 1 - Sim 2.0.0.0


2 - Não
69 C69 RespRetencao Responsável pela retenção E N(1) 0-1 C60 Informado somente 2.3.0.0
se IssRetido igual a
“1 – Sim”
1 – Tomador;
2 – Intermediário
70 C70 Tributavel Item tributável E C(2) 1-1 C60 Exclusivo do padrão 2.11.0.0
DSFNET
S – Item Tributável
N – Não tributável
Para o
preenchimento do
campo orienta-se a
consultar o tópico
DSFNET e
Atividades de itens
de serviços com
marcação Não
tributável –
DSFNET
71 C71 ValISS Valor do ISS E N(16.2) 1-1 C60 2.0.0.0

72 C72 ValISSRetido Valor do ISS Retido E N(16.2) 0-1 C60 2.0.0.0

41
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
73 C73 ValOutrasRetencoes Valor das outras retenções E N(16.2) 0-1 C60 2.0.0.0

74 C74 ValBaseCalculo Base de cálculo E N(16.2) 1-1 C60 2.0.0.0

75 C75 ValAliqISS Aliquota do ISS E N(6.4) 1-1 C60 Alíquota. Valor 2.0.0.0
percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1
76 C76 ValAliqPIS Aliquota do PIS E N(6.4) 0-1 C60 Alíquota. Valor 2.0.0.0
percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1

77 C77 ValAliqCOFINS Aliquota do COFINS E N(6.4) 0-1 C60 Alíquota. Valor 2.0.0.0
percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1

78 C78 ValAliqIR Aliquota do IR E N(6.4) 0-1 C60 Alíquota. Valor 2.0.0.0


percentual.
Formato: 0.0000

42
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1

79 C79 ValAliqCSLL Aliquota do CSLL E N(6.4) 0-1 C60 Alíquota. Valor 2.0.0.0
percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1

80 C80 ValAliqINSS Aliquota do INSS E N(6.4) 0-1 C60 Alíquota. Valor 2.0.0.0
percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou
1

81 C81 ValLiquido Valor líquido do serviço E N(16.2) 1-1 C60 O valor informado 2.0.0.0
neste campo
compreende o
seguinte cálculo:
Valor dos Serviços -
Valor de PIS - Valor
de COFINS - Valor
de INSS - Valor de
IR - Valor de CSLL -
Outras Retenções -

43
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
Valor IISS Retido -
Desconto
Incondicionado -
Desconto
Condicionado
82 C82 ValDescIncond Valor do desconto E N(16.2) 0-1 C60 2.0.0.0
incondicionado

83 C83 ValDescCond Valor do desconto E N(16.2) 1-1 C60 2.0.0.0


condicionado

84 C84 ValAliqISSoMunic Alíquota ISS em outro E N(6.4) 0-1 C60 Obrigatório para 2.7.0.0
Município o padrão de
Lençóis Paulista
85 C85 InfValPIS Informação sobre o valor E N(16.2) 0-1 C60 Em obediência a Lei 2.7.0.0
do PIS Federal
12.741/2012
Obrigatório para
o padrão de
Lençóis Paulista
86 C86 InfValCOFINS Informação sobre o valor E N(16.2) 0-1 C60 Em obediência a Lei 2.7.0.0
do COFINS Federal
12.741/2012
Obrigatório para
o padrão de
Lençóis Paulista
87 C87 cServ Código de serviço interno E C(50) 0-1 C59 Este campo será 2.0.0.0
descontinuado. Não
existe necessidade
de informá-lo.

44
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
88 C88 IteListServ Código do item da lista de E C(5) 1-1 C59 Enviar separado 2.0.0.0
serviço com “.”. Ex.: 8.01

89 C89 Cnae Codigo CNAE E N(7.0) 0-1 C59 2.0.0.0

90 C90 fPagamento Forma de pagamento E V(40) 0-1 C59 Para o padrão 2.10.0.0
Betha esse campo
é descritivo e pode
conter apenas as
descrições:
A_VISTA,
NA_APRESENTACA
O, A_PRAZO,
CARTAO_DEBITO,
CARTAO_CREDITO
91 C91 TributMunicipio Código de tributação do E C(20) 1-1 C59 Obrigatório com 2.0.0.0
município ressalvas.
Depende da
legislação do
município.

92 C92 Discriminacao Discriminação dos serviços E C(2000) 1-1 C59 Para quebra de 2.0.0.0
realizados linha, utilizar o
comando
!CHR13!

93 C93 cMun Código do município E N(7.0) 1-1 C59 Código de 2.0.0.0


identificação do
município de
prestação do

45
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
serviço, conforme
tabela do IBGE

94 C94 SerQuantidade Quantidade do serviço E N(16.2) 0-1 C59 2.4.0.0

95 C95 SerUnidade Unidade do serviço E C(10) 0-1 C59 2.4.0.0

96 C96 SerNumAlvara Número do alvará do E C(15) 0-1 C59 2.4.0.0


serviço
97 C97 PaiPreServico País de prestação do E C(2) 0-1 C59 Código do país 2.3.0.0
serviço onde o serviço foi
prestado (Sigla de
dois caracteres).
Preencher somente
se
MunicipioPrestacao
Servico igual
9999999. Para mais
informações
acessar Códigos
para a
representação dos
nomes dos países

46
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
98 C98 cMunIncidencia Município de incidência E N(7) 0-1 C59 Código do 2.3.0.0
município onde é a
incidência do
imposto (Tabela do
IBGE)

99 C99 ObrigoMunic Obrigação de recolhimento E N(2) 0-1 C59 0-Prestador 2.7.0.0


do imposto em outro 1-Tomador
Município Nota: Obrigatório
para o padrão de
Lençóis Paulista

100 C100 TributacaoISS Forma de Tributação do ISS E N(2) 0-1 C59 0-Normal 2.7.0.0
10-Tributado por
opção do prestador
11-Não tributado
por opção do
prestador
Nota: Obrigatório
para o padrão de
Lençóis Paulista
101 C101 Tomador G - 0-1 C09 Não obrigadtório 2.0.0.0
com Ressalvas:
Alguns
municípios não
permitem
emissão sem
tomador.
102 C102 TomaCNPJ CNPJ do tomador E C(14) 0-1 C101 2.0.0.0

47
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
103 C103 TomaCPF CPF do tomador E C(11) 0-1 C101 2.0.0.0

104 C104 TomaIM Inscrição Municipal do E C(15) 0-1 C101 2.0.0.0


tomador

105 C105 TomaRazaoSocial Razão social do tomador E C(115) 0-1 C101 2.0.0.0

106 C106 TomatpLgr Tipo de logradouro E C(10) 0-1 C101 Tipo do logradouro 2.0.0.0
do tomador (Rua,
Avenida, Travessa,
etc.)
107 C107 TomaEndereco Endereço do tomador E C(125) 0-1 C101 2.0.0.0

108 C108 TomaNumero Número do endereço E C(10) 0-1 C101 2.0.0.0

109 C109 TomaComplemento Complemento do endereço E C(60) 0-1 C101 2.0.0.0

110 C110 TomBairro Bairro do tomador E C(60) 0-1 C101 2.0.0.0

111 C111 TomacMun Código do município E N(7.0) 0-1 C101 2.0.0.0

112 C112 TomaxMun Descrição do município E C(255) 0-1 C101 2.0.0.0

113 C113 TomaUF UF do tomador E C(2) 0-1 C101 2.0.0.0

48
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
114 C114 TomaPais País do tomador E C(2) 0-1 C101 2.0.0.0

115 C115 TomaCEP CEP do tomador E N(8.0) 0-1 C101 2.0.0.0

116 C116 TomaTelefone Telefone do tomador E C(11) 0-1 C101 2.0.0.0

117 C91 TomaEmail E-mail do tomador E C(80) 0-1 C101 2.0.0.0

118 C118 TomaSite Site do tomador E C(255) 0-1 C101 2.0.0.0

119 C119 IntermServico G - 0-1 C09 2.0.0.0


120 C120 IntermRazaoSocial Razão social do E C(115) 1-1 C119 2.0.0.0
intermediário

121 C121 IntermCNPJ CNPJ do intermediário E C(14) 1-1 C119 2.0.0.0

122 C122 IntermCPF CPF do intermediário E C(11) 1-1 C119 2.0.0.0

123 C123 IntermIM Inscrição Municipal do E C(15) 0-1 C119 2.0.0.0


intermediário

124 C124 ConstCivil G - 0-1 C09 2.0.0.0


125 C125 CodObra Código da obra E C(15) 1-1 C124 Informar o código 2.0.0.0
da obra

49
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
126 C100 Art Código ART E C(15) 1-1 C124 Informar o número 2.0.0.0
ART

127 C127 ListaDed G - 0-1 C09 2.0.0.0


128 C128 Ded G - 1-N C127 Poucos 2.0.0.0
municípios
recebem as
deduções
discriminadas em
N itens. Deve-se
utilizar o campo
ValDeducoes da
tag Valores
129 C129 DedSeq Número sequencial da E N(18.0) 1-1 C128 2.0.0.0
dedução

130 C130 DedValPer Identificação de valor ou E C(3) 1-1 C128 Informar se a 2.0.0.0
percentual dedução é medida
em valor ou
percentual
1 – Valor
2 – Percentual
131 C131 DedTipo Tipo de dedução E C(3) 1-1 C128 Caso a dedução 2.0.0.0
seja por “Valor":
1 – Despesas
Materiais
2 – Despesas Sub-
empreitadas
Caso a dedução por
“Percentual”
informar o campo

50
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
com valor vazio
132 C132 DedCNPJRef CPF do fornecedor ou E C(14) 1-1 C128 2.0.0.0
prestador

133 C133 DedCPFRef CNPJ do fornecedor ou E C(11) 1-1 C128 2.0.0.0


prestador

134 C134 DednNFRef Número da nota fiscal de E N(10.0) 1-1 C128 2.0.0.0
referência

135 C135 DedvlTotRef Valor total de referência E N(16.2) 1-1 C128 Valor total da nota 2.0.0.0
fiscal de referência
136 C136 DedPer Percentual a deduzir E N(16.2) 1-1 C128 2.0.0.0

137 C137 DedValor Valor a ser deduzido E N(16.2) 1-1 C128 2.0.0.0

138 C138 NFSOutrasinformacoes Outras informações E C(255) 0-1 C09 Somente o layout 2.0.0.0
Betha aceita o
envio de outras
informações. Caso
seja enviado menos
de 58 caracteres, o
layout Betha
concatena o link do
espelho da NFS-e
neste campo

51
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
139 C139 ArquivoTXT Arquivo de retorno E V(2M) 0-1 C09 Enviar o arquivo 2.8.0.0
em base64. Para
mais informações
de envio consultar
o tópico de
Orientações aos
municípios que
integram com o
InvoiCy NFS-e
através de arquivo
140 C140 ExtensaoArquivo Extensão do arquivo de E C(5) 0-1 C09 TXT ou CSV 2.15.0.0
envio

52
Manual de Integração WS InvoiCy NFS-e
2.3.5.2 Retorno do envio de RPS

Após o envio, o InvoiCy NFS-e retorna mensagens específicas,


notificando que o RPS foi enviado para a prefeitura.

Segue abaixo uma figura referente a uma parte da estrutura do XML


de retorno gerado pelo WS de envio:

Figura 16 - XML de retorno após o envio

Com pose desta informação, o retorno disponibilizado pela prefeitura


poderá ser lido e as informações extraídas pelo ERP através dos dados
contidos na tag “Cdata”.

Para mais informações sobre as informações que podem ser


retornadas nos campos consulte o tópico Campos do XML de retorno do envio.

2.3.5.3 Campos do XML de retorno do envio

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa consultar o retorno após o
envio do RPS à prefeitura.

53
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 D01 SDTRecepcaoRPSRetornoV2 G - 1-1 - 2.0.0.0
02 D02 GNFSeVer E C(14) 1-1 D01 2.0.0.0
03 D03 Mensagem G - 1-1 D01 2.0.0.0
04 D04 MsgCod E N(3.0) 0-1 D03 2.0.0.0
05 D05 MsgDescricao E C(4000) 0-1 D03 2.0.0.0
06 D06 ListaRPS G - 0-1 D01 2.0.0.0
07 D07 RPS G - 0-N D06 2.0.0.0
08 D08 RPSNumero Número do RPS E N(15) 1-1 D07 2.0.0.0
09 D09 RPSSerie Série do RPS E C(5) 1-1 D07 2.0.0.0
10 D10 RPSSituacao Situação do RPS E N(1.0) 1-1 D07 0 – Pendente 2.0.0.0
1 - Cancelada
3 – Efetivada
6 – Rejeitada
11 D11 RPSProcessamento Status do E C(1) 1-1 D07 N - Não Processado 2.0.0.0
Processamento do A - Aguardando
RPS E – Em Processamento
P - Processado

12 D12 LoteNumero Número do lote E N(15.0) 0-1 D07 2.0.0.0


13 D13 LotProtocolo Protocolo do lote E C(50) 0-1 D07 2.0.0.0
14 D14 EspelhoRPS Espelho do RPS do E V(2M) 0-1 D07 Retorna o arquivo em 2.1.1.0
arquivo PDF base64. Para
informações de como
decodificar o conteúdo
da tag em arquivo PDF
acessar o tópico
Exemplo de
decodificação de base64
para arquivo

54
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
15 D15 Arquivo TXT Arquivo de envio E V(2M) 0-1 D07 Retorna o arquivo em 2.8.0.0
base64. Para mais
informações de envio
consultar o tópico de
Orientações aos
municípios que integram
com o InvoiCy NFS-e
através de arquivo
16 D16 ExtensaoArquivo Extensão do E C(5) 0-1 D07 TXT, XML, CSV. 2.15.0.0
arquivo de retorno
17 D17 NFSE G - 0-1 D07 2.0.0.0
18 D18 nNFSE Número da NFS-e E N(15) 1-1 D16 2.0.0.0
19 D19 cVerificaNFSe Código de E C(30) 1-1 D16 Alguns padrões 2.0.0.0
Verificação da NFS- requerem essa
e informação para
consultar a NFS-e pelo
portal
20 D20 Erros G - 1-1 D07 2.0.0.0
21 D21 ErrosItem G - 0-N D19 2.0.0.0
22 D22 ErrDesc Descrição do Erro E V(4000) 1-1 D20 2.0.0.0
23 D23 ErrCodigo Código do Erro E C(4) 1-1 D20 2.0.0.0

55
Manual de Integração WS InvoiCy NFS-e
2.3.6 Consulta de RPS

Para realizar a consulta do RPS na prefeitura, o ERP deverá realizar o


envio do XML da consulta para o endereço web abaixo:

Web service de integração

https://gnfse.gnfe.com.br/apnuc137.aspx?wsdl

É necessário enviar os parâmetros de acordo com os campos


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML de consulta do RPS. Vale destacar também que o XML que
será enviado não deve conter erros de estrutura. Para validá-lo com o serviço
correspondente, orientamos a consultar o tópico Validação de arquivos XML.
Abaixo listado o processo para gerar o XML consulta:

1. Geração do XML de integração - consulta;


2. Linearizar o XML gerado;
3. Gerar a CK (utilizando a tag <ListaRPS>), conforme tópico
Segurança nos Web Service;
4. Transformar o XML em string (convertendo sinais <> para &lt;
&gt;);
5. Substituir os caracteres especiais/símbolos pela Entity number
correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;
6. Comunicar string dentro da tag “EntradaXML”, conforme figura
abaixo:

Figura 17 - Estrutura do XML da consulta de RPS

56
Manual de Integração WS InvoiCy NFS-e
2.3.6.1.1 Campos do XML de consulta do RPS

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa consultar status do RPS na
prefeitura.

57
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 E01 SDTConsultaRPSEnvioV2 G - 1-1 - 2.0.0.0
02 E02 Cabecalho G - 1-1 E01 2.0.0.0
03 E03 EmpPK Chave de E V(200) 1-1 E02 2.0.0.0
Parceiro do
Prestador
(Mesma chave
utilizada no
licenciamento da
Empresa)
04 E04 EmpCK Chave de E V(200) 1-1 E02 2.0.0.0
Comunicação:
deve ser gerada
utilizando o
requisito de
segurança
descrito no
manual
05 E05 EmpCnpj CNPJ do E V(14) 1-1 E02 2.0.0.0
Prestador
06 E06 EmpCodigo Código da E N(5.0) 1-1 E02 2.0.0.0
empresa no
cadastro do
InvoiCy NFS-e
(É informado ao
cadastrar a
empresa no
InvoiCy NFS-
e)
07 E07 ListaRPS G - 1-1 E01 2.0.0.0
08 E08 RPS G - 1-N E07 2.0.0.0
09 E09 RPSItem G - 1-1 E08 2.0.0.0
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
10 E10 RPSNumero Número do RPS E N(15.0) 1-1 E09 2.0.0.0
11 E11 RPSSerie Série do RPS E C(5) 1-1 E09 2.0.0.0

59
Manual de Integração WS InvoiCy NFS-e
2.3.6.1.2 Retorno da consulta de RPS

Após a realização da consulta, o InvoiCy NFS-e retorna mensagens


específicas, sobre o status do RPS na prefeitura.

Segue abaixo figura referente a estrutura do XML do retorno pelo web


service de consulta:

Figura 18 - XML de retorno após a consulta do RPS

Com pose desta informação, o retorno da consulta retornado pela


prefeitura poderá ser lido e extraído pelo ERP através dos dados contidos na
tag “Cdata”.

2.3.6.1.3 Campos do XML de retorno da consulta

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa consultar o retorno após a
consulta do RPS à prefeitura.
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 F01 SDTConsultaRPSRetornoV2 G - 1-1 - 2.0.0.0
02 F02 GNFSeVer E C(14) 1-1 F01 2.0.0.0
03 F03 Mensagem G - 1-1 F01 2.0.0.0
04 F04 MsgCod Código da E N(3.0) 0-1 F03 2.0.0.0
mensagem
05 F05 MsgDescricao Descrição da E C(4000) 0-1 F03 2.0.0.0
mensagem
06 F06 ListaRPS G - 0-1 F01 2.0.0.0
07 F07 RPS G - 0-1 F06 2.0.0.0
08 F08 Inf G - 1-N F07 2.0.0.0
09 F09 RPSNumero Número do RPS E N(15) 1-1 F08 2.0.0.0
10 F10 RPSSerie Série do RPS E C(5) 1-1 F08 2.0.0.0
11 F11 RPSSituacao Situação do RPS E N(1.0) 1-1 F08 0 – Pendente 2.0.0.0
3 – Efetivada
6 – Rejeitada
1 - Cancelada
12 F12 RPSProcessamento Processamento E C(1) 1-1 F08 A – Aguardando 2.0.0.0
do RPS N - Não Processado
E - Em Processamento
P – Processado

13 F13 CodigoRetorno Código do E N(3.0) 0-1 F08 2.0.0.0


retorno
14 F14 MsgRetorno Mensagem de E C(4000) 0-1 F08 2.0.0.0
retorno
15 F15 LotNumero Número do lote E N(15.0) 0-1 F08 2.0.0.0
16 F16 EspelhoRPS Espelho do RPS E V(2M) 0-1 F08 Retorna o arquivo em 2.1.1.0
em arquivo PDF base64. Para
informações de como

61
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
decodificar o conteúdo
da tag em arquivo
PDF acessar o tópico
Exemplo de
decodificação de base
64 para arquivo
17 F17 NFSE G - 0-1 F08 2.0.0.0
18 F18 nNFSE Número da NFS- E N(15) 1-1 F17 2.0.0.0
e
19 F19 cVerificaNFSe Código de E C(30) 1-1 F17 2.0.0.0
Verificação da
NFS-e
20 F20 Erros G - 0-1 F08 2.0.0.0
21 F21 ErrosItem G - 1-1 F20 2.0.0.0
22 F22 Inf G - 0-N F21 2.0.0.0
23 F23 ErrCodigo Código do erro E N(3) 1-1 F22 2.0.0.0
24 F24 ErrDesc Descrição do E V(4000) 1-1 F22 2.0.0.0
erro

62
Manual de Integração WS InvoiCy NFS-e
2.3.7 Cancelamento de NFS-e

Para realizar o cancelamento da NFS-e na prefeitura, o ERP deverá


realizar o envio do XML para o endereço web abaixo:

Web service de integração

https://gnfse.gnfe.com.br/apnuc138.aspx?wsdl

É necessário enviar os parâmetros de acordo com os campos


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML de consulta do RPS. Vale destacar também que o XML que
será enviado não deve conter erros de estrutura. Para validá-lo com o serviço
correspondente, orientamos a consultar o tópico Validação de arquivos
XML.Abaixo listado o processo para gerar o XML consulta:

1. Linearizar o XML gerado;


2. Gerar a CK (utilizando a tag <ListaRPS>), conforme tópico
Segurança nos Web Service;
3. Transformar o XML em string (convertendo sinais <> para &lt;
&gt;)
4. Substituir os caracteres especiais/símbolos pela Entity number
correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;
5. Comunicar String dentro da tag “EntradaXML”, conforme figura
abaixo:

Figura 19 - Estrutura do XML do cancelamento da NFS-e

63
Manual de Integração WS InvoiCy NFS-e
2.3.7.1.1 Campos do XML para cancelamento da NFS-e

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa cancelar a NFS-e na
prefeitura.

64
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 G01 CancelaNFSeEnvioV2 G - 1-1 - 2.0.0.0
02 G02 Cabecalho G - 1-1 G01 2.0.0.0
03 G03 EmpPK Chave de Parceiro do E V(200) 1-1 G02 2.0.0.0
Prestador (Mesma chave
utilizada no licenciamento
da Empresa)
04 G04 EmpCK Chave de Comunicação: E V(200) 1-1 G02 2.0.0.0
Deve ser gerada
utilizando o requisito de
segurança descrito no
manual
05 G05 EmpCnpj CNPJ do Prestador E V(14) 1-1 G02 2.0.0.0
06 G06 EmpCodigo Código da empresa no E N(5.0) 1-1 G02 2.0.0.0
cadastro do InvoiCy
NFS-e (É informado ao
cadastrar a empresa no
InvoiCy NFS-e)
07 G07 ListaRPS G - 1-1 G01 2.0.0.0
08 G08 RPS G - 1-N G07 2.0.0.0
09 G09 nRps Número do RPS E N(15.0) 1-1 G08 2.0.0.0
10 G10 nSerieRps Série do RPS E C(5) 1-1 G08 2.0.0.0
11 G11 nNFSe Número da NFS-e E N(18.0) 1-1 G08 2.0.0.0

65
Manual de Integração WS InvoiCy NFS-e
2.3.7.1.2 Retorno do cancelamento da NFS-e

Após o envio da solicitação para o cancelamento da NFS-e, o InvoiCy


NFS-e retorna mensagens específicas, sobre o cancelamento da NFS-e na
prefeitura.

Figura 20 - XML do retorno do cancelamento

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa consultar o retorno após o
cancelamento da NFS-e à prefeitura.

66
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 H01 CancelaNFSeRetorno G - 1-1 - 2.0.0.0
02 H02 GNFSeVer E C(14) 1-1 H01 2.0.0.0
03 H03 Mensagem G - 1-1 H01 2.0.0.0
04 H04 MsgCod Código da E N(3.0) 0-1 H03 2.0.0.0
mensagem
05 H05 MsgRetorno Mensagem de E C(4000) 0-1 H03 2.0.0.0
retorno
06 H06 ListaRPS G - 0-1 H01 2.0.0.0
07 H07 RPS G - 0-N H06 2.0.0.0
08 H08 NumeroRPS Número do E N(15) 1-1 H07 2.0.0.0
RPS
09 H09 SerieRPS Série do RPS E C(5) 1-1 H07 2.0.0.0
10 H10 SituacaoRPS Situação do E N(1.0) 1-1 H07 0 – Pendente 2.0.0.0
RPS 1 - Cancelada
3 – Efetivada
6 – Rejeitada
11 H11 ProcessamentoRPS Processamento E C(1) 1-1 H07 N - Não Processado 2.0.0.0
do RPS A - Aguardando
E – Em Processamento
P - Processado

12 H12 Erros G - 0-1 H07 2.0.0.0


13 H13 ErrosItem G - 0-N H12 2.0.0.0
14 H14 CodigoErro Código do erro E N(3) 1-1 H13 2.0.0.0
15 H15 MensagemErro Mensagem de E V(4000) 1-1 H13 2.0.0.0
erro
16 H16 Correcao E V(4000) 1-1 H13 2.0.0.0

67
Manual de Integração WS InvoiCy NFS-e
2.3.8 Espelho do RPS

Para obter o espelho do RPS, o ERP poderá realizar o envio do XML


para o endereço web abaixo:

Web service de integração

https://gnfse.gnfe.com.br/aws_espelhorps.aspx?wsdl

É necessário enviar os parâmetros de acordo com os campos


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML do envio do espelho do RPS. Vale destacar também que o
XML que será enviado não deve conter erros de estrutura. Para validá-lo com
o serviço correspondente, orientamos a consultar o tópico Validação de
arquivos XML. Abaixo listado o processo para gerar o XML consulta:

1. Linearizar o XML gerado;

2. Gerar a CK (utilizando a tag <ListaRPS>), conforme tópico


Segurança nos Web Service;

3. Transformar o XML em string (convertendo sinais <> para &lt;


&gt;)

4. Substituir os caracteres especiais/símbolos pela Entity number


correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;

5. Comunicar String dentro da tag “EntradaXML”, conforme figura


abaixo:

68
Manual de Integração WS InvoiCy NFS-e
Figura 21 - Espelho do RPS

Através deste WS, é possível realizar a consulta de vários RPSs


simultaneamente, caso em que o arquivo PDF retornado em base 64 conterá
um espelho em cada página, na ordem passada no XML de envio.

2.3.8.1.1 Campos do XML do envio do espelho do RPS

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa gerar o espelho do RPS.

69
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 I01 ReqEspelhoRPSEnvio G - 1-1 - 2.1.1.0
02 I02 Cabecalho G - 1-1 I01 2.1.1.0
03 I03 EmpPK Chave de Parceiro do E V(200) 1-1 I02 2.1.1.0
Prestador (Mesma chave
utilizada no
licenciamento da
Empresa)
04 I04 EmpCK Chave de Comunicação: E V(200) 1-1 I02 2.1.1.0
Deve ser gerada
utilizando o requisito de
segurança descrito no
manual
05 I05 EmpCnpj CNPJ do Prestador E V(14) 1-1 I02 2.1.1.0
06 I06 EmpCodigo Código da empresa no E N(5.0) 1-1 I02 2.1.1.0
cadastro do InvoiCy
NFS-e (É informado ao
cadastrar a empresa no
InvoiCy NFS-e)
07 I07 ListaRPS G - 1-1 I01 2.1.1.0
08 I08 RPS G - 1-N I07 2.1.1.0
09 I09 RPSSerie Série do RPS E C(5) 1-1 I08 2.1.1.0
10 I10 RPSNumero Número do RPS E N(15) 1-1 I08 2.1.1.0

70
Manual de Integração WS InvoiCy NFS-e
2.3.8.1.2 Campos do XML do retorno do espelho do RPS

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa consultar o espelho do
RPS.

71
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 J01 ReqEspelhoRPSRetorno G - 1-1 - 2.1.1.0
02 J02 GNFSeVer E C(14) 1-1 J01 2.1.1.0

03 J03 Mensagem G - 1-1 J01 2.1.1.0


04 J04 MsgCod Código da mensagem E N(3.0) 0-1 J03 2.1.1.0
05 J05 MsgDescricao Mensagem de retorno E V(4000) 0-1 J03 2.1.1.0
06 J06 RPS G - 1-1 J01 2.1.1.0
07 J07 EspelhoRPS Espelho do RPS em E V(2M) 1-1 J06 Retorna o arquivo em 2.1.1.0
arquivo PDF base64. Para
informações de como
decodificar o conteúdo
da tag em arquivo
PDF acessar o tópico
Exemplo de
decodificação de base
64 para arquivo
08 J08 Erros G - 0-1 J06 2.1.1.0
09 J09 ErrosItem G - 0-N J08 2.1.1.0
10 J10 CodigoErro Código do erro E N(3) 1-1 J09 2.1.1.0
11 J11 MensagemErro Mensagem de erro E V(4000) 1-1 J09 2.1.1.0
12 J12 Correcao E V(4000) 1-1 J09 2.1.1.0

72
Manual de Integração WS InvoiCy NFS-e
2.3.9 Download do XML da NFS-e

Para realizar o download da NFS-e, que é retornado pela prefeitura, o


ERP poderá realizar o envio do XML para o web service abaixo:

Web service de integração

https://gnfse.gnfe.com.br/apnuc209.aspx?wsdl

É necessário enviar os parâmetros de acordo com os campos


obrigatórios. Para maiores informações sobre estes campos consultar o tópico
Campos do XML para o download da NFS-e. Vale destacar também que o XML
que será enviado não deve conter erros de estrutura. Para validá-lo com o
serviço correspondente, orientamos a consultar o tópico Validação de arquivos
XML. Abaixo listado o processo para gerar o XML consulta:

2. Linearizar o XML gerado;

2. Gerar a CK (utilizando a tag <FaixaConsulta>), conforme tópico


Segurança nos Web Service;

3. Transformar o XML em string (convertendo sinais <> para &lt;


&gt;)

4. Substituir os caracteres especiais/símbolos pela Entity number


correspondente, por exemplo: "ç = &#231;", "Ç = &#199;". Para mais
informações consultar o tópico Anexos;

5. Comunicar String dentro da tag “EntradaXML”, conforme figura


abaixo:

Figura 22 - Estrutura do XML do download do XML

73
Manual de Integração WS InvoiCy NFS-e
Abaixo é mostrada uma parte da estrutura do XML que deve ser
inserida dentro da tag “EntradaXML”:

Figura 23 - Estrutura do XML de envio para o download do XML

2.3.9.1.1 Campos do XML para o download da NFS-e

A documentação abaixo descreve os campos do arquivo XML a ser


gerado pelo ERP para que o InvoiCy NFS-e possa realizar o download da
NFS-e.

74
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 K01 SDTConsultaFaixaRPS G - 1-1 - 2.2.1.0
02 K02 Cabecalho G - 1-1 K01 2.2.1.0
03 K03 EmpPK Chave de Parceiro do Prestador E V(200) 1-1 K02 2.2.1.0
(Mesma chave utilizada no
licenciamento da Empresa)

04 K04 EmpCK Chave de Comunicação: Deve E V(200) 1-1 K02 2.2.1.0


ser gerada utilizando o requisito
de segurança descrito no
manual, conforme tópico
Segurança nos web service
05 K05 EmpCnpj CNPJ do Prestador E V(14) 1-1 K02 2.2.1.0
06 K06 EmpCodigo Código da empresa no cadastro E N(5.0) 1-1 K02 2.2.1.0
do InvoiCy NFS-e (É
informado ao cadastrar a
empresa no InvoiCy NFS-e)

07 K07 FaixaConsulta G - 1-1 K01 2.2.1.0


08 K08 RpsSerie Série do RPS E C(5) 1-1 K07 2.2.1.0
09 K09 RpsNumeroInicio Número inicial da faixa de RPS E N(15.0) 1-1 K07 2.2.1.0
10 K10 RpsNumeroFim Número final da faixa de RPS E N(15.0) 1-1 K07 2.2.1.0

75
Manual de Integração WS InvoiCy NFS-e
2.3.9.1.2 Campos do XML para o retorno do download da NFS-e

A documentação abaixo descreve os campos do arquivo XML retornado


pelo InvoiCy NFS-e no momento do solicitação do arquivo para download.

76
Manual de Integração WS InvoiCy NFS-e
Nº Seq XML Descrição Ele Tipo Ocorrência Pai Observação Versão
01 L01 SDTConsultaFaixaRPSRetorno - - 1-1 - 2.2.1.0
02 L02 ListaRps G - 1-1 L01 2.2.1.0
03 L03 RPS G - 1-N L02 2.2.1.0
04 L04 RpsNumero Número inicial da faixa de RPS E N(15.0) 1-1 L03 2.2.1.0
05 L05 RpsSerie Série do RPS E C(5) 1-1 L03 2.2.1.0
06 L06 NfseXml XML da NFS-e E Var(10000 1-1 L03 Retorna o arquivo 2.2.1.0
00) em base64. Para
informações de como
decodificar o
conteúdo da tag em
arquivo PDF acessar
o tópico Exemplo de
decodificação de
base64 para arquivo
07 L07 Mensagem G - 1-1 L01 2.2.1.0
08 L08 MsgCod E N(5.0) 1-1 L07 2.2.1.0
09 L09 MsgDescricao E LongVarN 1-1 L07 2.2.1.0
(2M)
10 L10 GNFSeVer E Var(20) 1-1 L01 2.2.1.0

77
Manual de Integração WS InvoiCy NFS-e
2.3.10 Orientaçãoes aos municípios que integram com o
InvoiCy NFS-e através de arquivo

O InvoiCy NFS-e permite realizar o envio de NFS-e através de


arquivos. Quando a integração com a prefeitura é desta forma, o processo de
envio de RPS a prefeitura é igual a integração via WS, ou seja os dados do
RPS são enviados através do WS de recepção, após inseridos e validados na
base de dados do InvoiCy NFS-e.

Neste primeiro envio, a tag <Arquivo TXT> deve ser enviada vazia
para o InvoiCy NFS-e. Para mais informações sobre o WS de recepção e os
campos a serem enviados consultar os tópicos de Envio de RPS e Campos do
XML de envio.

A partir disso, o InvoiCy NFS-e gera o arquivo de acordo com o


layout da prefeitura e é retornado para o ERP no layout de retorno através da
tag <Arquivo TXT> convertido em base64. O ERP deve converter para a
extensão informada na tag <Extensao> e disponibilizar para que o usuário
possa realizar o upload deste arquivo no sistema da prefeitura. Caso a tag
<Extensao> esteja em branco, o arquivo padrão é TXT. Para mais
informações sobre o layout de retorno de envio, consultar o tópico de Campos
do XML de retorno do envio.

A partir disso, a prefeitura realiza o processamento do arquivo do RPS


recebido e gera um segundo arquivo de retorno, contendo as informações de
efetivação ou rejeição do RPS. Este arquivo é gerado normalmente em uma
sessão de exportação de NFS-e no sistema da prefeitura e deve ser convertido
para base64 antes de enviado através do WS de recepção na tag <Arquivo
TXT>. Neste segundo envio somente as tags abaixo necessitam estarem
preenchidas:

<Cabecalho>
<EmpCnpj>EmpCNPJ</EmpCnpj>
<EmpCK>EmpCK</EmpCK>
<EmpPK>EmpPK</EmpPK>
<EmpCodigo>EmpCodigo</EmpCodigo>
</Cabecalho>

78
Manual de Integração WS InvoiCy NFS-e
<ArquivoTXT>Arquivo em base64</ArquivoTXT>

<Extensao>Extensão do arquivo</Extensao>

O InvoiCY NFS-e possibilita a importação de arquivos com extensão


TXT, XML e CSV. Para maiores informações sobre o WS de recepção consultar
o tópico Envio de RPS e Campos do XML de envio.

Após isso, o InvoiCy NFS-e lê o arquivo recebido e atualiza as


informações do RPS em sua base de dados.

O cancelamento de NFS-e somente pode ser realizado no sistema da


prefeitura. Para que as informações permanecam atualizadas também no
InvoiCy NFS-e, é necessário realizar o processo de cancelamento no
InvoiCy NFS-e através do WS de cancelamento. Para mais informações
consultar o tópico Cancelamento de NFS-e.

O processo de consulta de RPS retorna as informações conforme


estão na base de dados do InvoiCy NFS-e, pois não existe uma comunicação
direta com o sistema da prefeitura.

Para decodicar arquivos para base64, consultar o tópico Exemplo de


decodifcação de base64 para arquivo.

79
Manual de Integração WS InvoiCy NFS-e
3 Informações específicas de padrões

Nesta seção são encontradas particularidades que alguns padrões de


integração possuem e que devem ser seguidas no processo de integração ou
após, durante o processo de emissão de NFS-e.

3.1 Ábaco

Para este padrão destaca-se particularidades com relação a série do


RPS – pode conter no máximo 3 caracteres e com relação a numeração do
RPS – deve ser sequencial único, não importando a série.

3.2 DFSNET

O padrão DFSNET possui algumas particularidades, conforme


relacionadas abaixo:

- Para os municípios abrangidos pelo padrão DSFNET, o RPS deve ser


enviado sempre com a série 99. Em situações em que a prefeitura autorizar o
prestador a utilizar uma série diferente, o sistema irá efetivar a nota porém
não atualizará o status do RPS para efetivado automaticamente. Neste caso o
usuário deverá clicar no botão Atualizar Status para o respectivo RPS (o
retorno do envio não informa a série e o InvoiCy NFS-e necessita dela para
atualizar as informações do RPS);

- A tag <TomaTelefone>, deve ser inserido também o código DDD


(ex: 55, 11, 51) no início, pois o InvoiCy NFS-e identifica os dois primeiros
dígitos do número como sendo o DDD para enviar à prefeitura conforme a
estrutura do padrão DSFNET. O DDD também deverá constar no cadastro da
empresa no InvoiCy NFS-e, no campo Telefone;

- A tag <CMun> e <TomacMun> no xml de envio, sempre deve ser


informado o código do município IBGE, pelo fato de que as prefeituras do
padrão DSFNET utilizam códigos de município seguindo a tabela SIAFI. Neste

80
Manual de Integração WS InvoiCy NFS-e
caso o InvoiCy NFS-e substitui a informação antes de enviar o RPS à
prefeitura.

- Apenas as prefeituras de Sorocaba/SP e Campo Grande/MS


permitem informar o intermediário do serviço. Neste caso além de informar o
intermediário do serviço, o campo operação deverá informar o valor
Intermediação (J);

- Ao informar um RPS substituto é possível ainda informar qual a NFSe


substituída. Neste caso, deverá ser preenchidos os
campos <SubsNFSeNumero> com o número da NFSe substituída
e <SubsDEmisNFSe> informando a data de emissão desta nota;

- As tags <DedCNPJRef>, <DedCPFRef>, <DedmNFRef>,


<DedvlTotRef> só deverão ser informados quando a atividade permitir
dedução por materiais (campo <Operacao> = B);

- A tag <ItemTributavel> deve ser informado atividade disponibilizado


no item Atividades de itens de serviços com marcação Não tributável -
DFSNET. Atividades que não constam neste anexo, devem ser enviadas com a
tag <ItemTributavel> = S.

- A tag <NatOp> deverá respeitar os seguintes valores, sendo os


valores 21 a 24 exclusivos deste padrão:

1 – Tributável;

2 - Não Incidência no Município;

3 - Isenta de ISS;

4 – Imune;

5 - Exigibilidade Suspensa por Decisão Judicial;

81
Manual de Integração WS InvoiCy NFS-e
6 - Exigibilidade Suspensa por Processo Administrativo;

21 - Não tributável;

22 - Tributável Fixo;

23 - Tributável S.N.;

24-Micro Empreendedor Individual.

3.3 E-nota Portal Público

O padrão e-Nota Portal Publico trabalha com a estrutura de itens,


quando informado um ou mais itens, é necessário informar a tag
<ItemcServMunic> com o código da lista de serviços lei 116/2003. Quando
informado nenhum item, o sistema irá gerar automaticamente um item
contendo as informações da nota, preenchendo a tag <ItemcServMunic>
com o valor da tag <IteListServ>.

Nota: O sistema da prefeitura permite exportar todos as notas fiscais


eletrônicas de serviço de um determinado período em um arquivo com
extensão CSV. Este arquivo deverá ser convertido para o formato em base64 e
enviado via WebService ao InvoiCy NFS-e pela tag <ArquivoTXT> dentro
de um único RPS, devendo obrigatoriamente preencher a tag <Extensao>
com o valor CSV.

Para realizar a exportação das notas fiscais eletrônicas de serviço no


sistema da prefeitura, orienta-se a acessá-lo através do respectivo portal da
prefeitura, em seguida clicar na opção de Exportar Notas, a partir disso é
mostrada a tela abaixo, onde é possível realizar a exportação do arquivo CSV:

82
Manual de Integração WS InvoiCy NFS-e
Figura 24 - XML enviado para o InvoiCy NFS-e

Para decodificar arquivos para base64, consultar o tópico Exemplo de


decodifcação de base64 para arquivo.

Para mais informações sobre como realizar o processo de envio do


arquivo no InvoiCy NFS-e, orientamos consultar o tópico Orientações aos
municípios que integram com o InvoiCy NFS-e através de arquivo.

3.4 E&L

O padrão E&L não possui um ambiente para homologação de NFS-e.


Qualquer dúvida referente a homologação de NFS-e nos municípios atendidos
por este padrão, orienta-se a entrar em contato com o suporte da Migrate
Company através do e-mail: atendimento@migrate.com.br

3.5 IPM

O padrão IPM possui algumas particularidades, conforme relacionadas


abaixo:

83
Manual de Integração WS InvoiCy NFS-e
- O padrão trabalha com o envio de uma nota por conexão, não
suportando envio de RPS em lotes;

- Não existe reconsulta da RPS, sendo assim o RPS nunca assume


status Pendente: ou é efetivada ou rejeitada na prefeitura.

3.6 ISS.net

Para que seja possível realizar o envio de RPS em homologação ou em


produção, o padrão ISS.net estabelece algumas regras que devem ser
seguidas, conforme pode-se verificado a seguir.

3.6.1 Como enviar RPS para o layout do ISS.NET?

3.6.1.1 Solicitação para ambiente de Homologação (Testes)

Para que a empresa possa utilizar o ambiente de testes, é necessário


enviar a solicitação por e-mail com o assunto "Liberação para o Ambiente de
Homologação" para o endereço suporte@notacontrol.com.br com os seguintes
dados:

 Município do prestador de serviço;


 CNPJ, Inscrição Municipal, Razão Social e Endereço do
Prestador de Serviços;
 Nome, CPF e Endereço da pessoa responsável pelos testes.

O envio de Nota Eletrônica é gravado num banco de dados de


Homologação, onde podem ser realizados os testes de todos os métodos
previstos para cada aplicativo (Webservice ou Converge).

Lembrando que as notas eletrônicas enviadas no sistema de


Homologação (testes) não possuem valor legal.

84
Manual de Integração WS InvoiCy NFS-e
Para realizar homologação com o layout de integração ISS.NET é
necessário que os RPS enviados possuam informações conforme orientação do
próprio layout em alguns campos, descritos a seguir.

Informações Cadastro no sistema Respectivo campo no


XML
Empresa: Razão social da O InvoiCy NFS-e busca -
empresa informações no cadastro da
empresa
CNPJ: CNPJ da empresa O InvoiCy NFS-e busca -
informações no cadastro da
empresa
Inscrição municipal: O InvoiCy NFS-e busca -
código da inscrição municipal informações no cadastro da
empresa
Município da prestação O InvoiCy NFS-e busca -
do serviço: 999 – informações no cadastro da
Homologação ISS.NET empresa
Série documento: série - <RPSSerie>
disponibilizado pelo suporte
do ISS.NET
CNAE: disponibilizado pelo - <Cnae>
suporte do ISS.NET
Código de tributação do - <TributMunicipio>
município: código de
tributação disponibilizado
pelo suporte do ISS.NET
Alíquota do ISS: alíquota - <ValAliqISS>
disponibilizada pelo suporte
do ISS.NET

3.6.2 Solicitação para ambiente de Produção (Oficial)

Para solicitar o ambiente de Produção a empresa deverá emitir no


mínimo 5 Notas Eletrônicas no Sistema de Homologação (Testes). Para
liberação do ambiente de Produção é necessário enviar a solicitação por e-mail
com o assunto "Liberação para o Ambiente de Produção" para o endereço
suporte@notacontrol.com.br com os seguintes dados:

 Município do prestador de serviço;


 CNPJ, Inscrição Municipal, Razão Social e Endereço do
Prestador de Serviços.

85
Manual de Integração WS InvoiCy NFS-e
Para liberação dos documentos de Recibo Provisório de Serviços -
RPS é necessário acessar o Sistema ISS.Net Online de seu município e solicitar
através do menu Solicitação de Documentos Fiscais -> Solicitação. Essa
liberação é feita diretamente pela Prefeitura.

Fonte: http://www.issnetonline.com.br/portaliss/Default.aspx

3.7 Lençois paulista

Este padrão possui algumas particularidades no que diz respeito a


operações realizadas a emissão de NFS-e, conforme descritas abaixo:

- Notas devem respeitar o sequencial do PAS (RPS). Não é permitido


"pular" a numeração;

- Não permite envio de RPS de substituição. Caso um RPS com esta


informação for enviado à preferitura, o RPS é rejeitado e o InvoiCy NFS-e
retornará uma mensagem avisando sobre isso;

- O cancelamento de NFS-e somente é possível de ser realizado no


InvoiCy NFS-e. O processo de cancelamento não é enviado para a prefeitura
pois ela não possui WS para este processo. O InvoiCy NFS-e retornará uma
mensagem avisando sobre isso;

- Ao receber uma solicitação de consulta o InvoiCy NFS-e não re-


consulta o RPS/NFS-e na prefeitura porque a prefeitura não possui WS para
este processo. O InvoiCy NFS-e retorna apenas os dados que já existem na
base de dados do InvoiCy NFS-e.

3.8 SIGCorp – Londrina

Este padrão possui algumas particularidades no que diz respeito a


operações realizadas a emissão de NFS-e, conforme descritas abaixo:

86
Manual de Integração WS InvoiCy NFS-e
- O padrão não exige certificado digital;

- Este padrão não permite enviar para a prefeitura RPS de substituição


e RPS com intermediário;

- É necessário CPF e Senha de um usuário cadastrado no sistema da


prefeitura para utilizar os web services, onde estes devem ser informados nos
campos Usuário (CPF) e Senha no cadastro de empresa do InvoiCy NFS-e;

- Para este padrão o campo NatOP possui valores específicos,


conforme relacionados abaixo:

1 - Tributada no prestador;

2 - Tributada no tomador;

3 - Tributado Fixo;

4 - Isenta/Imune;

5 - Outro município;

6 - Exportação;

7 - Cancelada.

3.9 E-Caucaia

Para realizar o envio de lotes RPS ao município de Caucaia/CE é


necessário informar o código de verificação do RPS na tag <cVerificaRPS>.
Este código de verificação é único e exclusivo para cada número de RPS
enviado à prefeitura. Para obter a lista com os códigos de verificação de cada
RPS acesse o sistema da prefeitura e proceda os passos da imagem abaixo.

87
Manual de Integração WS InvoiCy NFS-e
Figura 25 – Lista de códigos de verificação RPS Caucaia

O arquivo TXT enviado à prefeitura deverá seguir a seguinte


nomenclatura: Inscrição Municipal + Competência e extensão “RPS”, ex:
0000019012014.RPS

3.10 Freire

Para realizar a emissão nos municípios atendidos pelo padrão Freire, é


preciso atentar para três principais particularidades: 1. A série deve ser
liberada na prefeitura. 2. Não permite RPS com Substituição e 3. Tomador é
obrigatório.

3.11 Municípios que integram com o InvoiCy NFS-e através de


arquivo

3.11.1 Arquivo TXT

Para os municípios de Arujá/SP, Birigui/SP, Cariacica/ES, Cubatão/SP,


Franco da Rocha/SP, Itaquaquecetuba/SP, Jandira/SP, Paulista/PE,

88
Manual de Integração WS InvoiCy NFS-e
Salgueiro/PE, Santo Antônio de Jesus/BA, Sumáre/SP e Taubaté/SP a
integração com o InvoiCy NFS-e ocorre através de arquivo TXT.

Para o município de Paulista/PE, orientamos também consultar o


tópico NFWEB.

3.11.2 Arquivo XML/CSV

Para os municípios de Bom Jardim/RJ, Curionopolis/PA, Feliz/RS,


Fortaleza dos Valos/RS, Medicilandia/PA, Osorio/RS, Pariquera-Acu/SP, Rio
Pardo de Minas/MG, São Sebastiao do Cai/RS, Uruara/PA e Vera Cruz/RS, a
integração com o InvoiCy NFS-e ocorre através de arquivo XML (envio à
prefeitura) e CSV (retorno da prefeitura).

Já o município de Caucaia/CE realiza a integração com o Invoicy


NFS-e através de arquivo TXT (envio à prefeitura) e CSV (retorno da
prefeitura).

Para mais informações sobre como realizar o processo de importação


de arquivo no InvoiCy NFS-e, orientamos a consultar o tópico Orientações
aos municípios que integram com o InvoiCy NFS-e através de arquivo.

3.12 NFWEB

O padrão NFWEB além de possuir integração através de arquivo TXT,


possui outras particulariedades para a integração com o InvoiCy NFS-e, aos
quais destaca-se abaixo:

- Os dados do tomador são obrigatórios;

- Não há substituição de RPS;

- Valores específicos para o campo natOp (representa a Situação do RPS na


prefeitura):

89
Manual de Integração WS InvoiCy NFS-e
1 - Operação normal (tributação normal);

2 - Operação isenta/Imune;

3 – Operação não tributável por este Município, efetuada em


outro Município;

4 – Cancelado;

5 – ISS Suspenso por Decisão Judicial.

3.13 NF Paulistana

Para realizar a emissão no município de São Paulo - SP, é preciso


atentar para a particularidade da Natureza da Operação. Valores específicos
para o campo natOp (representa a Situação do RPS na prefeitura):

1 - No município

2 - Fora do Município

3 - Isenção

4 - Imune

5 - Exigibilidade Susp. DJ.

6 - Exigibilidade Susp. PA.

3.14 ISSWeb - Fiorilli

Para realizar a emissão nos municípios atendidos pelo padrão ISSWeb


– Fiorilli é preciso atentar para as particularidades listadas a seguir:

- O tomador é uma informação obrigatória.

90
Manual de Integração WS InvoiCy NFS-e
- Necessário cadastrar no InvoiCy (Painel de Controle > Dados da
Empresa) o usuário e senha de autenticação para realizar a emissão.

Não possui ambiente de Homologação.

3.15 CECAM

Para realizar a emissão nos municípios atendios pelo padrão CECAM, é


imprescindível verificar as particularidades listadas a seguir. No campo "Senha
Autent." do cadastro da empresa (Painel de Controle > Dados da Empresa)
deve ser informada a chave de validação, encontrada no sistema da prefeitura
em Ferramentas > Importação de Notas Fiscais > Informações Adicionais para
Integração.

Nesta mesma página encontram-se os códigos de atividades (CÓDIGO


DOS ITENS DE ATIVIDADES) que deve ser informado no campo <IteListServ>
ou <ItemcServMunic> caso seja enviado item do RPS.

91
Manual de Integração WS InvoiCy NFS-e
O usuário poderá informar valores para até 5 dos impostos abaixo:

Imposto Tag do Xml


PIS <ValPIS>
CSLL <ValCSLL>
ISS <ValISS>
COFINS <ValCOFINS>
INSS <ValINSS>
IRRF <ValIR>

No xml de integração é obrigatório informar os campos referentes ao


local de prestação do serviço ( <LocalPrestacao> ).

<LocalPrestacao>
<SerEndTpLgr>Rua</SerEndTpLgr>
<SerEndLgr>nome da rua</SerEndLgr>
<SerEndNumero>595</SerEndNumero>
<SerEndComplemento>complemento</SerEndComplemento>
<SerEndBairro>bairro</SerEndBairro>
<SerEndxMun>NomeCidade</SerEndxMun>
<SerEndcMun>3500105</SerEndcMun>
<SerEndCep>18021140</SerEndCep>
<SerEndSiglaUF>SP</SerEndSiglaUF>
</LocalPrestacao>

Outra informação de preenchimento obrigatória são os dados do


Tomador do serviço.

A prefeitura é quem atribui as aliquotas.

3.16 Goiânia

A prefeitura de Goiânia não permite o cancelamento de NFS-e via web


service. Para isso é necessário imprimir e preencher um formulário, a ser
entregue pessoalmente na prefeitura. Mais informações nas guias
INFORMAÇÕES SOBRE SUBSTITUIÇÃO E CANCELAMENTO DE NFS-e e
FORMULÁRIOS PARA CANCELAMENTO DE NFS-e em
http://www2.goiania.go.gov.br/sistemas/saces/asp/saces00000f5.asp?sigla=s
nfse

92
Manual de Integração WS InvoiCy NFS-e
3.17 SIGCorp – TXT

O tomador é uma informação obrigatória.

O número do RPS deverá ser único por empresa, pois o padrão não
possui série, mas uma deve ser enviada ao InvoiCy NFS-e.

O cancelamento deverá ser feito diretamente no site da prefeitura. Ao


cancelar no InvoiCy NFS-e, a nota será cancelada apenas no nosso sistema.

O pardrão possui apenas as seguintes Natureza da Operação (NatOp):

1 - Tributada;

2 - Não tributada;

3 - Isenta;

4 - Imune.

4 Anexos

4.1 Validação de arquivos XML

Abaixo está descrito o procedimento para validar a estrutura do XML


que está sendo enviado para o InvoiCy NFS-e.

1. Abrir o arquivo XML que está sendo enviado para o InvoiCy NFS-e
através do Notepad ++ (ou outro software, como o XML SPY);

93
Manual de Integração WS InvoiCy NFS-e
Figura 26 - XML enviado para o InvoiCy NFS-e

2. Em seguida, é necessário validar este XML com o SCHEMA do


respectivo serviço que está utilizado (envio, consulta, etc). Para isso, acessar a
opção de Plugins > XML Tools > Valide now, conforme figura abaixo:

Figura 27 - Validação do XML

94
Manual de Integração WS InvoiCy NFS-e
Os SCHEMAS podem ser encontrados junto ao arquivo
Manual_de_Integracao_WS_InvoiCy_NFS-e.zip, que está disponível na news
do InvoiCy NFS-e.

Para que a opção de XML Tools esteja disponível no Notepad ++ é


necessário que este plugin esteje instalado. Caso não esteja, orientamos a
acessar a opção de Plugins > Plugin Manager > Shows Plugin Manager, clicar
na opção de XML Tools e clicar em Install;

3.Em seguida basta selecionar o SCHEMA XSD correspondente e


pressionar OK.

Figura 28 - Selecionar arquivo XSD

4.Após isso, será (ão) exibido (os) o (os) erro (os), ou uma mensagem
que a validação foi realizada com sucesso.

95
Manual de Integração WS InvoiCy NFS-e
Figura 29 – Erro na estrutura do XML

Figura 30 - Validação com sucesso (XML sem erro)

4.2 Exemplo de geração de CK em C#

Na linguagem C#, há uma classe com funções para gerenciamento da


criptografia com o algoritmo MD5, cuja documentação pode ser conferida no
link: http://msdn.microsoft.com/en-us/library/ez5bche8.aspx. Na figura abaixo
pode ser visto um exemplo de geração de hash MD5 em C#.

96
Manual de Integração WS InvoiCy NFS-e
Figura 31 - Exemplo de geração de MD5 em C#

4.3 Exemplo de geração de CK em Java

Na linguagem Java, existem várias classes e formas de gerar a


criptografia com o algoritmo MD5. Uma delas é exemplificada na figura
abaixo:

Figura 32 - Exemplo de geração de MD5 em Java

97
Manual de Integração WS InvoiCy NFS-e
4.4 Reserved Characters in HTML

Character Entity Number


" &#34;
' &#39;
& &#38;
< &#60;
> &#62;

4.5 ISO 8859-1 Symbols

Character Entity Number


&#160;
¡ &#161;
¢ &#162;
£ &#163;
¤ &#164;
¥ &#165;
¦ &#166;
§ &#167;
¨ &#168;
© &#169;
ª &#170;
« &#171;
¬ &#172;
&#173;
® &#174;
¯ &#175;
° &#176;
± &#177;
² &#178;
³ &#179;
´ &#180;
µ &#181;
¶ &#182;
· &#183;
¸ &#184;
¹ &#185;
º &#186;
» &#187;
¼ &#188;
½ &#189;
¾ &#190;
¿ &#191;
× &#215;
÷ &#247;

4.6 ISO 8859-1 Characters

Character Entity Number


98
Manual de Integração WS InvoiCy NFS-e
À &#192;
Á &#193;
 &#194;
à &#195;
Ä &#196;
Å &#197;
Æ &#198;
Ç &#199;
È &#200;
É &#201;
Ê &#202;
Ë &#203;
Ì &#204;
Í &#205;
Î &#206;
Ï &#207;
Ð &#208;
Ñ &#209;
Ò &#210;
Ó &#211;
Ô &#212;
Õ &#213;
Ö &#214;
Ø &#216;
Ù &#217;
Ú &#218;
Û &#219;
Ü &#220;
Ý &#221;
Þ &#222;
ß &#223;
à &#224;
á &#225;
â &#226;
ã &#227;
ä &#228;
å &#229;
æ &#230;
ç &#231;
è &#232;
é &#233;
ê &#234;
ë &#235;
ì &#236;
í &#237;
î &#238;
ï &#239;
ð &#240;
ñ &#241;
ò &#242;
ó &#243;
ô &#244;
õ &#245;
ö &#246;
ø &#248;
99
Manual de Integração WS InvoiCy NFS-e
ù &#249;
ú &#250;
û &#251;
ü &#252;
ý &#253;
þ &#254;
ÿ &#255;

4.7 Math Symbols Supported by HTML

Character Entity Number


∀ &#8704;
∂ &#8706;
∃ &#8707;
∅ &#8709;
∇ &#8711;
∈ &#8712;
∉ &#8713;
∋ &#8715;
∏ &#8719;
∑ &#8721;
− &#8722;
∗ &#8727;
√ &#8730;
∝ &#8733;
∞ &#8734;
∠ &#8736;
∧ &#8743;
∨ &#8744;
∩ &#8745;
∪ &#8746;
∫ &#8747;
∴ &#8756;
∼ &#8764;
≅ &#8773;
≈ &#8776;
≠ &#8800;
≡ &#8801;
≤ &#8804;
≥ &#8805;
⊂ &#8834;
⊃ &#8835;
⊄ &#8836;
⊆ &#8838;
⊇ &#8839;
⊕ &#8853;
⊗ &#8855;
⊥ &#8869;
⋅ &#8901;

100
Manual de Integração WS InvoiCy NFS-e
4.8 Greek Letters Supported by HTML

Character Entity Number


Α &#913;
Β &#914;
Γ &#915;
Δ &#916;
Ε &#917;
Ζ &#918;
Η &#919;
Θ &#920;
Ι &#921;
Κ &#922;
Λ &#923;
Μ &#924;
Ν &#925;
Ξ &#926;
Ο &#927;
Π &#928;
Ρ &#929;
undefined
Σ &#931;
Τ &#932;
Υ &#933;
Φ &#934;
Χ &#935;
Ψ &#936;
Ω &#937;
α &#945;
β &#946;
γ &#947;
δ &#948;
ε &#949;
ζ &#950;
η &#951;
θ &#952;
ι &#953;
κ &#954;
λ &#955;
μ &#956;
ν &#957;
ξ &#958;
ο &#959;
π &#960;
ρ &#961;
ς &#962;
σ &#963;
τ &#964;
υ &#965;
φ &#966;
χ &#967;
ψ &#968;
ω &#969;

101
Manual de Integração WS InvoiCy NFS-e
ϑ &#977;
ϒ &#978;
ϖ &#982;
Fonte: http://www.w3schools.com/tags/ref_entities.asp

4.9 Códigos para a representação de nomes dos países

Nome do país Código Alfa-2

Afeganistão AF
África do Sul ZA
Albânia AL
Alemanha DE
Andorra AD
Angola AO
Anguilla AI
Antígua e Barbuda AG
Antilhas Holandesas AN
Arábia Saudita SA
Argélia DZ
Argentina AR
Armênia AM
Aruba AW
Austrália AU
Áustria AT
Azerbaijão AZ
Bahamas BS
Bahrein BH
Bangladesh BD
Barbados BB
Bélgica BE
Belize BZ
Benim BJ
Bermudas BM
Bielorrússia BY
Bolívia BO
Bósnia-Herzegovina BA
Botswana BW
Brasil BR
Brunei BN
Bulgária BG
Burkina Faso BF
Burundi BI
Butão BT
Cabo Verde CV

102
Manual de Integração WS InvoiCy NFS-e
Camarões CM
Camboja KH
Canadá CA
Canárias IC
Catar QA
Cayman KY
Cazaquistão KZ
Chade TD
Chile CL
China CN
Chipre CY
Christmas CX
Cocos CC
Colômbia CO
Comores KM
Congo CG
Congo CG
Cook CK
Coréia do Norte KP
Coréia do Sul KR
Costa do Marfim CI
Costa Rica CR
Croácia HR
Cuba CU
Dinamarca DK
Djibouti DJ
Dominica DM
Egito EG
El Salvador SV
Emirados Árabes Unidos AE
Equador EC
Eritreia ER
Eslováquia SK
Eslovênia SI
Espanha ES
Estados Unidos US
Estônia EE
Etiópia ET
Falkland (Ilhas Malvinas) FK
Feroe FO
Fiji FJ
Filipinas PH
Finlândia FI
França FR
Gabão GA
103
Manual de Integração WS InvoiCy NFS-e
Gâmbia GM
Gana GH
Geórgia GE
Gibraltar GI
Granada GD
Grécia GR
Groenlândia GL
Guadalupe GP
Guam GU
Guatemala GT
Guernsey GG
Guiana GY
Guiana Francesa GF
Guiné-Bissau GW
Guiné-Conacri GN
Guiné-Equatorial GQ
Haiti HT
Holanda NL
Honduras HN
Hong Kong HK
Hungria HU
Iémen YE
Ilha de Man IM
Ilhas Menores Distantes dos UM
Estados Unidos
Índia IN
Indonésia ID
Irã IR
Iraque IQ
Irlanda IE
Islândia IS
Israel IL
Itália IT
Iugoslávia YU
Jamaica JM
Japão JP
Jersey JE
Jordânia JO
Kiribati KI
Kuwait KW
Laos LA
Lebuan MY
Lesoto LS
Letônia LV
Líbano LB

104
Manual de Integração WS InvoiCy NFS-e
Libéria LR
Líbia LY
Liechtenstein LI
Lituânia LT
Luxemburgo LU
Macau MO
Macedônia MK
Madagascar MG
Malásia MY
Malawi MW
Maldivas MV
Mali ML
Malta MT
Marianas do Norte MP
Marrocos MA
Marshall MH
Martinica MQ
Maurício MU
Mauritânia MR
México MX
Mianmar (Birmânia) MM
Micronésia FM
Moçambique MZ
Moldávia MD
Mônaco MC
Mongólia MN
Montserrat MS
Namíbia NA
Nauru NR
Nepal NP
Nicarágua NI
Niger NE
Nigéria NG
Niue NU
Norfolk NF
Noruega NO
Nova Caledônia NC
Nova Zelândia NZ
Omã OM
Palau PW
Panamá PA
Papua-Nova Guiné PG
Paquistão PK
Paraguai PY
Peru PE
105
Manual de Integração WS InvoiCy NFS-e
Pitcairn PN
Polinésia Francesa PF
Polônia PL
Porto Rico PR
Portugal PT
Quênia KE
Quirguistão KG
Reino Unido GB
República Centro-Africana CF
República Checa CZ
República Dominicana DO
Reunião RE
Romênia RO
Ruanda RW
Rússia RU
Saara Ocidental EH
Saint Pierre e Miquelon PM
Salomão SB
Samoa WS
Samoa Americana AS
San Marino SM
Santa Helena SH
Santa Lúcia LC
São Cristóvão e Neves KN
São Tomé e Príncipe ST
São Vicente e Granadinas VC
Senegal SN
Serra Leoa SL
Seychelles SC
Singapura SG
Síria SY
Somália SO
Sri Lanka LK
Suazilândia SZ
Sudão SD
Suécia SE
Suíça CH
Suriname SR
Tailândia TH
Taiwan TW
Tajiquistão TJ
Tanzânia TZ
Território Britânico do Oceano IO
Índico
Timor Leste TL

106
Manual de Integração WS InvoiCy NFS-e
Togo TG
Tonga TO
Toquelau TK
Trinidad e Tobago TT
Tunísia TN
Turcas e Caicos TC
Turcomenistão TM
Turquia TR
Tuvalu TV
Ucrânia UA
Uganda UG
Uruguai UY
Uzbequistão UZ
Vanuatu VU
Vaticano VA
Venezuela VE
Vietnã VN
Virgens Americanas VI
Virgens Britânicas VG
Wallis e Futuna WF
Zâmbia ZM
Zimbábue ZW
Fonte: http://www.iso.org/iso/home/standards/country_codes/iso-3166-
1_decoding_table.htm e http://pt.wikipedia.org/wiki/ISO_3166-1

107
Manual de Integração WS InvoiCy NFS-e
4.10 Atividades de itens de serviços com marcação Não tributável – DSFNET

Abaixo, relacionados atividades que permitem itens de serviços com marcação Não Tributável específico para o padrão DSFNET, onde um
RPS deve conter pelo menos um item de serviço tributável.

MUNICÍPIO CNAE ATIVIDADE DESCRIÇÃO


TERESINA 661340000 ADMINISTRACAO DE CARTOES DE CREDITO
TERESINA 869099900 OUTRAS ATIVIDADES DE ATENCAO A SAUDE HUMANA NAO ESPECIFICADAS
ANTERIORMENTE
UBERLÂNDIA 661340000 ADMINISTRACAO DE CARTOES DE CREDITO
UBERLÂNDIA 731909900 OUTRAS ATIVIDADES DE PUBLICIDADE NAO ESPECIFICADAS
UBERLÂNDIA 782050000 LOCACAO DE MAO DE OBRA TEMPORARIA
UBERLÂNDIA 865000320 ATIVIDADES DE PSICANALISE
UBERLÂNDIA 551080100 HOTEIS
UBERLÂNDIA 551080200 APARTHOTEIS
UBERLÂNDIA 551080300 MOTEIS
UBERLÂNDIA 559060100 ALBERGUES, EXCETO ASSISTENCIAIS
UBERLÂNDIA 559060300 PENSOES (ALOJAMENTO)
UBERLÂNDIA 559069900 OUTROS ALOJAMENTOS NAO ESPECIFICADOS ANTERIORMENTE
UBERLÂNDIA 655020002 PLANOS DE SAUDE (COOPERATIVA)
UBERLÂNDIA 869099901 OUTRAS ATIVIDADES DE ATENCAO A SAUDE HUMANA NAO ESPECIFICADO
ANTERIORMENTE
UBERLÂNDIA 869099902 OUTRAS ATIVIDADES DE ATENCAO A SAUDE HUMANA NAO ESPECIFICADO
ANTERIORMENTE (SERVIÇOS MÉDICOS DE ANESTESIA)
UBERLÂNDIA 655020003 PLANOS DE SAUDE (COOPERATIVA ODONTOLOGICA)

108
Manual de Integração WS InvoiCy NFS-e
BELÉM 829970200 EMISSAO DE VALES-ALIMENTACAO, VALES-TRANSPORTE E SIMILARES
BELÉM 551080101 HOTEIS - NIVEL I
BELÉM 551080102 HOTEIS - - NIVEL I I
BELÉM 551080103 HOTEISL - NIVEL I I I
CAMPO GRANDE 551080102 HOTEIS
CAMPO GRANDE 731220002 AGENCIAMENTO DE ESPACOS PARA PUBLICIDADE, EXCETO EM VEICULOS DE COMUNICACAO
CAMPO GRANDE 782050002 LOCACAO DE MAODEOBRA TEMPORARIA
CAMPO GRANDE 475120002 SERVIÇOS DE CARGA E RECARGAS DE CARTUCHOS TINTAS E TONER PARA EQUIPAMENTO DE
INFORMÁTICA
CAMPO GRANDE 212110102 LABORATORIO DE MANIPULACAO
CAMPO GRANDE 941110002 ATIVIDADES DE ORGANIZACOES ASSOCIATIVAS PATRONAIS E EMPRESARIAIS
Fonte: http://www.dsfnet.com.br/nfse_lote/Anexo8.xls

109
Manual de Integração WS InvoiCy NFS-e
4.11 Municípios integrados

Existem duas formas para realizar a busca dos munícipios que estão
integrados ao InvoiCy NFS-e:

1 - Para quem possui acesso ao sistema, basta acessar o menu


Municípios.

2 - Acessar o endereço http://www.gnfe.com.br/nfse/ e realizar a


consulta do respectivo município, conforme demonstrado na figura abaixo:

Figura 33 - Municípios integrados

4.12 Exemplo de decodificação de base64 para arquivo

Este é um exemplo de implementação em linguagem C# de


decodificação de base64 para arquivo.

Figura 34 - Exemplo de decodificação de base64 para arquivo

110
Manual de Integração WS InvoiCy NFS-e
Migrate Company Sistemas de
Informação Ltda
Rua Pe. Cacique, 985 – 2º andar
98910-000 – Três de Maio – RS
+55 55 3535 4800
www.gnfe.com.br
www.migrate.com.br

111
Manual de Integração WS InvoiCy NFS-e

Você também pode gostar