Você está na página 1de 64

Revisado em: 02/12/2016

Manual de Utilização do Web Service


Versão: 1.18 Versão da ABRASF: 1.00

NOTA FISCAL DE SERVIÇOS


ELETRÔNICA – NFSE

Manual de Utilização do Web Service

Nota Fiscal de Serviços Eletrônica – NFSE Página 1 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Sumário
1. INTRODUÇÃO................................................................................................................................ 4
1.1. NOTA FISCAL DE SERVIÇOS ELETRÔNICA - NFS-E ................................................... 4
1.2. RECIBO PROVISÓRIO DE SERVIÇO – RPS ................................................................... 4
2. ARQUITETURA DE COMUNICAÇÃO COM O CONTRIBUINTE ........................................... 6
2.1. MODELO CONCEITUAL ....................................................................................................... 6
2.1.1. Recepção e Processamento de Lote de RPS ............................................................ 6
2.1.2. Consulta de Situação de Lote de RPS ........................................................................ 7
2.1.3. Consulta de NFS-e por RPS ......................................................................................... 7
2.1.4. Consulta de Lote de RPS .............................................................................................. 8
2.1.5. Consulta de NFS-e ......................................................................................................... 9
2.1.6. Cancelamento de NFS-e ............................................................................................... 9
2.2. PADRÕES TÉCNICOS........................................................................................................ 10
2.2.1. Padrão de Comunicação ............................................................................................. 10
2.2.2. Padrão de Certificado Digital ...................................................................................... 11
2.2.3. Padrão de Assinatura Digital ...................................................................................... 12
2.2.4. Validação de Assinatura Digital pelo Sistema NFS-e.............................................. 14
2.2.5. Uso de Assinatura com Certificado Digital ................................................................ 15
2.3. PADRÃO DAS MENSAGENS XML ................................................................................... 15
2.3.1. Área do Cabeçalho ....................................................................................................... 15
2.3.2. Validação da estrutura das Mensagens XML ........................................................... 16
2.3.3. Schemas XML (arquivos XSD) ................................................................................... 17
2.3.4. Versão dos Schemas XML .......................................................................................... 17
2.4. AMBIENTE DE HOMOLOGAÇÃO ..................................................................................... 17
3. ESTRUTURA DE DADOS DO WEB SERVICE ....................................................................... 19
3.1. MODELO OPERACIONAL.................................................................................................. 19
3.1.1. Serviços Síncronos ...................................................................................................... 19
3.1.2. Serviços Assíncronos .................................................................................................. 20
3.2. FORMATOS E PADRÕES UTILIZADOS.......................................................................... 21

Nota Fiscal de Serviços Eletrônica – NFSE Página 2 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

3.3. TIPOS SIMPLES .................................................................................................................. 23


3.4. TIPOS COMPLEXOS .......................................................................................................... 26
3.5. SERVIÇOS ............................................................................................................................ 35
3.5.1. Versão do Sistema ....................................................................................................... 36
3.5.2. Recepção de Lote RPS ............................................................................................... 36
3.5.3. Consulta de Situação de Lote de ............................................................................... 38
3.5.4. Consulta de NFS-e por RPS ....................................................................................... 39
3.5.5. Consulta de NFS-e ....................................................................................................... 41
3.5.6. Consulta de Lote de RPS ............................................................................................ 43
3.5.7. Cancelamento NFS-e .................................................................................................. 45
3.5.8. Gerar NFS-e .................................................................................................................. 46
4. ANEXOS ........................................................................................................................................ 49
4.1. TABELA DE ERROS ........................................................................................................... 49
4.2. TABELA DE ALERTAS ....................................................................................................... 55
4.3. TABELA DE MENSAGENS PERSONALIZADAS ............................................................ 56
5. VERSÕES DO MANUAL............................................................................................................. 61
5.1. ATUALIZAÇÕES .................................................................................................................. 61

Nota Fiscal de Serviços Eletrônica – NFSE Página 3 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

1. INTRODUÇÃO

Este manual tem como objetivo apresentar as especificações e critérios técnicos


necessários para utilização do Web Service disponibilizado pelas Secretarias Municipais
de Fazenda para as empresas prestadoras e/ou tomadoras de serviços.
Através do Web Service as empresas poderão integrar seus próprios sistemas de
informações com o Sistema de Notas Fiscais de Serviço Eletrônicas das Secretarias
Municipais de Fazenda. Desta forma, consegue-se automatizar o processo de geração,
consulta e cancelamento de NFS-e.
O Web Service e todos os seus serviços, referenciados nesse documento, são
baseados no modelo nacional de NFS-e, definido pela Associação Brasileira de
Secretários e Dirigentes das Finanças dos Municípios das Capitais (ABRASF) e pela
Receita Federal do Brasil (RFB).

1.1. NOTA FISCAL DE SERVIÇOS ELETRÔNICA - NFS-E

A Nota Fiscal de Serviços Eletrônica (NFS-e) é um documento de existência


exclusivamente digital, gerado e armazenado eletronicamente pela prefeitura ou por outra
entidade conveniada, para documentar as operações de prestação de serviços.
A geração da NFS-e será feita, automaticamente, por meio de serviços
informatizados, disponibilizados aos contribuintes. Para que sua geração seja efetuada,
dados que a compõem serão informados, analisados, processados, validados e, se
corretos, gerarão o documento.
A responsabilidade pelo cumprimento da obrigação acessória de emissão da NFS-
e e pelo correto fornecimento dos dados à secretaria, para a geração da mesma, é do
contribuinte.

1.2. RECIBO PROVISÓRIO DE SERVIÇO – RPS

A NFS-e somente será gerada através dos serviços informatizados disponibilizados


pelas Secretarias Municipais de Fazenda. Esse tipo de serviço é seguido de alguns riscos
inerentes à ininterrupta disponibilidade, podendo, portanto, em alguns momentos tornar-
se indisponível.

Nota Fiscal de Serviços Eletrônica – NFSE Página 4 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Visando manter as atividades dos contribuintes ininterruptas, independente de os


serviços informatizados disponibilizados pelas Secretarias Municipais de Fazenda
estarem disponíveis, foi criado o Recibo Provisório de Serviços (RPS), que é um
documento de posse e responsabilidade do contribuinte, que deverá ser gerado
manualmente ou por alguma aplicação local, possuindo uma numeração sequencial
crescente e devendo ser convertido em NFS-e no prazo estipulado pela legislação
tributária municipal.

Nota Fiscal de Serviços Eletrônica – NFSE Página 5 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

2. ARQUITETURA DE COMUNICAÇÃO COM O CONTRIBUINTE

2.1. MODELO CONCEITUAL

Através do Web Service, o Sistema de Notas Fiscais de Serviço Eletrônicas das


Secretarias Municipais de Fazenda disponibilizará serviços que poderão ser acessados
pelos sistemas dos contribuintes. A seguir, estão resumidos os serviços disponíveis e
suas respectivas funcionalidades básicas.

2.1.1. Recepção e Processamento de Lote de RPS

Esse serviço compreende a recepção do Lote de RPS, a resposta com o número


do protocolo gerado para esta transação e o processamento do lote. Quando efetuada a
recepção, o Lote entrará na fila para processamento posterior onde serão feitas as
validações necessárias e geração das NFS-e.

XML de Envio é validado pelo arquivo: servico_enviar_lote_rps_envio.xsd


XML de Resposta é validado pelo arquivo:
servico_enviar_lote_rps_resposta.xsd

Passos para execução


1. A aplicação acessa o serviço de “Recepção e Processamento de Lote de
RPS” enviando o lote (fluxo “b”).
2. A requisição é recebida pelo servidor do Web Service que grava as informações
recebidas e gera o número de protocolo de recebimento (fluxo “c”).
3. O Web Service retorna uma mensagem com o resultado do processamento do
serviço (fluxo “d”).

Nota Fiscal de Serviços Eletrônica – NFSE Página 6 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

2.1.2. Consulta de Situação de Lote de RPS

Esse serviço efetua a consulta da situação de um Lote de RPS já enviado.

XML de Envio é validado pelo arquivo: servico_consultar_situacao_lote_rps_envio.xsd


XML de resposta é validado pelo arquivo:
servico_consultar_situacao_lote_rps_resposta.xsd

Passos para execução


1. A aplicação acessa o serviço de “Consulta de Situação de Lote de RPS” e submete
os dados para processamento (fluxo “2.b”).
2. A requisição é recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica o status do lote (fluxos “2.c” e “2.d”). O Web Service retorna
uma mensagem com o resultado do processamento do serviço (fluxo “2.e”).

2.1.3. Consulta de NFS-e por RPS

Esse serviço efetua a consulta de uma NFS-e a partir do número de RPS que a
gerou.

XML de Envio é validado pelo arquivo: servico_consultar_nfse_rps_envio.xsd


XML de Resposta é validado pelo arquivo: servico_consultar_nfse_rps_resposta.xsd

Nota Fiscal de Serviços Eletrônica – NFSE Página 7 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Passos para execução


1. A aplicação acessa o serviço de “Consulta de NFS-e por RPS” e submete os dados
para processamento (fluxo “2.b”).
2. A requisição é recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica a NFS-e correspondente (fluxos “2.c” e
“2.d”).
3. O Web Service retorna uma mensagem com o resultado do processamento do
serviço (fluxo “2.e”).

2.1.4. Consulta de Lote de RPS

Esse serviço permite ao contribuinte obter as NFS-e que foram geradas a partir do

Lote de RPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista

de erros e/ou inconsistências encontradas nos RPS.

Na validação do lote, devem ser retornados todos os erros verificados.


Excepcionalmente, havendo uma excessiva quantidade de erros, poderá ser definido um
limitador para a quantidade de erros retornados.

XML de Envio é validado pelo arquivo: servico_consultar_lote_rps_envio.xsd


XML de Resposta é validado pelo arquivo: servico_consultar_lote_rps_resposta.xsd

Passos para execução


1. A aplicação acessa o serviço de “Consulta de Lote de RPS” e submete os dados
para processamento (fluxo “b”).
2. A requisição é recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos “c” e “d”).

Nota Fiscal de Serviços Eletrônica – NFSE Página 8 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

3. O Web Service retorna uma mensagem (a estrutura com a lista da NFS-e geradas
ou as mensagens de erro) com o resultado do processamento do serviço (fluxo
“e”).

2.1.5. Consulta de NFS-e

Esse serviço permite a obtenção de determinada NFS-e já gerada.

XML de Envio é validado pelo arquivo: servico_consultar_nfse_envio.xsd


XML de Resposta é validado pelo arquivo: servico_consultar_nfse_resposta.xsd

Passos para execução


1. A aplicação acessa o serviço de “Consulta de NFS-e” e submete os dados para
processamento ().
2. A requisição é recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes.
3. O Web Service retorna uma mensagem com o resultado do processamento do
serviço.

2.1.6. Cancelamento de NFS-e

Esse serviço permite o cancelamento direto de uma NFS-e sem substituição da


mesma por outra.

Nota Fiscal de Serviços Eletrônica – NFSE Página 9 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

XML de Envio é validado pelo arquivo: servico_cancelar_nfse_envio.xsd


XML de Resposta é validado pelo arquivo: servico_cancelar_nfse_resposta.xsd
Passos para execução
1. A aplicação acessa o serviço de “Cancelamento de NFS-e” e submete os dados
para processamento (fluxo “2.b”).
2. A requisição é recebida pelo servidor do Web Service, que verifica os dados
preenchidos, identifica a NFS-e correspondente e efetua o seu cancelamento (fluxo
“2.c”).
3. O Web Service retorna uma mensagem com o resultado do processamento do
serviço (fluxo “2.d”).

2.2. PADRÕES TÉCNICOS

2.2.1. Padrão de Comunicação

O meio físico de comunicação utilizado entre os sistemas de informação dos


contribuintes e o Sistema de Notas Fiscais de Serviço Eletrônicas das Secretarias Municipais
de Fazenda será a Internet, com o uso do protocolo SSL, que além de garantir
um duto de comunicação seguro na Internet, permite a identificação do servidor e do

Nota Fiscal de Serviços Eletrônica – NFSE Página 10 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

cliente através de certificados digitais, eliminando a necessidade de identificação do


usuário através de nome ou código de usuário e senha.
O modelo de comunicação segue o padrão de Web Services definido pelo WS-I
Basic Profile.
A troca de mensagens entre o Web Service do Sistema de Notas Fiscais de Serviço
Eletrônicas das Secretarias Municipais de Fazenda e o sistema do contribuinte será
realizada no padrão SOAP, com troca de mensagens XML no padrão Style/Enconding:
Document/Literal, wrapped. A opção “wrapped” representa a chamada aos métodos
disponíveis com a passagem de mais de um parâmetro. Para descrever os serviços
disponibilizados, será utilizado um documento WSDL (Web Service Description
Language). O WSDL é o padrão recomendado para descrição de serviços SOAP.

As chamadas aos serviços serão feitas enviando como parâmetro um documento


XML a ser processado pelo sistema. Esse documento não fará parte da descrição do
serviço (arquivo WSDL), e o formato do XML correspondente ao serviço deverá ser
consultado nesse manual de integração, seção 3.5.

2.2.2. Padrão de Certificado Digital

Os certificados digitais utilizados no sistema de Notas Fiscais de Serviço


Eletrônicas, das Secretarias Municipais de Fazenda, serão emitidos por Autoridade
Certificadora credenciada pela Infraestrutura de Chaves Públicas Brasileira – ICP-Brasil,
de pessoa física ou jurídica, dos tipos A1, A3 ou certificado de servidor (híbrido).
Para a assinatura digital dos documentos envolvidos aceitar-se-á que o certificado
digital seja de quaisquer dos estabelecimentos da empresa.

Nota Fiscal de Serviços Eletrônica – NFSE Página 11 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Os certificados digitais serão exigidos em 2 (dois) momentos distintos para a


integração entre o sistema do contribuinte e o Web Service das Secretarias Municipais de
Fazenda:
• Assinatura de Mensagens: O certificado digital utilizado para essa função deverá
conter o CNPJ do estabelecimento emissor da NFS-e ou o CNPJ do estabelecimento
matriz. O certificado digital deverá ter o “uso da chave” previsto para a função de
assinatura digital, respeitando a Política do Certificado.
• Transmissão (durante a transmissão das mensagens entre os servidores do
contribuinte e os serviços disponibilizados pelas Secretarias Municipais de
Fazenda): O certificado digital utilizado para identificação do aplicativo do
contribuinte deverá conter o CNPJ do responsável pela transmissão das
mensagens, mas não necessita ser o mesmo CNPJ do estabelecimento emissor
da NFS-e, devendo ter a extensão extended Key Usage com permissão de
"Autenticação Cliente".

2.2.3. Padrão de Assinatura Digital

As mensagens enviadas aos serviços disponibilizados pelas Secretarias


Municipais de Fazenda são documentos eletrônicos elaborados no padrão XML e devem
ser assinados digitalmente com um certificado digital que contenha o CNPJ do
estabelecimento matriz ou o CNPJ do estabelecimento emissor da NFS-e objeto do
pedido.
Para garantir minimamente a integridade das informações prestadas e a correta
formação dos arquivos XML, o contribuinte deverá submeter às mensagens XML para
validação pela linguagem de Schema do XML (XSD – XML Schema Definition),
disponibilizada pelas Secretarias Municipais de Fazenda antes de seu envio.
Os elementos abaixo estão presentes dentro do Certificado do contribuinte
tornando desnecessária a sua representação individualizada no arquivo XML. Portanto, o
arquivo XML não deve conter os elementos:
<X509SubjectName>
<X509IssuerSerial>
<X509IssuerName>

Nota Fiscal de Serviços Eletrônica – NFSE Página 12 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

<X509SerialNumber>
<X509SKI>
Deve-se evitar o uso das TAGs abaixo, pois as informações serão obtidas a partir
do Certificado do emitente:
<KeyValue>
<RSAKeyValue>
<Modulus>
<Exponent>
O Projeto NFS-e utiliza um subconjunto do padrão de assinatura XML definido
pelo http://www.w3.org/TR/xmldsig-core/, que tem o seguinte leiaute:

# CAMPO ELEMENTO PAI TIPO DESCRIÇÃO OC.


XS01 Signature Raiz
XS02 Id A XS01 C 1-1
XS03 SignedInfo G XS01 Grupo da Informação da 1-1
assinatura
XS04 Canonicalization G XS03 Grupo do Método de 1-1
Method Canonicalização
XS05 Algorithm A XS04 C Atributo Algorithm de 1-1
CanonicalizationMethod:
http://www.w3.org/TR/2001/
REC-xml-c14n-
20010315
XS06 SignatureMethod G XS03 Grupo do Método de 1-1
Assinatura
XS07 Algorithm A XS06 C Atributo Algorithm de 1-1
SignedInfo:
http://www.w3.org/2000/09/
xmldsig#rsa-sha1
XS08 Reference G XS03 Grupo do Método de 1-1
Reference
XS09 URI A XS08 C Atributo URI da tag Reference 1-1
XS10 Transforms G XS08 Grupo do algorithm de 1-1
Transform
XS11 Unique_Transf_A RC XS10 Regra para o atributo 1-1
lg Algorithm do Transform ser
único
XS12 Transform G XS10 Grupo de Transform 2-2
XS13 Algorithm A XS12 C Atributos válidos Algorithm do 1-1
Transform:
http://www.w3.org/TR/2001/
REC-xml-c14n-20010315
http://www.w3.org/2000/09/
xmldsig#envelopedsignature
XS14 Xpath E XS12 C Xpath 0-N

Nota Fiscal de Serviços Eletrônica – NFSE Página 13 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

XS15 DigestMethod G XS08 Grupo do Método de 1-1


DigestMethod
XS16 Algorithm A XS15 C Atributo Algorithm de 1-1
DigestMethod:
http://www.w3.org/2000/09/
xmldsig#sha1
XS17 DigestValue E XS08 C Digest Value (Hash SHA-1 – 1-1
Base64)
XS18 SignatureValue G XS01 Grupo do Signature Value 1-1
XS19 KeyInfo G XS01 Grupo do KeyInfo 1-1
XS20 X509Data G XS19 Grupo X509 1-1
XS21 X509Certificate E XS20 C Certificado Digital x509 em 1-1
Base64b

2.2.4. Validação de Assinatura Digital pelo Sistema NFS-e

Para a validação da assinatura digital, seguem as regras que serão adotadas pelas
Secretarias Municipais de Fazenda:
1. Extrair a chave pública do certificado;
2. Verificar o prazo de validade do certificado utilizado;
3. Montar e validar a cadeia de confiança dos certificados validando também a LCR
(Lista de Certificados Revogados) de cada certificado da cadeia;
4. Validar o uso da chave utilizada (Assinatura Digital) de tal forma a aceitar
certificados somente do tipo A (não serão aceitos certificados do tipo S);
5. Garantir que o certificado utilizado é de um usuário final e não de uma Autoridade
Certificadora;
6. Adotar as regras definidas pelo RFC 3280 para LCRs e cadeia de confiança;
7. Validar a integridade de todas as LCR utilizadas pelo sistema;
8. Prazo de validade de cada LCR utilizada (verificar data inicial e final).

A forma de conferência da LCR fica a critério de cada Secretaria Municipal de


Fazenda, podendo ser feita de 2 (duas) maneiras: On-line ou Download periódico. As
assinaturas digitais das mensagens serão verificadas considerando o horário fornecido
pelo Observatório Nacional.

Nota Fiscal de Serviços Eletrônica – NFSE Página 14 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

2.2.5. Uso de Assinatura com Certificado Digital

Para garantir a autenticidade dos dados gerados, algumas informações deverão


ser assinadas digitalmente. Abaixo segue as informações que deverão ser assinadas e
quem deverá fazê-lo em cada momento:
O RPS, pelo contribuinte, antes do envio do mesmo através do Lote de RPS;
O Lote de RPS, pelo contribuinte, antes do envio do mesmo;
A NFS-e:
o Pela prefeitura e pelo contribuinte, quando gerada pela Aplicação On Line;
o Pela prefeitura nos demais casos;
O Pedido de cancelamento da NFS-e, pelo contribuinte;
A Confirmação de cancelamento da NFS-e, pela prefeitura;

2.3. PADRÃO DAS MENSAGENS XML

A especificação adotada para as mensagens XML é a recomendação W3C para


XML 1.0, disponível em www.w3.org/TR/REC-xml e a codificação dos caracteres será em
UTF-8.
As chamadas dos Web Services disponibilizados pelas Secretarias Municipais de
Fazenda e os respectivos resultados do processamento são realizadas através das
mensagens com o seguinte padrão:

Área de Cabeçalho – estrutura XML padrão para todas as mensagens de


chamada e retorno de resultado dos Web Services disponibilizados pelas
Secretarias Municipais de Fazenda, que contém os dados de controle da
mensagem. A área de cabeçalho está sendo utilizada para armazenar a versão do
leiaute da estrutura XML informado na área de dados.
Área de Dados – estrutura XML variável definida na documentação do Web
Service acessado.

2.3.1. Área do Cabeçalho

Abaixo, o leiaute da Área de Cabeçalho padrão:

# CAMPO ELEMENTO PAI TIPO TAM. DESCRIÇÃO OC.


Nota Fiscal de Serviços Eletrônica – NFSE Página 15 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

1 cabeçalho G TAG raiz do cabeçalho da 1-1


mensagem.
versão A 1 N 4 Versão do leiaute. 1-1
2 versaoDados E 1 N 4 O conteúdo deste campo indica a 1-1
versão do leiaute XML da estrutura
XML informada na área de dados da
mensagem.

O campo versaoDados deve conter a informação da versão do leiaute da


estrutura XML armazenada na área de dados da mensagem.
A estrutura XML armazenada na área de dados está definida na documentação
do Web Service acessado.

2.3.2. Validação da estrutura das Mensagens XML

Para garantir minimamente a integridade das informações prestadas e a correta


formação das mensagens XML, o contribuinte deverá submeter cada uma das
mensagens XML de pedido de serviço para validação pelo seu respectivo arquivo XSD
(XML Schema Definition, definição de esquemas XML) antes de seu envio. Neste manual
utilizaremos a nomenclatura Schema XML para nos referir a arquivo XSD.
Um Schema XML define o conteúdo de uma mensagem XML, descrevendo os seus
atributos, elementos e a sua organização, além de estabelecer regras de preenchimento
de conteúdo e de obrigatoriedade de cada elemento ou grupo de informação.
A validação da estrutura da mensagem XML é realizada por um analisador sintático
(parser) que verifica se a mensagem XML atende as definições e regras de seu respectivo
Schema XML.
Qualquer divergência da estrutura da mensagem XML em relação ao seu
respectivo Schema XML, provoca um erro de validação do Schema XML. Neste caso o
conteúdo da mensagem XML de pedido do serviço não poderá ser processado.
A primeira condição para que a mensagem XML seja validada com sucesso é que
ela seja submetida ao Schema XML correto.
Assim, os sistemas de informação dos contribuintes devem estar preparados para
gerar mensagens XML em seus respectivos Schemas XML em vigor.

Nota Fiscal de Serviços Eletrônica – NFSE Página 16 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

2.3.3. Schemas XML (arquivos XSD)

O Schema XML (arquivo XSD) correspondente a cada uma das mensagens XML
de pedido e de retorno utilizadas pelo Web Service pode ser obtido na internet acessando
o Portal do Sistema de Notas Fiscais de Serviço Eletrônicas das Secretarias Municipais
de Fazenda.

2.3.4. Versão dos Schemas XML

Toda mudança de layout das mensagens XML do Web Service implica na


atualização do seu respectivo Schema XML.
A identificação da versão dos Schemas XML será realizada com o acréscimo do
número da versão com dois dígitos no nome do arquivo XSD precedida da literal ‘_v’,
como segue:
<Nome do Arquivo>_v<Número da
Versão>.xsd Exemplo:
tipos_nfse_v01.xsd
A maioria dos Schemas XML definidos para a utilização do Web Service do Sistema
de Notas Fiscais de Serviço Eletrônicas das Secretarias Municipais de Fazenda utilizam
as definições de tipos simples ou tipos complexos que estão definidos em outros Schemas
XML, nestes casos, a modificação de versão do Schema básico será repercutida no
Schema principal.
As modificações de layout das mensagens XML do Web Service podem ser
causadas por necessidades técnicas ou em razão da modificação de alguma legislação.
As modificações decorrentes de alteração da legislação deverão ser implementadas nos
prazos previstos no ato normativo que introduziu a alteração. As modificações de ordem
técnica serão divulgadas pelas Secretarias Municipais de Fazenda e poderão ocorrer
sempre que se fizerem necessárias.

2.4. AMBIENTE DE HOMOLOGAÇÃO

Para testar os serviços Web Services publicados, há um ambiente de


homologação, onde o usuário poderá utilizar por tempo indeterminado.

Nota Fiscal de Serviços Eletrônica – NFSE Página 17 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

O usuário realizará um cadastro e criará uma senha de acesso. A credencial do


usuário, CNPJ e senha, serão solicitadas no momento de consumir um serviço ou acessar
o ambiente de homologação.

As notas fiscais emitidas no ambiente de homologação não têm nenhuma validação


fiscal.

Seguem abaixo os links de cadastro e de homologação.

Link de cadastro: http://187.45.245.217/nfse_homologacao/

Link de homologação: http://187.45.245.217/ws_nfse/nfseservice.svc

Observação: Caso as funcionalidades sejam implementadas por empresas de


desenvolvimento de software, não é necessário o cadastro de todas as empresas que
utilizarão as funcionalidades publicadas, visto que as regras de negócios são idênticas.

Nota Fiscal de Serviços Eletrônica – NFSE Página 18 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

3. ESTRUTURA DE DADOS DO WEB SERVICE

Existirá um único Web Service com todos os serviços apresentados no item 2.1. O
fluxo de comunicação é sempre iniciado pelo sistema do contribuinte através do envio de
uma mensagem XML ao Web Service com o pedido do serviço desejado.

3.1. MODELO OPERACIONAL

A forma de processamento das solicitações de serviços no projeto Nota Fiscal de


Serviços Eletrônica pode ser síncrona, caso o atendimento da solicitação de serviço seja
realizada na mesma conexão ou assíncrona, quando o processamento do serviço solicitado
não é atendido na mesma conexão, devido a uma demanda de processamento de grande
quantidade de informação. Nesta situação torna-se necessária a realização de mais uma
conexão para a obtenção do resultado do processamento.
As solicitações de serviços que exigem processamento intenso serão executadas
de forma assíncrona e as demais solicitações de serviços de forma síncrona.
Assim, os serviços da NFS-e serão implementados da seguinte forma:
SERVIÇO IMPLEMENTAÇÃO
Recepção e Processamento de Lote de RPS Assíncrona
Consulta de Situação de Lote de RPS Síncrona
Consulta de NFS-e por RPS Síncrona
Consulta de Lote de RPS Síncrona
Consulta de NFS-e Síncrona
Cancelamento de NFS-e Síncrona

3.1.1. Serviços Síncronos

As solicitações de serviços de implementação síncrona são processadas


imediatamente e o resultado do processamento é obtido em uma única conexão.
Abaixo, o fluxo simplificado de funcionamento:

Nota Fiscal de Serviços Eletrônica – NFSE Página 19 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Etapas do processo ideal:


1. O aplicativo do contribuinte inicia a conexão enviando uma mensagem de
solicitação de serviço para o Web Service;
2. O Web Service recebe a mensagem de solicitação de serviço e encaminha ao
aplicativo da NFS-e que irá processar o serviço solicitado;
3. O aplicativo da NFS-e recebe a mensagem de solicitação de serviços e realiza o
processamento, devolvendo uma mensagem de resultado do processamento ao
Web Service;
4. O Web Service recebe a mensagem de resultado do processamento e o encaminha
ao aplicativo do contribuinte;
5. O aplicativo do contribuinte recebe a mensagem de resultado do processamento e
caso não exista outra mensagem, encerra a conexão.

3.1.2. Serviços Assíncronos

As solicitações de serviços de implementação assíncrona são processadas de


forma distribuída por vários processos e o resultado do processamento somente é obtido
na segunda conexão.
Abaixo, o fluxo simplificado de funcionamento:

Etapas do processo ideal:


Solicitação e processamento:
1. O aplicativo do contribuinte inicia a conexão enviando uma mensagem de
solicitação de serviço para o Web Service de recepção de solicitação de serviços;
2. O Web Service de recepção de solicitação de serviços recebe a mensagem de
solicitação de serviço e a coloca na fila de serviços solicitados, acrescentando o
CNPJ do transmissor obtido do certificado digital do transmissor;

Nota Fiscal de Serviços Eletrônica – NFSE Página 20 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

3. O Web Service de recepção de solicitação de serviços retorna o protocolo da


solicitação de serviço e a data e hora de gravação na fila de serviços solicitados ao
aplicativo do contribuinte;
4. O aplicativo do contribuinte recebe o protocolo;
5. Na estrutura interna do aplicativo de NFS-e a solicitação de serviços é retirada da
fila de serviços solicitados pelo aplicativo da NFS-e em momento específico,
definido pela equipe técnica da NFS-e;
6. O serviço solicitado é processado pelo aplicativo da NFS-e e o resultado do
processamento é colocado na fila de serviços processados;

Obtenção do resultado do serviço:


7. O aplicativo do contribuinte, através do protocolo recebido, envia uma consulta ao
serviço que retornará o resultado do processamento daquele protocolo, iniciando
uma conexão com o Web Service;
8. O Web Service recebe a mensagem de consulta e localiza o resultado de
processamento da solicitação de serviço;
9. O Web Service devolve o resultado do processamento ao aplicativo contribuinte;
10. O aplicativo do contribuinte recebe a mensagem de resultado do processamento e,
caso não exista outra mensagem, encerra a conexão.

3.2. FORMATOS E PADRÕES UTILIZADOS

Abaixo segue algumas formatações de dados que devem ser seguidas para
geração correta na estrutura dos arquivos.
FORMATO OBSERVAÇÃO
Data (date) Formato: AAAA-MM-DD
onde:
AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres
Data/Hora (datetime) Formato AAAA-MM-DDTHH:mm:ss
onde:
AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres
T = caractere de formatação que deve existir separando a data da
hora
HH = hora com 2 caracteres

Nota Fiscal de Serviços Eletrônica – NFSE Página 21 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

mm: minuto com 2 caracteres


ss: segundo com 2 caracteres
Valores Decimais Formato: 0.00
(decimal) Não deve ser utilizado separador de milhar. O ponto (.) deve ser
utilizado
para separar a parte inteira da fracionária.
Exemplo:
48.562,25 = 48562.25
1,00 = 1.00 ou 1
0,50 = 0.50 ou 0.5
Valores Percentuais Formato 00.00
(decimal) O formato em percentual presume o valor percentual em sua forma
fracionária, contendo 5 dígitos. O ponto (.) separa a parte inteira da
fracionária.
Exemplo:
62% = 62.00
15% = 15.00
25,32 = 25.32

Não deve ser inserido caractere não significativo para preencher o tamanho
completo do campo, ou seja, zeros antes de número ou espaço em branco após cadeia
de caracteres. A posição do campo é definida na estrutura do documento XML através de
TAGs (<tag>conteúdo</tag>).
A regra constante do parágrafo anterior deverá estender-se para os campos onde
não há indicação de obrigatoriedade e que, no entanto, seu preenchimento torna-se
obrigatório por estar condicionado à legislação específica ou ao negócio do contribuinte.
Neste caso, deverá constar a TAG com o valor correspondente e, para os demais campos,
deverão ser eliminadas as TAGs.
Para reduzir o tamanho final do arquivo XML da NFS-e alguns cuidados de
programação deverão ser assumidos:
não incluir "zeros não significativos" para campos numéricos;

não incluir "espaços" no início ou no final de campos numéricos e alfanuméricos;


não incluir comentários no arquivo XML;
não incluir anotação e documentação no arquivo XML (TAG annotation e TAG
documentation);
não incluir caracteres de formatação no arquivo XML ("line-feed", "carriage return",
"tab", caractere de "espaço" entre as TAGs).
As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser
enviada.

Nota Fiscal de Serviços Eletrônica – NFSE Página 22 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

3.3. TIPOS SIMPLES

A seguir encontra-se a tabela com a lista dos tipos simples que serão utilizados
como tipos de dados. A tabela está dividida em 4 colunas, a saber:
Campo: nome do tipo simples;
Tipo: tipo primitivo de dados utilizados pelo campo:
o C: Caractere;
o N: Número;
o D: Data ou Data/Hora;

Descrição: descreve informações sobre o


campo; Tam.: tamanho do campo:
o Quando for caracteres o tamanho define a quantidade máxima de
caracteres que o texto poderá ter;
o Quando for numérico o tamanho pode ser representado das seguintes
formas:
 Número inteiro, que define o total de dígitos existente no número.
Exemplo: “15” significa que o número poderá ter, no máximo, 15
dígitos; 

 Número fracionário, que define o total de dígitos e quantos deles 
serão designados para a parte fracionária. Exemplo: “15,2”
significa que o número poderá ter, no máximo, 15 dígitos sendo 2
deles a identificação da parte fracionária. A parte fracionária não
é obrigatória quando assim definido;
o Quando for data, não haverá definição de tamanho.

CAMPO TIPO TAM. DESCRIÇÃO


tsNumeroNfse N 15 Número da Nota Fiscal de Serviço Eletrônica,
formado pelo ano com 04 (quatro) dígitos e um número
sequencial com 11 posições – Formato
AAAANNNNNNNNNNN
tsCodigoVerificacao C 9 Código de verificação do número da nota
tsStatusRps N 1 Código de status do RPS
1 – Normal
2 – Cancelado
tsStatusNfse N 1 Código de status da NFS-e
1 – Normal
2 – Cancelado
Nota Fiscal de Serviços Eletrônica – NFSE Página 23 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tsNaturezaOperacao N 2 Código de natureza da operação


1 – Tributação no município
2 - Tributação fora do município
3 – Isenção
4 – Imune
5 – Exigibilidade suspensa por decisão judicial
6 – Exigibilidade suspensa por procedimento
administrativo
tsRegimeEspecialTributacao N 2 Código de identificação do regime especial de
tributação
1 – Microempresa municipal
2 – Estimativa
3 – Sociedade de profissionais
4 – Cooperativa
5 – Microempresário Individual (MEI)
6 – Microempresário e Empresa de Pequeno Porte
(ME EPP)
7 – Tributação por Faturamento (Variável)
8 – Fixo
9 – Isenção
10 – Imune
11 – Exigibilidade suspensa por decisão judicial
12 – Exigibilidade suspensa por procedimento
administrativo
tsSimNao N 1 Identificação de Sim/Não
1 – Sim
2 – Não
tsQuantidadeRps N 4 Quantidade de RPS do Lote
tsNumeroRps N 15 Número do RPS
tsSerieRps C 5 Número de série do RPS
tsTipoRps N 1 Código de tipo de RPS
1 – RPS
2 – Nota Fiscal Conjugada (Mista)
3 – Cupom
tsOutrasInformacoes C 255 Informações adicionais ao documento
tsValor N 15,2 Valor monetário.
Formato: 0,000.00 (ponto separando casa decimal, vírgula
separando casa do milhar)

tsItemListaServico C 5 Código de item da lista de serviço


tsCodigoCnae N 7 Código CNAE
tsCodigoTributacao C 20 Código de Tributação
tsAliquota N 5,4 Valor percentual
tsDiscriminacao C 200 Discriminação do conteúdo da NFS-e
tsCodigoMunicipioIbge N 7 Código de identificação do município conforme tabela do
IBGE. Caso seja de fora do país, colocar 99999.
tsIncricaoMunicipal C 15 Número de inscrição municipal
tsInscricaoEstadual C 20 Número de Inscrição Estadual
tsRazaoSocial C 115 Razão Social do contribuinte
tsNomeFantasia C 115 Nome fantasia do contribuinte
tsCnpj C 14 CNPJ do contribuinte
tsEndereco C 125 Endereço do contribuinte
tsNumeroEndereco C 10 Número do endereço
tsComplementoEndereco C 60 Complemento de endereço
tsBairro C 60 Bairro do contribuinte
tsUf C 2 Sigla da unidade federativa. Caso seja de fora do país,
Nota Fiscal de Serviços Eletrônica – NFSE Página 24 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

colocar EX.
tsCep N 8 Número do CEP do contribuinte
tsEmail C 80 E-mail do contribuinte
tsTelefone C 15 Telefone do contribuinte
tsCpf C 11 CPF do contribuinte
tsIndicacaoCpfCnpj N 1 Indicador de uso de CPF ou CNPJ

Nota Fiscal de Serviços Eletrônica – NFSE Página 25 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

1 – CPF
2 – CNPJ
3 – Não Informado
tsCodigoObra C 15 Código de Obra
tsArt C 15 Código ART
tsNumeroLote N 15 Número do Lote de RPS
tsNumeroProtocolo C 50 Número do protocolo de recebimento do RPS
tsSituacaoLoteRps N 1 Código de situação de lote de RPS
1 – Não Recebido
2 – Não Processado
3 – Processado com Erro
4 – Processado com Sucesso
tsCodigoMensagemAlerta C 4 Código de mensagem de retorno de serviço
tsDescricaoMensagemAlerta C 200 Descrição da mensagem de retorno de serviço
tsCodigoCancelamentoNfse C 4 Motivo do Cancelamento da NFS-e
1 – Lançamento Indevido
2 – Erro de digitação
tsIdTag C 255 Atributo de identificação da tag a ser assinada no
documento XML
P1 C 14 CNPJ do contribuinte, apenas número.
P2 C 20 Senha do contribuinte
tsLink C 200 Disponibilizado para a impressão da NFS-e. “Em breve”

3.4. TIPOS COMPLEXOS

A seguir serão detalhadas as tabelas de cada tipo composto e seus campos. A


tabela está dividida da seguinte forma:
(1) – (2)
CAMPO TIPO TAM. DESCRIÇÃO OC.
(3) (4) (5) (6) (7) (8)
(4) (5) (6) (7) (8)

1. Nome do tipo complexo;


2. Descrição do tipo complexo;
3. Identifica se a sequência de campos fará parte de uma escolha (Choice);
4. Nome do campo que faz parte do tipo complexo;
5. Tipo do campo, que pode ser de um tipo simples ou complexo;
6. Tamanho do campo. Quantidade máxima de caracteres ou precisão numérica,
dependendo do tipo de informação.
7. Descrição do campo.
8. Ocorrência. Número de vezes que a informação pode ser apresentada.
0-1 – Não obrigatório

Nota Fiscal de Serviços Eletrônica – NFSE Página 26 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

0-N – Não obrigatório, mas pode ser apresentada muitas


vezes 1-1 – Obrigatório.
1-2 – Obrigatório, pode ser apresentada uma ou duas vezes.
1-N – Obrigatório, pode ser apresentada uma ou mais vezes.

TABELAS PARA TIPOS COMPLEXOS


tcCpfCnpj – Representa CPF/CNPJ.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Choice Cpf C 11 Número do Cpf. 1-1
Cnpj C 14 Número do Cnpj. 1-1

tcEndereco – Conjunto de dados de identificação completa do endereço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Endereco C 125 Endereço. 0-1
Numero C 10 Número do endereço. 0-1
Complemento C 60 Complemento do Endereço. 0-1
Bairro C 60 Nome do bairro. 0-1
CodigoMunicipio N 7 Código de identificação do município conforme tabela do 0-1
IBGE.
Uf C 2 Sigla da unidade federativa. 0-1
Cep C 8 Número do CEP. 0-1

tcContato – Representa forma de contato com a pessoa (física/jurídica).


CAMPO TIPO TAM. DESCRIÇÃO OC.
Telefone C 11 Telefone para contato. 0-1
Email C 80 E-mail para contato. 0-1

tcIdentificacaoOrgaoGerador – Conjunto de dados de identificação de órgão gerador.


CAMPO TIPO TAM. DESCRIÇÃO OC.
CodigoMunicipio N 7 Código de identificação do município conforme tabela do 1-1
IBGE.
Uf C 2 Sigla da unidade federativa. 1-1

tcIdentificacaoRps – Conjunto de dados de identificação do RPS.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Numero N 15 Número do RPS. 1-1
Serie C 5 Número de série do RPS. 1-1
Tipo N 1 Código de tipo de RPS. 1-1
1 – RPS
2 – Nota Fiscal Conjugada (Mista)
3 – Cupom

tcIdentificacaoPrestador – Conjunto de dados de identificação do prestador de serviço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Cnpj C 14 Número do CNPJ do prestador. 1-1
InscricaoMunicipal C 15 Número de Inscrição Municipal do prestador. 0-1

Nota Fiscal de Serviços Eletrônica – NFSE Página 27 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tcIdentificacaoTomador – Conjunto de dados de identificação do tomador de serviço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
CpfCnpj tcCpfCnpj Caso Tomador não identificado, preencher com 11 1-1
zeros.
InscricaoMunicipal C 15 Número de Inscrição Municipal do tomador. 0-1
InscricaoEstadual C 20 Número de Inscrição Estadual do tomador. 0-1

tcDadosTomador – Conjunto de dados do tomador de serviço.


TIP
CAMPO O TAM. DESCRIÇÃO OC.
IdentificacaoTomador tcIdentificacaoTomador Conjunto de dados de identificação do 1-1
tomador de serviço.
RazaoSocial C 115 Razão Social do tomador. 0-1
Endereco tcEndereco Conjunto de dados de identificação 0-1
completa do endereço.
Se tomador for jurídico, preencher
todos os campos do endereço.
Caso contrário, preencher apenas o
campo Razão Social.
Contato tcContato Representa forma de contato com a 0-1
pessoa (física/jurídica).

tcIdentificacaoIntermediarioServico – Conjunto de dados de identificação do intermediário do


serviço.
CAMPO TIPO TAM. DESCRIÇÃO OC.
RazaoSocial C 115 Razão Social do intermediário. 1-1
CpfCnpj tcCpfCnpj Representa CPF/CNPJ do intermediário. 1-1
InscricaoMunicipal C 15 Número de Inscrição Municipal do intermediário. 0-1

tcValores – Conjunto de valores que compõe o documento fiscal.


CAMPO TIPO TAM. DESCRIÇÃO OC.
ValorServicos N 15,2 Valor dos serviços em R$. 1-1
ValorDeducoes N 15,2 Valor das deduções para Redução da Base de Cálculo 0-1
em R$.
ValorPis N 15,2 Valor da retenção do PIS em R$. Informação 0-1
declaratória.
ValorCofins N 15,2 Valor da retenção do COFINS em R$. Informação 0-1
declaratória.
ValorInss N 15,2 Valor da retenção do INSS em R$. Informação 0-1
declaratória.
ValorIr N 15,2 Valor da retenção do IR em R$. Informação 0-1
declaratória.
ValorCsll N 15,2 Valor da retenção do CSLL em R$. Informação 0-1
declaratória.
IssRetido N 1 1 – Sim; 2 – Não 1-1
Caso “Sim”, o valor do IssRetido dever ser igual ao
ValorIss e exibir o ValorIssRetido.
Caso “Não”, não exibir ValorIssRetido.
ValorIss N 15,2 Valor do ISS. 0-1
OutrasRetencoes N 15,2 Valor de outras retenções. 0-1
BaseCalculo N 15,2 (Valor dos serviços – Valor das deduções – descontos 0-1
incondicionados).
Aliquota N 15,2 Valor percentual. 0-1

Nota Fiscal de Serviços Eletrônica – NFSE Página 28 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

ValorLiquidoNfse N 15,2 (ValorServicos – ValorPIS – ValorCOFINS – 0-1


ValorINSS – ValorIR – ValorCSLL – utrasRetençoes –
ValorISSRetido - DescontoIncondicionado -
DescontoCondicionado).
ValorIssRetido N 15,2 Valor do ISS Retido. 0-1
DescontoCondicionado N 15,2 Valor do Desconto Condicionado. 0-1
DescontoIncondicionado N 15,2 Valor do Desconto Incondicionado. 0-1

tcDadosServico – Conjunto de dados que compõe o serviço prestado.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Valores tcValores Conjunto de valores que compõe o 1-1
documento fiscal.
ItemListaServico C 5 Código de item da lista de serviço. 1-1
CodigoCnae N 7 Código CNAE. 0-1
CodigoTributacaoMunicipio C 20 Código de Tributação. 1-1
Discriminacao C 200 Discriminação do conteúdo da NFS-e. 1-1
CodigoMunicipio N 7 Código de identificação do município 1-1
conforme tabela do IBGE. Preencher com 5
noves para serviço prestado no exterior.
ItensServico tcItemServico 1-N

tcDadosConstrucaoCivil – Conjunto de dados para identificação de construção civil.


CAMPO TIPO TAM. DESCRIÇÃO OC.
CodigoObra C 15 Código de Obra. 1-1
Art C 15 Código ART. 1-1

tcDadosPrestador – Conjunto de dados do prestador do serviço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
IdentificacaoPrestador tcIdentificacao Conjunto de dados de identificação do prestador 1-1
Prestador de serviço.
RazaoSocial C 115 Razão Social do prestador. 1-1
NomeFantasia C 115 Nome Fantasia do prestador. 0-1
Endereco tcEndereco Conjunto de dados de identificação completa do 1-1
endereço.
Contato tcContato Representa forma de contato com a pessoa 0-1
(física/jurídica).

tcInfRps – Conjunto de dados informativos do Recibo Provisório de Serviço (RPS).


CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a ser
assinada no documento XML.
IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificação 1-1
do RPS.
DataEmissao D Data da Emissão. 1-1
Formato AAAA-MM-DDTHH:mm:ss
NaturezaOperacao N 2 Código de natureza da operação. 1-1
1 – Tributação no município
2 – Tributação fora do município
3 – Isenção
4 – Imune
5 – Exigibilidade suspensa por
decisão judicial
6 – Exigibilidade suspensa por
Nota Fiscal de Serviços Eletrônica – NFSE Página 29 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

procedimento administrativo
RegimeEspecialTributacao N 2 Código de identificação do regime 0-1
especial de tributação.
1 – Microempresa municipal
2 – Estimativa
3 – Sociedade de profissionais
4 – Cooperativa
5 – Microempresário Individual (MEI)
6 – Microempresário e Empresa de
Pequeno Porte (ME EPP)
OptanteSimplesNacional N 1 Identificação de Sim/Não 1-1
1 – Sim; 2 – Não
IncentivadorCultural N 1 Identificação de Sim/Não 1-1
1 – Sim; 2 – Não
Status N 1 Código de status do RPS 1-1
1 – Normal; 2 – Cancelado
RpsSubstituido tcIdentificacaoRps Conjunto de dados de identificação 0-1
do RPS.
OutrasInformacoes C 255 Informações Adicionais ao 0-1
Documento.
Servico tcDadosServico Conjunto de dados que compõe o 1-1
serviço prestado.
Prestador tcIdentificacaoPrest Conjunto de dados de identificação 1-1
ador do prestador de serviço.
Tomador tcDadosTomador Conjunto de dados do tomador de 1-1
serviço.
IntermediarioServico tcIdentificacaoInter Conjunto de dados de identificação 0-1
mediarioServico do intermediário do serviço.
ConstrucaoCivil tcDadosContrucao Conjunto de dados para identificação 0-1
Civil de construção civil.

tcRps – Representa a estrutura do Recibo Provisório de Serviço (RPS) assinada.


CAMPO TIPO TAM. DESCRIÇÃO OC.
InfRps tcInfRps Conjunto de dados informativos do Recibo 1-1
Provisório de Serviço (RPS).
Signature dsig:Signature 0-1

tcIdentificacaoNfse – Representa dados que identificam uma Nota Fiscal de Serviços Eletrônica.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Numero N 15 Número da Nota Fiscal de Serviço Eletrônica - 1-1
Formato AAAANNNNNNNNNNN.
Cnpj C 14 CNPJ. 1-1
InscricaoMunicipal C 15 Número de inscrição municipal. 0-1
CodigoMunicipio N 7 Código de identificação do município conforme 1-1
tabela do IBGE.

tcInfNfse – Representa os dados informativos da Nota Fiscal de Serviços Eletrônica.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a ser 1-1
assinada no documento XML.
Numero N 15 Número da Nota Fiscal de Serviço 1-1
Eletrônica - Formato
AAAANNNNNNNNNNN.

Nota Fiscal de Serviços Eletrônica – NFSE Página 30 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

CodigoVerificacao C 9 Código de verificação do número da 1-1


nota.
DataEmissao D Data e Hora da Emissão. 0-1
Formato AAAA-MM-DDTHH:mm:ss
IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificação 0-1
do RPS.
DataEmissaoRps D Data da Emissão do RPS. 1-1
Formato: AAAA-MM-DD
NaturezaOperacao N 2 Código de natureza da operação 0-1
1 – Tributação no município
2 – Tributação fora do município
3 – Isenção
4 – Imune
5 – Exigibilidade suspensa por
decisão judicial
6 – Exigibilidade suspensa por
procedimento administrativo
RegimeEspecialTributacao N 2 Código de identificação do regime 1-1
especial de tributação
1 – Microempresa municipal
2 – Estimativa
3 – Sociedade de profissionais
4 – Cooperativa
5 – Microempresário Individual (MEI)
6 – Microempresário e Empresa de
Pequeno Porte (ME EPP)
OptanteSimplesNacional N 1 Identificação de Sim/Não 1-1
1 – Sim
2 – Não
IncetivadorCultural N 1 Identificação de Sim/Não 1-1
1 – Sim
2 – Não
Competencia D Formato: AAAA-MM-DD 0-1
NfseSubstituida N 15 Número da Nota Fiscal de Serviço 1-1
Eletrônica - Formato
AAAANNNNNNNNNNN.
Servico tcDadosServico Conjunto de dados que compõe o 0-1
serviço prestado.
ValorCredito N 15,2 Valor monetário. 1-1
Formato: 0,000.00 (ponto separando
casa decimal, vírgula separando
casa do milhar)
PrestadorServico tcDadosPrestador Conjunto de dados do prestador do 1-1
serviço.
TomadorServico tcDadosTomador Conjunto de dados do tomador de 0-1
serviço.
IntermediarioServico tcIdentificacaoInter Conjunto de dados de identificação 1-1
mediarioServico do intermediário do serviço.
OrgaoGerador tcIdentificacaoOrga Conjunto de dados de identificação 0-1
oGerador de órgão gerador.
ConstrucaoCivil tcDadosContrucao Conjunto de dados para identificação 1-1
Civil de construção civil.

Nota Fiscal de Serviços Eletrônica – NFSE Página 31 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tcNfse – Representa a estrutura da Nota Fiscal de Serviços Eletrônica assinada.


CAMPO TIPO TAM. DESCRIÇÃO OC.
InfNfse tcInfNfse Representa os dados informativos da Nota Fiscal 1-1
de Serviços Eletrônica.
Signature Dsig:Signature 1-2

tcInfPedidoCancelamento – Representa a estrutura de dados do pedido de cancelamento


enviado pelo prestador ao cancelar uma Nota Fiscal de Serviços Eletrônica.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a ser
assinada no documento XML.
IdentificacaoNfse tcIdentificacaoNfse Representa dados que identificam uma 1-1
Nota Fiscal de Serviços Eletrônica.
CodigoCancelamento C 4 Código de cancelamento com base na 0-1
tabela de Erros e alertas.

tcPedidoCancelamento – Representa a estrutura de Pedido de Cancelamento da Nota Fiscal


de Serviços Eletrônica assinada.
CAMPO TIPO TAM. DESCRIÇÃO OC.
InfPedidoCancelamento tcIdentificacaoNfse Representa dados que identificam uma 1-1
Nota Fiscal de Serviços Eletrônica.
Signature Dsign:Signature 1-1

tcInfConfirmacaoCancelamento – Representa a estrutura de dados da confirmação de


cancelamento da Nota Fiscal de Serviços Eletrônica feito pelo Fisco Municipal.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Sucesso boolean Sucesso da operação. 1-1
DataHora D Data e hora. 1-1
Formato AAAA-MM-DDTHH:mm:ss

tcConfirmacaoCancelamento – Representa a estrutura de Confirmação de Cancelamento da


Nota Fiscal de Serviços Eletrônica assinada.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a
ser assinada no documento XML.
Pedido tcPedidoCancelamen Representa a estrutura de Pedido 1-1
to de Cancelamento da Nota Fiscal
de Serviços Eletrônica assinada.
InfConfirmacaoCancelamento tcInfConfirmacaoCan Representa a estrutura de dados 1-1
celamento da confirmação de cancelamento
da Nota Fiscal de Serviços
Eletrônica feito pelo Fisco
Municipal.

tcCancelamentoNfse – Representa os dados de registro de substituição de NFS-e.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Confirmacao tcConfirmacaoCance Representa a estrutura de
lamento Confirmação de Cancelamento da
Nota Fiscal de Serviços
Eletrônica assinada.
Signature Dsig:Signature 1-1
Nota Fiscal de Serviços Eletrônica – NFSE Página 32 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tcInfSubstituicaoNfse - Representa a estrutura completa (pedido + confirmação) de


cancelamento de NFS-e.
CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a ser assinada
no documento XML.
NfseSubstituidora N 15 Número da Nota Fiscal de Serviço Eletrônica - 1-1
Formato AAAANNNNNNNNNNN.

tcSubstituicaoNfse – Representa a estrutura de substituição de NFS-e.


CAMPO TIPO TAM. DESCRIÇÃO OC.
SubstituicaoNfse tcInfSubstituicaoNfse Representa a estrutura completa 1-1
(pedido + confirmação) de
cancelamento de NFS-e.
Signature dsig:Signature 1-2

tcCompNfse – Representa a estrutura de compartilhamento de dados de uma NFS-e.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Nfse tcNfse Representa a estrutura da Nota Fiscal de 1-1
Serviços Eletrônica assinada.
NfseCancelamento tcCancelamentoNfse Representa os dados de registro de 0-1
substituição de NFS-e.
NfseSubstituicao tcSubstituicaoNfse Representa a estrutura de substituição de 0-1
NFS-e.

ListaMensagemRetorno – Representa a estrutura de mensagem de retorno de serviço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
MensagemRetorno tcMensagemRetorno Representa a estrutura de mensagem de 1-N
retorno de serviço.

tcMensagemRetornoLote – Representa a estrutura de mensagem de retorno de serviço.


CAMPO TIPO TAM. DESCRIÇÃO OC.
IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificação 1-1
do RPS.
Codigo C 4 Código de mensagem de retorno 1-1
de serviço.
Mensagem C 200 Descrição da mensagem de retorno 1-1
de serviço.

tcLoteRps – Conjunto de dados para a identificação do Lote RPS.


CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a ser assinada no
documento XML.
NumeroLote N 15 Número do Lote de RPS. 1-1
Cnpj C 14 CNPJ do contribuinte. 1-1
InscricaoMunicipal C 15 Número de Inscrição Municipal. 1-1
QuantidadeRps N 4 Quantidade de RPS do Lote. 1-1
ListaRps tcRps Representa a estrutura do Recibo Provisório de 1-N
Serviço (RPS) assinada.

Nota Fiscal de Serviços Eletrônica – NFSE Página 33 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tcItemServico
CAMPO TIPO TAM. DESCRIÇÃO OC.
Descricao C 200 Descrição do serviço. 1-1
Quantidade N 7 Quantidade de itens. 1-1
ValorUnitario N 15,2 Valor unitário de cada serviço. 1-1

ddDuasStrings
CAMPO TIPO TAM. DESCRIÇÃO OC.
P1 P1 14 CNPJ do contribuinte, apenas números. 1-1
P2 P2 20 Senha do contribuinte. 1-1

tcInfNovaNfse – Conjunto de dados de descrição da NFS-e


CAMPO TIPO TAM. DESCRIÇÃO OC.
Id C 255 Atributo de identificação da tag a
ser assinada no documento XML.
NaturezaOperacao N 2 Código de natureza da operação. 1-1
1 – Tributação no município
2 – Tributação fora do município
3 – Isenção
4 – Imune
5 – Exigibilidade suspensa por
decisão judicial
6 – Exigibilidade suspensa por
procedimento administrativo
RegimeEspecialTributacao N 2 Código de identificação do regime 0-1
especial de tributação
1 – Microempresa municipal
2 – Estimativa
3 – Sociedade de profissionais
4 – Cooperativa
5 – Microempresário Individual
(MEI)
6 – Microempresário e Empresa
de Pequeno Porte (ME EPP)
OptanteSimplesNacional N 1 Identificação de Sim/Não 1-1
1 – Sim
2 – Não
IncetivadorCultural N 1 Identificação de Sim/Não 1-1
1 – Sim
2 – Não
Status N 1 Código de status da NFS-e 1-1
1 – Normal
2 – Cancelado
Competencia D Formato: AAAA-MM-DD 1-1
NfseSubstituida N 15 Número da Nota Fiscal de 0-1
Serviço Eletrônica - Formato
AAAANNNNNNNNNNN.
OutrasInformacoes C 255 Informações adicionais ao 0-1
documento.
Servico tcDadosServico Conjunto de dados que compõe o 1-1
serviço prestado.
Tomador tcDadosTomador Conjunto de dados do tomador de 1-1
serviço.
IntermediarioServico tcIdentificacaoIntermedi Conjunto de dados de 0-1

Nota Fiscal de Serviços Eletrônica – NFSE Página 34 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

arioServico identificação do intermediário do


serviço.
ConstrucaoCivil tcDadosConstrucaoCivil Conjunto de dados para 0-1
identificação de construção civil.

tcIdentNovaNfse – Identificação da NFS-e


CAMPO TIPO TAM. DESCRIÇÃO OC.
IdentificacaoPrestador tcIdentificacaoPrestador Conjunto de dados de identificação 1-1
do prestador de serviço.
Numero N 15 Número da NFS-e. 1-1
Serie C 5 Número de série da nota. 1-1
CodigoVerificacao C 9 Código de verificação do número 1-1
da nota.
DataEmissao D Data da Emissão. 1-1
Formato AAAA-MM-DDTHH:mm:ss
Link C 200 Disponibilizado para a impressão 0-1
da NFS-e.

tcRespostaIdentNovaNfse - Representa a estrutura de mensagem de retorno da NFS-e


CAMPO TIPO TAM. DESCRIÇÃO OC.
IdentificacaoNfse tcIdentNovaNfse Identificação da NFS-e 1-1
Signature dsig:Signature 0-1

3.5. SERVIÇOS

A seguir estão os serviços disponíveis, conforme descritos no item 2.1, no Web


Service e seus XML Schema. O XML Schema define a estrutura e formatação do arquivo
XML que conterá os dados a serem trafegados. Esses documentos serão enviados de
forma textual (como uma string) como parâmetros do serviço oferecido pelo Web Service,
como descrito em 2.2.1.
As tabelas que detalham cada XML Schema estão divididas da seguinte forma:
# NOME TIPO PAI DESCRIÇÃO OC.
(1) (2) (3) (4) (5) (6)
(7) (8)

1. Número identificador do campo, quando este contiver subitens;


2. Nome do campo;
3. Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo;
4. Indica quem é o campo pai, para definição da hierarquia;
5. Descreve alguma observação pertinente;
6. Quantas vezes o campo se repete na estrutura de dados:
Nota Fiscal de Serviços Eletrônica – NFSE Página 35 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

a. Formato: “z-y” onde “x” é a quantidade mínima e “y” a quantidade máxima.


Se a quantidade máxima for indefinida, será utilizado “N” no lugar do “y”;
7. Formato de grupo, utilizado para definição de uma escolha (ver próximo item);
8. Identifica os campos ou grupos que farão parte de uma escolha (Choice).

3.5.1. Versão do Sistema

Método: Versao

Esse serviço será executado através da chamada do método Versao, não sendo

necessária a passagem de parâmetros. O serviço retorna uma cadeia de caractere com

a identificação da versão do sistema. O serviço também pode ser utilizado para verificar

a conectividade.

3.5.2. Recepção de Lote RPS

Método: RecepcionarLoteRps
Esse serviço será executado, inicialmente, através da chamada ao método
RecepcionarLoteRps, passando a mensagem XML como parâmetro com a estrutura
definida na tabela que segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 EnviarLoteRpsEnvio 1-1
LoteRps tcLoteRps 1 Conjunto de dados para a identificação do 1-1
Lote RPS.
Signature dsig:Signature 1 0-1
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Nota Fiscal de Serviços Eletrônica – NFSE Página 36 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Utilização do Método
Inicialmente a Signature e Id não estão sendo usados, tendo como segundo
parâmetro ddDuasStrings.

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela


a seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 EnviarLoteRps 1-1
Resposta
NumeroLote N 1 Número da Nota Fiscal de Serviço Choice 1-1
Eletrônica - Formato
AAAANNNNNNNNNNN.
DataRecebime D 1 Data e hora.
nto Formato AAAA-MM-DDTHH:mm:ss
Protocolo C 1 Número do protocolo de recebimento do

Nota Fiscal de Serviços Eletrônica – NFSE Página 37 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

RPS.
2 ListaMensage ListaMensagem 1 Representa a estrutura de mensagem de 1-1
mRetorno Retorno retorno de serviço.

O lote será processado posteriormente, sendo o seu resultado disponibilizado para


consulta.
Utilização do Método

3.5.3. Consulta de Situação de Lote de RPS


Método: ConsultarSituacaoLoteRps
Esse serviço será executado através da chamada ao método
ConsultarSituacaoLoteRps, passando a mensagem XML como parâmetro com a
estrutura definida na tabela que segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarSituacaoLoteRpsEnvio 1-1
Prestador tcIdentificacao 1 Conjunto de dados de identificação 1-1
Prestador do prestador de serviço.
Protocolo C 1 Número do protocolo de 1-1
recebimento do RPS
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Nota Fiscal de Serviços Eletrônica – NFSE Página 38 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Utilização do Método

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a


seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarSituacaoLo 1-1
teRpsResposta
NumeroLote N 1 Número do Lote de RPS Choice 1-1
Situação N 1 Código de situação de lote de RPS
1 – Não Recebido
2 – Não Processado
3 – Processado com Erro
4 – Processado com Sucesso
2 ListaMensagemRetor ListaMensagem 1 Representa a estrutura de 1-1
no Retorno mensagem de retorno de serviço.

Utilização do Método

3.5.4. Consulta de NFS-e por RPS

Método: ConsultarNfsePorRps

Esse serviço será executado através da chamada ao método


ConsultarNfsePorRps, passando a mensagem XML como parâmetro com a estrutura
definida na tabela que segue.

Nota Fiscal de Serviços Eletrônica – NFSE Página 39 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

# CAMPO TIPO PAI DESCRIÇÃO OC.


1 ConsultarNfseRpsEnvio
IdentificacaoRps tcIdentificacao 1 Conjunto de dados de identificação do 1-1
Rps RPS.
Prestador tcIdentificacao 1 Conjunto de dados de identificação do 1-1
Prestador prestador de serviço.
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Utilização do Método

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a


seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarNfseRps
Resposta
CompNfse tcCompNfse 1 Representa a estrutura de Choice 1-1
compartilhamento de dados de uma
NFS-e.
2 ListaMensagemR ListaMensagem 1 Representa a estrutura de mensagem 1-1
etorno Retorno de retorno de serviço.

Nota Fiscal de Serviços Eletrônica – NFSE Página 40 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Utilização do Método

3.5.5. Consulta de NFS-e


Método: ConsultarNfse

Esse serviço será executado através da chamada ao método ConsultarNfse,


passando a mensagem XML como parâmetro com a estrutura definida na tabela que
segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarNfseEnvio 1-1
Prestador tcIdentificacaoPrestador 1 Conjunto de dados de identificação 1-1
do prestador de serviço.
Nota Fiscal de Serviços Eletrônica – NFSE Página 41 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

NumeroNfse N 1 Número da Nota Fiscal de Serviço 0-1


Eletrônica - Formato
AAAANNNNNNNNNNN.
2 PeriodoEmissao PeriodoEmissao 1 0-1
DataInicial D 1 Data inicial da consulta Nfse. 1-1
Formato: AAAA-MM-DD
DataFinal D 1 Data final da consulta Nfse. 1-1
Tomador tcIdentificacaoTomador 1 Conjunto de dados de identificação 1-1
do tomador de serviço.
IntermediarioServico tcIdentificacaoIntermedi 1 Conjunto de dados de identificação 0-1
arioServico do intermediário do serviço.
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Utilização do Método

Nota Fiscal de Serviços Eletrônica – NFSE Página 42 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a


seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarNfse 1-1
Resposta
2 ListaNfse 1 Choice 1-1
CompNfse tcCompNfse 2 Representa a estrutura de 0-N
compartilhamento de dados de uma NFS-e.
3 ListaMensage ListaMensage 1 Representa a estrutura de mensagem de 1-1
mRetorno mRetorno retorno de serviço.

Utilização do Método

3.5.6. Consulta de Lote de RPS

Método: ConsultarLoteRps

Esse serviço será executado através da chamada ao método ConsultarLoteRps,


passando a mensagem XML como parâmetro com a estrutura definida na tabela que
segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarLoteRpsEnvio 1-1
Prestador tcIdentificacaoPrest 1 Conjunto de dados de 1-1
ador identificação do prestador de
serviço.
Protocolo C 1 Número do protocolo de 1-1
recebimento do RPS
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os

Nota Fiscal de Serviços Eletrônica – NFSE Página 43 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

RPS foram convertidos e especificado na propriedade


pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Utilização do Método

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela


a seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 ConsultarLoteRps 1-1
Resposta
2 ListaNfse 1 Choice 1-1
CompNfse tcCompNfse 2 Representa a estrutura de 1-N
compartilhamento de dados de uma NFS-
e.
3 ListaMensagemR ListaMensag 1 Representa a estrutura de mensagem de 1-1
etorno emRetorno retorno de serviço.

Utilização do Método

Nota Fiscal de Serviços Eletrônica – NFSE Página 44 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

tcCancelamentoNfse será exibido quando um arquivo RPS retornado for cancelado.


tcSubstituicaoNfse será exibido quando um arquivo RPS retornado for substituído.

3.5.7. Cancelamento NFS-e

Método: CancelarNfse
Esse serviço será executado através da chamada ao método CancelarNfse,
passando a mensagem XML como parâmetro com a estrutura definida na tabela que
segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 CancelarNfseEnvio 1-1
Pedido tcPedidoCancelamento 1 Representa a estrutura de Pedido 1-1
de Cancelamento da Nota Fiscal
de Serviços Eletrônica assinada.
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Utilização do Método

* Campos não obrigatórios.


Nota Fiscal de Serviços Eletrônica – NFSE Página 45 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a


seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 CancelarNfse
Resposta
Cancelamento tcCancelamento 1 Representa os dados de registro de Choice 1-1
Nfse substituição de NFS-e.
2 ListaMensage ListaMensagem 1 Representa a estrutura de mensagem de 1-1
mRetorno Retorno retorno de serviço.

Utilização do Método

* Campos não obrigatórios.

3.5.8. Gerar NFS-e

Método: GeraNfse

Esse serviço será executado, inicialmente, através da chamada ao método


GerarNfse, passando a mensagem XML como parâmetro com a estrutura definida na
tabela que segue.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 GerarNovaNfseEnvio 1-1
2 Prestador tcIdentificacaoPrest 1 Conjunto de dados de identificação do 1-1
ador prestador de serviço.
2 InformacaoNfse tcInfNovaNfse 1 Conjunto de dados de descrição da NFS- 1-1
e
Servico tcDadosServico 2 Conjunto de dados que compõe o serviço 1-1
prestado.
Tomador tcDadosTomador 2 Conjunto de dados do tomador de 1-1
serviço.
IntermediarioServico tcIdentificacaoInter 2 Conjunto de dados de identificação do 0-1

Nota Fiscal de Serviços Eletrônica – NFSE Página 46 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

mediarioServico intermediário do serviço.


ConstrucaoCivil tcDadosContrucao 2 Conjunto de dados para identificação de 0-1
Civil construção civil.
Signature dsig:Signature 1 0-1
2 pParam ddDuasStrings 1-1

Número máximo de cem notas vão ser consultada de cada vez a partir do número
passado no parâmetro pConsultarNfseEnvio.NumeroNfse dentro do período em que os
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico são
opcionais na pesquisa se não houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).

Utilização do Método
Inicialmente a Signature e Id não estão sendo usados, tendo como segundo
parâmetro ddDuasStrings.

Nota Fiscal de Serviços Eletrônica – NFSE Página 47 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Em resposta a chamada do serviço será devolvida a estrutura definida na tabela a


seguir.
# CAMPO TIPO PAI DESCRIÇÃO OC.
1 GerarNovaNfse
Resposta
NovaNfse tcRespostaIdent 1 Representa a estrutura de mensagem Choice 1-1
NovaNfse de retorno da NFS-e.
2 ListaMensagem ListaMensagem 1 Representa a estrutura de mensagem 1-1
Retorno Retorno de retorno de serviço.

Utilização do Método

Nota Fiscal de Serviços Eletrônica – NFSE Página 48 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

4. ANEXOS

4.1. TABELA DE ERROS

CÓD MENSAGEM SOLUÇÃO


E1 Assinatura do Hash não confere. Reenvie assinatura do Hash conforme algoritmo
estabelecido no Manual de Instrução da NFS-e.
E2 Mês de competência superior ao de Informe um mês de competência inferior ou igual ao
emissão do RPS ou da Nota. de emissão do RPS ou da Nota.
E3 Natureza da operação não informada. Utilize um dos tipos: 01 – Tributação no município;
02 – Tributação fora do município; 03 – Isenção; 04 –
Imune; 05 – Exigibilidade suspensa por decisão
judicial; 06 – Exigibilidade suspensa por rocedimento
administrativo.
E4 Esse RPS não foi enviado para a nossa Envie o RPS para emissão da NFS-e.
base de dados.
E5 O número da NFS-E substituída informado Informe um número de NFS-E substituída que já
não existe na base de dados do município. tenha sido emitida.
E6 Essa NFS-e não pode ser cancelada O cancelamento de uma NFS-e com crédito deve
através desse serviço, pois há crédito ser feito através de processo administrativo aberto
Informado. em uma repartição fazendária.
E7 Essa NFS-e já foi substituída. Confira e informe novamente os dados da NFS-e
que deseja substituir.
E8 Campo de optante pelo simples nacional Utilize um dos tipos: 1 – Sim; 2 - Não.
não informado.
E9 Campo de incentivador cultural não Utilize um dos tipos: 1 – Sim; 2 - Não.
informado.
E10 RPS já informado. Para essa Inscrição Municipal/CNPJ já existe um
RPS informado com o mesmo número, série e tipo.
E11 Número do RPS não informado. Informe o número do RPS.
E12 Tipo do RPS não informado. Informe o tipo do RPS.
E13 Campo tipo do RPS inválido. Utilize um dos tipos especificados: 1 - RPS', 2 -
RPSC ou 3 - RPSM.
E14 Data da emissão do RPS não informada. Informe a Data da emissão do RPS no formato Date.
E15 Data da emissão do RPS inválida. Informe a Data da emissão do RPS no formato Date.
E16 A data da emissão do RPS não poderá ser Informe uma data de emissão de RPS válida.
superior à data de hoje.
E17 A data da emissão do RPS não poderá ser Informe uma data de emissão de RPS válida.
inferior à data de habilitação do prestador
para emissão da NFS-e.
E18 O valor dos serviços deverá ser superior a Não é permitido envio de valor de serviços igual a
R$ 0,00 (zero). zero.
E19 O valor das deduções deverá ser inferior ou Não é permitido valor de dedução superior ao valor
igual ao valor dos serviços. de serviços.
E20 O valor das deduções deverá ser superior Não é permitido valor de dedução inferior a zero
ou igual a R$ 0,00 (zero). (negativo).
E21 O valor dos descontos deverá ser inferior Não é permitido valor de desconto superior ao valor
ou igual ao valor dos serviços. de serviços.
E22 O valor dos descontos deverá ser superior Não é permitido valor de desconto inferior a zero
ou igual a R$ 0,00 (zero). (negativo).
E23 O valor do PIS deverá ser superior ou igual Não é permitido valor de retenção inferior a zero
a R$ 0,00 (zero). (negativo).
E24 O valor do Cofins deverá ser superior ou Não é permitido valor de retenção inferior a zero
igual a R$ 0,00 (zero). (negativo).
E25 O valor do INSS deverá ser superior ou Não é permitido valor de retenção inferior a zero
igual a R$ 0, 00 (zero). (negativo).

Nota Fiscal de Serviços Eletrônica – NFSE Página 49 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

E26 O valor do IR deverá ser superior ou igual a Não é permitido valor de retenção inferior a zero
R$ 0,00 (zero). (negativo).
E27 O valor da CSLL deverá ser superior ou Não é permitido valor de retenção inferior a zero
igual a R$ 0,00 (zero). (negativo).
E28 Item da lista de serviço informado é Consulte a legislação vigente para saber se o item
incompatível com a informação de optante informado permite a opção pelo simples nacional.
pelo simples nacional
E29 O código de serviço prestado não permite Altere o campo "ISS Retido" para: 2 (Nota Fiscal sem
retenção de ISS. ISS Retido).
E30 Item da lista de serviço inexistente. Consulte a legislação vigente para saber o item da
lista de serviço que deverá ser informado neste
campo.
E31 Item da lista de serviço não informado para Informe o item relativo ao serviço prestado nessa
a operação. operação.
E32 Código CNAE informado é incompatível Consulte a legislação vigente para saber se o código
com a informação de optante pelo simples informado permite a opção pelo simples nacional.
nacional
E33 Código CNAE inexistente. Consulte a legislação vigente para saber o código
CNAE que deverá ser informado neste campo.
E34 Código de tributação informado é Consulte a legislação vigente para saber se o código
incompatível com a informação de optante informado permite a opção pelo simples nacional.
pelo simples nacional.
E35 Código de tributação inexistente. Consulte a legislação vigente para saber o Código
de tributação que deverá ser informado neste
campo.
E36 Campo ISSRetido inválido. Utilize um dos tipos: 1 para ISS Retido ou 2 para ISS
não Retido.
E37 Apenas serviços tributados, no município Operações isentas, imunes ou com exigibilidade
ou fora, podem sofrer retenção de ISS. suspensa por decisão judicial ou procedimento
administrativo não podem sofrer retenção de ISS.
E38 Contribuintes enquadrados como Não faça a retenção do ISS nos casos de empresas
Microempresa Municipal, Estimativa, enquadradas como Microempresa Municipal,
Sociedade de Profissionais ou Incentivador Estimativa, Sociedade de Profissionais ou
Cultural não podem sofrer retenção de ISS. Incentivador Cultural.
E39 Apenas empresas tomadoras de serviços O CNPJ e/ou a Inscrição Municipal informada do
inscritas neste municipio podem efetuar tomador não foi encontrada na base de dados do
retenção de ISS. município, não sendo permitida a retenção. Acerte o
CNPJ e/ou Inscrição Municipal ou altere o campo
ISS Retido para 2 (Sem retenção de ISS).
E40 Valor do ISS retido não informado. O valor do ISS retido deve ser informado quando
o campo "IssRetido" for marcado com 1- Sim.
E41 O campo discriminação dos serviços não O preenchimento da discriminação dos serviços é
foi preenchido. obrigatório por lei, devendo ser preenchido
adequadamente.
E42 Código do município da prestação do Consulte a tabela do IBGE e utilize um dos tipos
serviço inválido. listados na tabela.
E43 Inscrição Municipal do prestador não Informe a inscrição municipal correta do prestador.
encontrada na base de dados do
município.
E44 CNPJ/CPF do prestador inválido. Informe o número do CNPJ/CPF correto do
prestador.
E45 CNPJ não encontrado na base de dados. Confira o numero do CNPJ informado. Caso esteja
correto, o prestador não está inscrito no município.
E46 CNPJ do prestador não informado. Informe o CNPJ do prestador.
E47 CPF/CNPJ do tomador inválido. Informe o CPF/CNPJ correto do tomador.
E48 O campo CPF/CNPJ do tomador deverá Preencher o campo CPF/CNPJ do Tomador com
ser preenchido com zeros quando for de zeros quando se tratar de tomador com CPF não
Nota Fiscal de Serviços Eletrônica – NFSE Página 50 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

CPF não-informado. informado.


E49 Lote de RPS com excesso de O serviço de validação de RPS é abortado quando
inconsistências. atinge o número de 50 inconsistências. Corrija os
erros e reenvie o lote de RPS.
E50 Inscrição Municipal do prestador inválida. Informe a inscrição municipal correta do prestador.
E51 Inscrição Municipal do tomador inválida Informe a inscrição municipal correta do tomador.
E52 O tomador de serviços informado é o Na emissão da NFS-e não é permitido que o
próprio prestador. prestador seja igual ao tomador.
E53 O campo Inscrição Municipal do tomador Para tomadores estabelecidos fora deste município
só deverá ser preenchido para tomadores não preencher inscrição municipal.
estabelecidos neste município.
E54 CNPJ do tomador (<CNPJ enviado>) está Informe a Inscrição Municipal do tomador vinculada
vinculado a mais de uma inscrição ao CNPJ informado.
municipal.
E55 Endereço do tomador (logradouro) não Corrija o endereço (logradouro) ou o CEP do
corresponde ao CEP informado. tomador do serviço.
E56 Campo endereço do tomador não O preenchimento do endereço (logradouro) é
informado (obrigatório para tomador com obrigatório para tomadores Pessoas Jurídicas
CNPJ). (com CNPJ).
E57 Bairro não corresponde ao CEP informado. Corrija o Bairro ou o CEP do tomador do serviço.
E58 Código do município do tomador não Corrija o código do município ou o CEP do
corresponde ao CEP informado. tomador do serviço.
E59 Campo cidade do tomador não informado O preenchimento da Cidade do Tomador é
(obrigatório para tomador com CNPJ). obrigatório para tomadores Pessoas Jurídicas
(com CNPJ).
E60 A cidade do tomador informada não foi Informe a cidade correta do tomador. No caso de
encontrada na base de dados da prefeitura. cidade do exterior (fora do país), informe o campo
com 99999.
E61 Sigla da UF do tomador não corresponde Corrija a sigla da UF ou o CEP do tomador do
ao CEP informado. serviço.
E62 Cep não existe na tabela DNE dos Informar o Cep correto.
Correios.
E63 Razão Social do intermediário do serviço Informe a razão social do intermediário do serviço.
não informada com CNPJ/CPF ou Inscrição
Municipal do intermediário informada.
E64 Inscrição Municipal do intermediário do Informe a Inscrição Municipal correta do
serviço inválida. intermediário do serviço.
E65 Inscrição Municipal do intermediário do Acerte a Inscrição Municipal ou o CNPJ/CPF do
serviço não esta vinculada ao CNPJ/CPF intermediário do serviço.
informado.
E66 CNPJ/CPF do Intermediário do Serviço Informe o CNPJ/CPF correto do intermediário do
invalido. serviço.
E67 Código da obra inválido. Informe o código da obra correto.
E68 Status do RPS inválido. Utilize um dos tipos:1 – Normal; 2 – Cancelado;
E69 Quantidade de RPS incorreta. Informe a quantidade de RPS correta.
E70 Inscrição Municipal do prestador Informe corretamente a Inscrição Municipal do
especificada no lote não confere com o prestador no lote e no RPS.
prestador informado no RPS.
E71 RPS em duplicidade no arquivo enviado. Remova do arquivo o registro de RPS excedente.
E72 Campo Quantidade de RPS informado O campo quantidade de RPS é numérico e deverá
incorretamente. ter tamanho máximo de 4 dígitos.
E73 Campo tipo do RPS inválido para o tipo de Utilize o tipo “RPS-C".
registro='3' (Cupons).
E74 Data de emissão da Nota Fiscal não está Utilize no cabeçalho do arquivo datas de emissão
compreendida entre <data inicio de da Nota Fiscal compreendidas entre a data início
emissão do lote> e <data fim de emissão de emissão do lote e a data fim de emissão do lote.
Nota Fiscal de Serviços Eletrônica – NFSE Página 51 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

do lote> conforme especificado no


cabeçalho do arquivo.
E75 Número do RPS substituído não informado Informe o número do RPS substituído.
para status do RPS igual a "S".
E76 O número do RPS substituído informado Informe o número do RPS substituído correto.
não existe na base de dados.
E77 Número da NFS-e não informado. Informe o número da NFS-e.
E78 Número da NFS-e inexistente na base de Informe o número correto da NFS-e.
dados para o prestador de serviço
pesquisado.
E79 Essa NFS-e já está cancelada. Confira e informe novamente os dados da NFS-e
que deseja cancelar.
E80 Código de verificação não informado. Informe o código de verificação da NFS-e.
E81 Código de verificação não corresponde à Informe o código de verificação correto.
NFS-e consultada.
E82 Pesquisa pela atividade só pode ser feita Informe um CEP ou um bairro.
com a indicação de um CEP ou bairro.
E83 Campo Inscrição Municipal do tomador O campo Inscrição Municipal do tomador é numérico
informado incorretamente. e deverá ter tamanho máximo de 15 dígitos.
E84 Pesquisa pelo CEP só pode ser feita com a Informe uma atividade.
Indicação de uma atividade.
E85 Pesquisa pelo bairro só pode ser feita com Informe uma atividade.
a Indicação de uma atividade.
E86 Número do protocolo de recebimento do Confira se o lote foi enviado e informe o número
lote Inexistente na base de dados. Correto do protocolo de recebimento.
E87 Número de lote inexistente na base de Confira se o lote foi enviado e informe o número
dados. Correto.
E88 Número de lote não informado. Informe o número do lote.
E89 Não existe na base de dados uma NFS-e Informe o número correto do RPS.
Emitida para o número de RPS informado.
E90 Número do RPS inválido. Informe um número de RPS que corresponda à
Sequência utilizada pelo prestador de serviço.
E91 Esse RPS não foi enviado para a nossa Exija do prestador do serviço à emissão da NFS-E.
base de dados.
E92 Esse RPS foi enviado para a nossa base Faça uma nova consulta mais tarde.
de Dados, mas ainda não foi processado.
E93 Série informada inválida. Informe a série correta para o RPS pesquisado.
E94 Mês de competência não informado. Informe o mês de competência no formato AAAAMM.
E95 Mês de competência informado Informe o mês de competência no formato AAAAMM.
incorretamente.
E96 Campo número do RPS informado O campo Número do RPS é numérico e deverá
Incorretamente. Ter tamanho máximo de 15 dígitos.
E97 Campo série do RPS informado O campo Série do RPS é alfanumérico e deverá
Incorretamente. Ter tamanho máximo de cinco caracteres.
E98 Valor dos serviços não informado. Informe o valor dos serviços.
E99 Valor da retenção deverá ser inferior ou Não é permitido valor de retenção superior ao
igual Ao valor dos serviços. Valor de serviços.
E100 Campo valor dos serviços informado O campo valor dos serviços é numérico e deverá
Incorretamente. Ter tamanho máximo de 15,2, ou seja, 15. Números
inteiros e dois decimais.
E101 Campo deduções informado O campo valor das deduções é numérico e deverá
incorretamente. ter tamanho máximo de 15,2, ou seja, 15 números
inteiros e dois decimais.
E102 Campo descontos informado O campo valor dos descontos é numérico e deverá
incorretamente. ter tamanho máximo de 15,2, ou seja, 15 números

Nota Fiscal de Serviços Eletrônica – NFSE Página 52 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

inteiros e dois decimais.


E103 Retenção de tributo federal informada O campo referente a retenção de tributo federal é
incorretamente. numérico e deverá ter tamanho máximo de 15,2, ou
seja, 15 números inteiros e dois decimais.
E104 Campo item da lista de serviço informado O campo item da lista de serviço deverá ter tamanho
incorretamente. máximo de 4 caracteres.
E105 Campo código CNAE informado O campo código CNAE deverá ter tamanho máximo
incorretamente. de 7 caracteres.
E106 Campo código de tributação do município O campo código de tributação do município
informado incorretamente. deverá ter tamanho máximo de 20 caracteres.
E107 Campo discriminação do serviço informado O campo discriminação do serviço deverá ter
incorretamente. tamanho máximo de 2000 caracteres.
E108 Campo município da prestação do serviço O campo município da prestação do serviço deverá
informado incorretamente. ter tamanho máximo de 7 dígitos.
E109 Campo cidade do tomador informado O campo cidade do tomador deverá ter tamanho
incorretamente. máximo de 7 dígitos, consulte tabela do IBGE..
E110 Quando a natureza da operação for Informar o município da prestação do serviço
tributação fora do município, o campo corretamente.
município da prestação do serviço deverá
ser diferente do município do prestador
E111 Município da prestação do serviço não Informe o município da prestação do serviço, de
informado. acordo com a tabela do IBGE.
E112 Campo Inscrição Municipal do intermediário O campo Inscrição Municipal do intermediário é
informado incorretamente. numérico e deverá ter tamanho máximo de 15
dígitos.
E113 Campo número do endereço do tomador A informação do número do endereço do tomador é
não informado (obrigatório para tomador obrigatória para tomadores pessoas jurídicas (com
com CNPJ) . CNPJ).
E114 Campo bairro do tomador não informado A informação do bairro do tomador é obrigatória
(obrigatório para tomador com CNPJ). para tomadores Pessoas Jurídicas (com CNPJ).
E115 Campo UF do tomador não informado O preenchimento da UF do tomador é obrigatório
(obrigatório para tomador com CNPJ). para tomadores pessoas jurídicas (com CNPJ).
E116 A UF do tomador informada não foi Informe a UF correta do tomador. Em caso de
encontrada na base de dados. cidades do exterior (fora do país), preencher a UF
com "EX" e a cidade do tomador com 99999.
E117 Campo razão social do tomador informado O campo razão social do tomador deverá ter
incorretamente. tamanho máximo de 115 caracteres.
E118 Campo razão social do tomador não O campo razão social do tomador deverá ser
informado. informado quando o campo Indicador de CPF/CNPJ
do tomador for preenchido com 1 - CPF ou 2 - CNPJ.
E119 Campo endereço do tomador informado O campo endereço do tomador deverá ter tamanho
incorretamente. máximo de 125 caracteres.
E120 Campo número do endereço do tomador O campo número do endereço do tomador deverá ter
informado incorretamente. tamanho máximo de 10 caracteres.
E121 Campo complemento do endereço do O campo complemento do endereço do tomador
tomador informado incorretamente. deverá ter tamanho máximo de 60 caracteres.
E122 Campo bairro do tomador informado O campo bairro do tomador deverá ter tamanho
incorretamente. máximo de 60 caracteres.
E123 Campo AliquotaServicos não informado Informe a alíquota do ISS quando a tributação for
para tributação fora do município. fora do município.
E124 Campo UF do tomador informado O campo UF do tomador deverá ter tamanho
incorretamente. máximo de 2 caracteres.
E125 Campo CEP do tomador informado O campo CEP do tomador deverá ter tamanho
incorretamente. máximo de 8 dígitos.
E126 Campo e-mail do tomador informado O campo e-mail do tomador deverá ter tamanho
incorretamente. máximo de 80 caracteres.
Nota Fiscal de Serviços Eletrônica – NFSE Página 53 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

E127 Campo telefone do tomador informado O campo telefone do tomador deverá ter tamanho
incorretamente. máximo de 15 caracteres.
E128 Campo razão social do intermediário do O campo razão social do intermediário do serviço
serviço informado incorretamente. deverá ter tamanho máximo de 115 caracteres.
E129 Campo código da obra informado O campo código da obra deverá ter tamanho
incorretamente. máximo de 15 caracteres.
E130 Campo ART informado incorretamente. O campo ART deverá ter tamanho máximo de 15
caracteres.
E131 Campo data inicial preenchido A data informada deverá estar no formato
incorretamente. DD/MM/AAAA, ou seja, dia (2 dígitos), seguido de
mês (2 dígitos) e ano (4 dígitos) e deve ser uma
data válida.
E132 Campo data final preenchido A data informada deverá estar no formato
incorretamente. DD/MM/AAAA, ou seja, dia (2 dígitos), seguido
de mês (2 dígitos) e ano (4 dígitos) e deve ser uma
data válida.
E133 Data final da pesquisa não poderá ser Informe uma data final igual ou anterior a data de
superior a data de hoje. hoje.
E134 A data final não poderá ser anterior à data Informe uma data final igual ou superior a data inicial
inicial. da pesquisa.
E135 O período de pesquisa não poderá ser Limitar as datas de início e final a um período de um
superior a um ano. ano.
E136 Campo número da NFS-e informado O campo número da NFS-e é numérico e deverá ter
incorretamente. tamanho máximo de 15 dígitos.
E137 Data de emissão da NFS-e informada Informe a data correta da emissão da NFS-e a ser
incorretamente. consultada.
E138 CNPJ não autorizado a realizar o serviço. Informe o CNPJ autorizado a executar o serviço.
E139 Campo número da NFS-e substituída O campo número da NFS-e substituída é numérico e
informado incorretamente. deverá ter tamanho máximo de 15 dígitos.
E140 Bairro do prestador inexistente. Informe o bairro do prestador.
E141 Inscrição Municipal do prestador não Informe a Inscrição Municipal do prestador.
informada.
E142 Inscrição Municipal do prestador não está Acerte a Inscrição Municipal ou o CNPJ do
vinculada ao CNPJ informado. prestador.
E143 Inscrição Municipal do tomador não está Acerte a Inscrição Municipal ou o CNPJ do tomador.
vinculada ao CNPJ informado.
E144 Natureza da operação inválida. Utilize um dos tipos: 01 – Tributação no município;
02 – Tributação fora do município; 03 – Isenção; 04 –
Imune; 05 – Exigibilidade suspensa por decisão
judicial; 06 – Exigibilidade suspensa por
procedimento administrativo.
E145 Regime Especial de Tributação inválido. Utilize um dos tipos: 01 – Microempresa Municipal;
02 – Estimativa; 03 – Sociedade de Profissionais; 4 –
Cooperativa; 5 - Microempresário Individual (MEI)
6 - Microempresário e Empresa de Pequeno Porte
(ME EPP).
E146 Informação de optante pelo simples Utilize um dos tipos: 1 – Sim; 2 - Não.
nacional inválida.
E147 Informação de incentivador cultural Utilize um dos tipos: 1 – Sim; 2 - Não.
inválida.
E148 Status do RPS não informado. Informe o status do RPS.
E149 Campo CNPJPrestador informado O campo CNPJPrestador é numérico e deverá ter
incorretamente, tamanho máximo de 14 dígitos.
E150 Série do RPS não informada. Campo de preenchimento obrigatório, caso não
utilize série, preencha o campo com 00000.
E151 Quantidade de RPS não informada. Informe a quantidade de RPS.
Nota Fiscal de Serviços Eletrônica – NFSE Página 54 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

E152 Campo ISSRetido não informado. Informe um dos tipos: 1 para ISS Retido ou 2
para ISS não Retido.
E153 Campo ValorISSRetido informado O campo ValorISSRetido é numérico e deverá ter
incorretamente. tamanho máximo de 15,2, ou seja, 15 números
inteiros e dois decimais.
E154 Campo CNPJ/CPF do Intermediário do O campo CNPJ/CPF do Intermediário do Serviço
Serviço informado incorretamente. é numérico e deverá ter tamanho máximo de 14
dígitos.
E155 Campo CPFCNPJTomador informado O campo CPFCNPJTomador é numérico e deverá
incorretamente. ter tamanho máximo de 14 dígitos.
E156 CNPJ do prestador não autorizado a emitir Solicite autorização para emitir NFS-e para o CNPJ
NFS-e. informado.
E157 Usuário não está autorizado a utilizar esse Solicite ao contribuinte autorização para utilizar
serviço para esse contribuinte. o serviço em seu nome.
E158 Campo Inscrição Municipal do prestador O campo Inscrição Municipal do prestador é
informado incorretamente. numérico e deverá ter tamanho máximo de 15
dígitos.
E159 CNPJ do prestador especificado no lote Informe corretamente o CNPJ do prestador no
não confere com o prestador informado no lote e no RPS.
RPS.
E160 Arquivo enviado fora da estrutura do Envie um arquivo dentro do schema do arquivo
arquivo XML de entrada. XML de entrada.
E161 Campo ValorISS não informado para Informe o valor do ISS quando a tributação for
tributação fora do município. fora do município.

4.2. TABELA DE ALERTAS

CÓD MENSAGEM INTERPRETAÇÃO


A1 Item da lista de serviço, código CNAE ou Verifique se o item ou código informado está correto.
código de tributação informado para a Se estiver, proceda a atualização cadastral junto à
operação não está cadastrado para o Prefeitura assim que possível, pois o item ou código
Prestador de serviço. informado não está cadastrado para a sua inscrição
municipal, Item da Lista de Serviço, Código CNAE ou
Código de Tributação.
A2 Item da lista de serviço, código CNAE ou Consulte a legislação vigente para saber se o item
código de tributação informado para a ou código informado permite dedução da base de
operação não permite dedução na base de cálculo.
cálculo.
A3 Item da lista de serviço informado para a Consulte a legislação vigente para saber se o item
operação não permite tributação fora do informado permite a tributação fora do município (Foi
município informada a Natureza da Operação "2").
A4 Valor do ISS retido diferente do ISS devido. Verifique se os valores estão corretos.
A5 O CNPJ informado possui inscrição no O sistema irá considerar o tomador conforme todos
município, porém foi informado endereço os dados informados no arquivo (endereço de fora
de fora do município. do município).
A6 A inscrição municipal do tomador não foi O sistema irá interpretar como se o tomador não
encontrada na base de dados de CCM. tivesse inscrição no CCM.
A7 Inscrição Municipal do tomador de serviços A inscrição municipal do tomador fornecida consta
consta como cancelada. como cancelada na base de dados do município.
A8 E-mail do tomador de serviços inválido. E- O e-mail do tomador de serviços não é válido. Este
mail não será enviado. campo será ignorado e não haverá envio de e-mail.

Nota Fiscal de Serviços Eletrônica – NFSE Página 55 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

4.3. TABELA DE MENSAGENS PERSONALIZADAS


CÓD MENSAGEM SOLUÇÃO
RPS Exibe o número do RPS. Identificação do número do RPS.
A900 O lote consultado não foi recebido, não foi Antes de fazer a consulta verifique a situação do
processado ou foi processado com erro. lote.
E900 Chamada ao método retornou erro. Entre em contato com o suporte.
E901 Erro na autenticação do usuário. Usuário e Entre em contato com o suporte.
senha não conferem.
E902 Quantidades de rps's enviandos no lote Envie o lote novamente com a quantidade de
extrapolou o limite de {0}. rps's dentro do limite.
E903 Já existe lote protocolado com esse número Altere o número do lote.
para o mesmo cnpj e inscrição municipal.
E904 Número de protocolo não corresponde a Confira o número do protocolo e os dados do
identificação do prestador informado. prestador.
E905 Número do protocolo não informado. Informe o número do protocolo.
E906 Soma total dos Itens de Serviço informados Verifique os valores informados.
(Quantidade * ValorUnitario) é diferente do
Valor do Serviço informado no Rps.
E907 Existe descricação de item de serviço vazia. Preencha a descrição dos itens do serviço
faltando.
E908 Exite quantidade informada de item de serviço A quantidade dos itens de serviço devem ser
menor ou igual a 0(zero). maior que 0(zero).
E909 Existe valor unitário de item de serviço menor O valor unitário dos itens de serviço devem ser
ou iguaç a 0(zero). maior que 0(zero).
E910 Campo de E910 informado incorretamente. O campo ValorServicos é numérico e deverá
ter tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E911 Campo de E911 informado incorretamente. O campo ValorDeducoes é numérico e deverá
ter tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E912 Campo de E912 informado incorretamente. O campo ValorPis é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E913 Campo de E913 informado incorretamente. O campo ValorCofins é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E914 Campo de E914 informado incorretamente. O campo ValorInss é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E915 Campo de E915 informado incorretamente. O campo ValorIr é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E916 Campo de E916 informado incorretamente. O campo ValorCsll é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E917 Campo de E917 informado incorretamente. O campo ValorIssRetido é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E918 Campo de E918 informado incorretamente. O campo ValorIss é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E919 Campo de E919 informado incorretamente. O campo OutrasRetencoes é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
Nota Fiscal de Serviços Eletrônica – NFSE Página 56 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

E920 Campo de E920 informado incorretamente. O campo BaseCalculo é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E921 Campo de E921 informado incorretamente. O campo Aliquota é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E922 Campo de E922 informado incorretamente. O campo ValorLiquidoNfse é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E923 Campo de E923 informado incorretamente. O campo DescontoCondicionado é numérico
e deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E924 Campo de E924 informado incorretamente. O campo DescontoIncondicionado é
numérico e deverá ter tamanho máximo de 15,2
ou seja, 15 número inteiros e 2 decimais.
E925 Campo de E925 informado incorretamente. O campo ValorDeducoes é numérico e deverá
ter tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E926 Campo de E926 informado incorretamente. O campo ValorPis é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E927 Campo de E927 informado incorretamente. O campo ValorCofins é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E928 Campo de E928 informado incorretamente. O campo ValorInss é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E929 Campo de E929 informado incorretamente. O campo ValorIr é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E930 Campo de E930 informado incorretamente. O campo ValorCsll é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E931 Campo de E931 informado incorretamente. O campo ValorIssRetido é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E932 Campo de E932 informado incorretamente. O campo ValorIss é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E933 Campo de E933 informado incorretamente. O campo OutrasRetencoes é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E934 Campo de E934 informado incorretamente. O campo BaseCalculo é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E935 Campo de E935 informado incorretamente. O campo ValorLiquidoNfse é numérico e
deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E936 Campo de E936 informado incorretamente. O campo DescontoCondicionado é numérico
e deverá ter tamanho máximo de 15,2 ou seja, 15
número inteiros e 2 decimais.
E937 Campo de E937 informado incorretamente. O campo DescontoIncondicionado é
numérico e deverá ter tamanho máximo de 15,2
ou seja, 15 número inteiros e 2 decimais.

Nota Fiscal de Serviços Eletrônica – NFSE Página 57 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

E938 Campo de E938 informado incorretamente. O campo Aliquota é numérico e deverá ter
tamanho máximo de 15,2 ou seja, 15 número
inteiros e 2 decimais.
E939 O valor de BaseCalculo declarado não está Valor correto: BaseCalculo = ValorServico -
correto. (ValorDeducoes + DescontoIncondicionado).
E940 O valor de ValorLiquidoNfse declarado não O cálculo para ValorLiquidoNfse é:
está correto. ValorLiquidoNfse = ValorServico - (ValorPis +
ValorCofins + ValorInss + ValorIr + ValorCsll +
OutrasRetencoes + ValorIssRetido +
DescontoIncondicionado +
DescontoCondicionado).
E941 O valor de alíquota declarado não está Consulte a legislação vigente para saber o valor
correto. correto.
E942 O ValorIss declarado não está correto. Verifique os dados.
E943 O ValorIss declarado é diferente do O ValorIss deve ser igual ao ValorIssRetido para
ValorIssRetido retido para IssRetido = 1. IssRetido = 1.
E944 Tipo inválido para Identificação do tipo de Tipos aceitos [Cpf|Cnpj].
documento do Tomador.
E945 O campo CPF/CNPJ do intermediário do Preencher o campo CPF/CNPJ do intermediário
serviço deverá ser preenchido com zeros do serviço com zeros quando se tratar de
quando for de CPF não-informado. tomador com CPF não informado.
E946 O intermediário do serviço informado é o Na emissão da NFS-e não é permitido que o
próprio prestador. prestador seja igual ao intermediário do serviço.
E947 Este serviço tem retenção obrigatória. Altere o campo 'ISS Retido'para 1 (Nota Fiscal
com ISS Retido).
E948 Esse Rps já foi substituído. Confira e informe novamente os dados do Rps
que deseja substituir.
E949 Esse Rps já está cancelado. Confira e informe novamente os dados do Rps
que deseja cancelar.
E950 Campo número da Nfs-e substituída informado O campo número da Nfs-e substituída é númerico
incorretamente. e deverá ter tamanho máximo de 15 dígitos.
E951 Arquivo enviado fora do layout de arquivo de Envie um arquivo dentro do layout de arquivo de
entrada (pode estar faltando o preechimento entrada (verifique se todos os campos
de um campo obrigatório). obrigatórios estão preenchidos).
E952 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório (ListaRps).
XML de entrada - campo obrigatório faltando
(ListaRps).
E953 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps).
(ListaRps[].InfRps).
E954 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.DataEmissao).
(ListaRps[].InfRps.DataEmissao).
E955 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.IdentificacaoRps).
(ListaRps[].InfRps.IdentificacaoRps).
E956 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.IdentificacaoRps.Numero).
(ListaRps[].InfRps.IdentificacaoRps.Numero).
E957 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.IdentificacaoRps.Serie).
(ListaRps[].InfRps.IdentificacaoRps.Serie).
E958 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico).
(ListaRps[].InfRps.Servico).
E959 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório

Nota Fiscal de Serviços Eletrônica – NFSE Página 58 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico.ItemListaServico).


(ListaRps[].InfRps.Servico.ItemListaServico).
E960 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico.Discriminacao).
(ListaRps[].InfRps.Servico.Discriminacao).
E961 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico.Valores).
(ListaRps[].InfRps.Servico.Valores).
E962 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico.ItensServico).
(ListaRps[].InfRps.Servico.ItensServico).
E963 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Servico.ItensServico[].Descrica
(ListaRps[].InfRps.Servico.ItensServico[].Descr o).
icao).
E964 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Prestador).
(ListaRps[].InfRps.Prestador).
E965 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Prestador.Cnpj).
(ListaRps[].InfRps.Prestador.Cnpj).
E966 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Prestador.InscricaoMunicipal).
(ListaRps[].InfRps.Prestador.InscricaoMunicipa
l).
E967 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Tomador).
(ListaRps[].InfRps.Tomador).
E968 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Tomador.IdentificacaoTomador
(ListaRps[].InfRps.Tomador.IdentificacaoToma ).
dor).
E969 Arquivo enviado fora da estrutura do arquivo Inclua no arquivo o campo obrigatório
XML de entrada - campo obrigatório faltando (ListaRps[].InfRps.Tomador.IdentificacaoTomador
(ListaRps[].InfRps.Tomador.IdentificacaoToma .CpfCnpj).
dor.CpfCnpj).
E970 Existe alguma descricação de item de serviço Verifique o tamanho das descrições de itens de
muito grande. Tamanho máximo 100 serviço.
caracteres.
E971 Existe mais de uma série de Nfs-e definida Entre em contato com a prefeitura para mais
para uso com o web service para este informações.
contribuinte.
E972 Não existe nenhuma série de Nfs-e definida Entre em contato com a prefeitura para mais
para uso com o web service. informações.
E973 O serviço {0} não está mais disponível. Entre em contato com o fornecedor do serviço
para mais informações.
E974 Não existe nenhuma série de Nfs-e liberada Entre em contato com a prefeitura para mais
para ser usada com o web service. informações.
E975 A data de emissão do RPS ou da Nfs-e não Entre em contato com a prefeitura para mais
poderá ser superior à data limite autorizada informações.
para a emissão da Nfs-e.
E976 A numeração da Nfs-e a ser gerada Entre em contato com a prefeitura para mais
ultrapassará a numeração limite autorizada informações.
pela prefeitura para a emissão de Nfs-e.
E977 Existe mais de uma série de Nfs-e liberada Entre em contato com a prefeitura para mais
para ser usada com o web service o que não é informações.

Nota Fiscal de Serviços Eletrônica – NFSE Página 59 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

permitido.
E978 Nota Fiscal sem valor de ISS não pode ter ISS Altere o campo ‘ISS Retido’ para 2 (Nota Fiscal
Retido. sem ISS Retido)
E979 Campo Valor do ISS Retido deve ser 0.0 para Altere o campo Valor do ISS Retido para 0.0.
ISS Não Retido.
E980 O somatório das deduções e do desconto O preço do serviço deve ser maior ou igual à
incondicionado está maior que o valor dos soma das deduções com o desconto
serviços. incondicionado.
E981 A somatória dos descontos, retenções federais O preço do serviço deve ser maior ou igual à
e ISSQN retido na fonte está maior que o valor soma dos tributos federais, o ISSQN devido e os
dos serviços. descontos.
E982 Código de tributação não permite desconto O tipo de serviço prestado não permite desconto
condicionado. condicionado.
E983 Código de tributação não permite desconto O tipo de serviço prestado não permite desconto
incondicionado. incondicionado.
E984 Campo Outras Informações informado O campo Outras Informações é alfanumérico e
Incorretamente. deverá Ter tamanho máximo de 255 caracteres.
E985 Campo Inscrição Estadual do tomador O campo Inscrição Estadual do tomador deverá
informado incorretamente. ter tamanho máximo de 20 caracteres.
E986 Não pode ser cancelada a Nfs-e do Livro do Primeiro entre em contato com a Prefeitura e
Prestador. Já existe guia vinculada. solicite o cancelamento da guia.
E987 Não pode ser cancelada a Nfs-e do Livro do Primeiro entre em contato com a Prefeitura e
Tomador. Já existe guia vinculada. solicite o cancelamento da guia.
E988 Não é permitido o envio de RPS com data de Informe a data de emissão que esteja dentro do
emissão inferior à dez dias da data atual. período autorizado.
E989 Campo de Optante pelo Simples Nacional não Verifique no site, Configurações do Prestador, a
confere com o cadastro da Prefeitura. opção correta.
E990 Opção Simples Nacional conflita com o Apenas podem ser Optantes pelo Simples
Regime Especial de Tributação informado. Nacional empresas enquadradas nos Regimes:
5 - MEI; 6 - ME EPP ou 8 - FIXO.
E991 O Regime Especial de Tributação Altere o campo ‘ISS Retido’ para 2.
Microempresário Individual (MEI) não permite
retenção de ISS.
E992 A quantidade de itens de serviço informada A quantidade dos itens de serviço não deve ser
excede o número máximo permitido. maior que 15 (quinze).
E993 O código de tributação informado difere do Procure a Prefeitura para atualizar o código de
registrado na Prefeitura. tributação no cadastro do contribuinte.
E994 O código de CNAE informado difere do Procure a Prefeitura para atualizar o código de
registrado na Prefeitura. CNAE no cadastro do contribuinte.
E995 RPS Pessoa Física não pode efetuar a Tomador de serviço pessoa física não pode reter
retenção do ISSQN. o ISSQN. Altere o indicador de retenção do
ISSQN para 2 - sem retenção.
E996 RPS em duplicidade no arquivo enviado. Retire do lote o RPS duplicado ou altere sua
identificação: número ou série, e reenvie o lote.
E997 Valor de dedução ultrapassa o percentual Verifique com a Prefeitura o índice de
permitido. porcentagem permitido na atividade.
E998 A alíquota está divergindo dos valores de Por favor, confirmar a alíquota através do
receita configurados. sistema Nfse, Menu: Cadastro > Alíquota
Simples Nacional.
E999 Este valor de serviço não permite Altere o campo ‘ISS Retido’ para 2.
retenção de ISS.
Não é permitido o envio de RPS com data de Informe a data de emissão que esteja
E1000 emissão inferior à última Nfs-e emitida dentro do período autirizado.
A data de emissão do RPS excede a data de Informe a data de emissão que esteja dentro do
E1001 retroação do município. período autorizado.
Nota Fiscal de Serviços Eletrônica – NFSE Página 60 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Altere o campo IssTributavel para 2 dos itens de


Não é permitido dedução na base de cálculo serviço cuja a soma total dos itens não tributável
E1002 sem itens de serviço não tributável. seja igual ao valor da dedução.
Soma total dos itens não tributável é diferente
E1003 do valor da dedução. Verifique os valores informados.
O código informado no campo Art é diferente Entre em contato com a prefeitura para mais
E1004 do código da obra do cadastro do contribuinte. informações.
O serviço não está disponível para este
E1005 município. Realizar o procedimento através do Sistema Web.
Há pendência de envio de Declaração Mensal Proceder a regularização (gerar guia) para realizar
E1006 de Serviço de mês(es) anterior(es). novas emissões de NFS-e.
Tomador de serviço produtor rural não pode reter
Produtor rural não pode efetuar a retenção do o ISSQN. Altere o indicador de retenção do
E1007 ISSQN. ISSQN para 2 - sem retenção.

5. VERSÕES DO MANUAL

5.1. ATUALIZAÇÕES

Versão 1.01 – 17/01/2011


Inclusão da tabela tcItemServico:
 Tabela que descreve a lista de serviços, quantidade de itens e valor de cada
serviço.
Inclusão das tabelas tcInfNovaNfse, tcIdentNovaNfse e tcRepostaIdentNovaNfse:

 Conjunto de tabelas que compõem o serviço Gerar Nfs-


e. Inclusão do serviço Gerar Nfs-e:
 Serviço utilizado para a emissão de uma única Nfs-e por vez, não comportando
envio de lote nem processamento de RPS. Item 3.5.8 do manual.

Versão 1.02 – 11/05/2011


Alteração do campo tsIndicacaoCpfCnpj:
 CPF – 1; CNPJ – 2; Não Informado – 3.
Alteração da tabela tcInfNovaNfse:

 Foram adicionados os campos: Id, NaturezaOperacao, RegimeEspecialTributacao,


OptanteSimplesNacional, IncentivadorCultural, Status, Competencia,
NfseSubstituida, OutrasInformacoes e IntermediarioServico.
Inclusão do serviço Versao:
 Serviço utilizado para verificar a conectividade entre o sistema do contribuinte e o
sistema web service.
Nota Fiscal de Serviços Eletrônica – NFSE Página 61 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Versão 1.03 – 30/06/2011


Correção da tabela tcDadosServico:

 Remoção dos campos Descricao, Quantidade e ValorUnitario, que causavam


duplicidade de dados com os da tabela tcItemServico.

Versão 1.04 – 23/02/2012


Inclusão do campo OutrasInformacoes na tabela tcInfRps:
 Campo usado para agregar informações adicionais ao documento.

Inclusão de mensagens personalizadas:


 Adicionado mensagens de erros. Da mensagem E950 até a mensagem E978, que
dizem respeito à estrutura do arquivo XML, série e data de autorização para a
emissão de RPS.
Inclusão do Item 2.4. Ambiente de Homologação:
 Disponibilização dos links de Cadastro e de Homologação.

Versão 1.05 – 17/07/2012


Inclusão de novas mensagens personalizadas. Item 4.3 do manual.
 E979, E980, E981, E982, E983 e E984.

Versão 1.06 – 20/08/2012


Alterado exemplo de formato de valores percentuais, Item 3.2.
Inclusão de novo campo na tabela tipo simples, Item 3.3:
 tsInscricaoEstadual.
Inclusão do campo tipo simples na tabela tipo complexo tcIdentificacaoTomador, Item 3.4:
 InscricaoEstadual.
 Para utilizar este novo campo, tem que refazer a referência do link de conexão
entre aplicação cliente e web services.
Adicionado opções de motivo de cancelamento no campo tsCodigoCancelamentoNfse,
Item 3.3.
Alteração do campo tsTelefone de 11 para 15 caracteres.

Nota Fiscal de Serviços Eletrônica – NFSE Página 62 de 62


Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Atualizada mensagem de erro E127, Item 4.1.


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
 E985, E986, E987, E988, E989, E990, E991.

Versão 1.07 – 20/09/2012


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
 E992.
Versão 1.08 – 03/10/2012
Alteração da Mensagem Personalizada no item 4.3. do manual.
 E992.
Versão 1.09 – 07/10/2012
Adição de novas Mensagens Personalizadas no item 4.3. do manual.
 E993, E994.

Versão 1.10 – 16/08/2013


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
 RPS, E25.

Versão 1.11 – 07/11/2013


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
E995, E996.

Versão 1.12 – 20/08/2015


Alterados valores de preenchimento do campo, Item 3.3. do manual.
 tsRegimeEspecialTributacao

Versão 1.13 – 19/05/2016


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
E997, E998, E999, E1000.

Versão 1.14 – 20/07/2016


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
E1001, E1002, E1003.

Versão 1.15 – 10/08/2016


Adição de novas Mensagens Personalizadas no item 4.3. do manual.
E1004, E1005.

Versão 1.16 – 15/09/2016


Nota Fiscal de Serviços Eletrônica – NFSE Página 63 de 62
Revisado em: 02/12/2016
Manual de Utilização do Web Service
Versão: 1.18 Versão da ABRASF: 1.00

Edição da Mensagem de retorno ao contribuinte no item 4.1. do manual.


E44.
Versão 1.17 – 17/11/2016
Adição de nova Mensagen Personalizada no item 4.3. do manual.
E1006.
Versão 1.18 – 02/12/2016
Adição de nova Mensagen Personalizada no item 4.3. do manual.
E1007.

Nota Fiscal de Serviços Eletrônica – NFSE Página 64 de 62