PREFEITURA MUNICIPAL DE CACHOEIRINHA

SECRETARIA MUNICIPAL DA FAZENDA

NOTA FISCAL DE SERVIOS ELETRNICA NFS-E

MANUAL DE ACESSO E UTILIZAO DO WEB SERVICE

Verso 1.0.5
Dezembro/2012

NDICE
1

APRESENTAO ................................................................................................ 4

SERVIOS DISPONVEIS E ARQUITETURA DE COMUNICAO ................... 5

2.1

2.1.1

Recepo e Processamento de Lote de DFS .......................................... 5

2.1.2

Recepo e Processamento de Lote de at trs DFS ............................. 5

2.1.3

Consulta de Situao de Lote de DFS..................................................... 6

2.1.4

Consulta de NFS-e por DFS .................................................................... 7

2.1.5

Consulta de Lote de DFS ........................................................................ 7

2.1.6

Consulta de NFS-e .................................................................................. 8

2.1.7

Cancelamento de NFS-e ......................................................................... 9

2.2

Padres Tcnicos........................................................................................... 9

2.2.1

Padro de Comunicao ......................................................................... 9

2.2.2

Padro de Certificado Digital ................................................................. 10

2.2.3

Padro de Assinatura Digital ................................................................. 11

2.2.4

Validao de Assinatura Digital pelo Sistema NFS-e ............................ 12

2.2.5

Uso de Assinatura com Certificado Digital............................................. 13

2.3

Modelo Conceitual.......................................................................................... 5

Padro das Mensagens XML ....................................................................... 13

2.3.1

rea do Cabealho ................................................................................ 13

2.3.2

Validao da estrutura das Mensagens XML ........................................ 14

2.3.3

Schemas XML (arquivos XSD) .............................................................. 15

2.3.4

Verso dos Schemas XML .................................................................... 15

Estrutura de Dados Do Web Service ................................................................. 16

3.1

Modelo Operacional ..................................................................................... 16

3.1.1

Servios Sncronos ................................................................................ 16

3.1.2

Servios Assncronos ............................................................................ 17

3.2

Formatos e Padres Utilizados .................................................................... 18

3.3

Tipos Simples ............................................................................................... 19

3.4

Tipos Complexos ......................................................................................... 22

3.5

Servios ....................................................................................................... 27

3.5.1

Recepo de Lote de DFS .................................................................... 28

3.5.2

Recepo de Lote de at trs DFS........................................................ 29

3.5.3

Consulta de Situao de Lote de DFS................................................... 29

3.5.4

Consulta de NFS-e por DFS .................................................................. 30

3.5.5

Consulta de NFS-e ................................................................................ 30

3.5.6

Consulta de Lote de DFS ...................................................................... 31

3.5.7

Cancelamento NFS-e ............................................................................ 31

Anexo ................................................................................................................. 33
4.1

Tabela de Erros ............................................................................................ 33

4.2

Tabela de Alertas ......................................................................................... 40

APRESENTAO

Este manual tem como objetivo apresentar as especificaes e critrios tcnicos

necessrios para utilizao do Web Service disponibilizado pela Prefeitura de
Cachoeirinha para as empresas prestadoras e/ou tomadoras de servios.
O Web Service um componente de aplicao acessvel atravs de protocolos
padres de Internet. Atravs do Web Service as empresas podero integrar seus
prprios sistemas de informaes com o aplicativo da Nota Fiscal de Servio
Eletrnica da Prefeitura Municipal de Cachoeirinha. Desta forma, consegue-se
automatizar o processo de gerao, consulta e cancelamento de NFS-e.

SERVIOS DISPONVEIS E ARQUITETURA DE COMUNICAO

2.1

Modelo Conceitual

Atravs do Web Service, o aplicativo da Nota Fiscal de Servio Eletrnica da

Prefeitura Municipal de Cachoeirinha disponibilizar servios que podero ser
acessados pelos sistemas dos contribuintes. A seguir, esto resumidos os servios
disponveis e suas respectivas funcionalidades bsicas.

2.1.1 Recepo e Processamento de Lote de DFS

Esse servio compreende a recepo do Lote de DFS, a resposta com o nmero do
protocolo gerado para esta transao e o processamento do lote. Quando efetuada
a recepo, o Lote entrar na fila para processamento posterior onde sero feitas as
validaes necessrias e gerao das NFS-e.
Prestador
Prefeitura

Aplicao Cliente
b

<XML>
Lote de DFS

NFS-e

a
d
DFS

<XML>
Mensagem

Web Services

NFS-e

Fila de Processos

XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_enviar_lote_rps_resposta.xsd.

Passos para execuo

1. A aplicao acessa o servio de Recepo e Processamento de Lote de DFS
enviando o lote (fluxo b).
2. A requisio recebida pelo servidor do Web Service, que grava as informaes
recebidas e gera o nmero de protocolo de recebimento (fluxo c).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxo d).
2.1.2 Recepo e Processamento de Lote de at trs DFS
Esse servio compreende a recepo do Lote de at trs DFS, a resposta com o
nmero do protocolo gerado para esta transao e o processamento do lote.

Quando efetuada a recepo, o Lote com at trs DFS ser processado no mesmo
momento onde sero feitas as validaes necessrias e gerao das NFS-e.
Prestador
Prefeitura

Aplicao Cliente
b

<XML>
Lote de DFS

NFS-e

a
d
<XML>
Mensagem

DFS

Web Services

NFS-e

Fila de Processos

XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_enviar_lote_rps_resposta.xsd

Passos para execuo

1. A aplicao acessa o servio de Recepo e Processamento de Lote de DFS
enviando o lote (fluxo b).
2. A requisio recebida pelo servidor do Web Service que grava as informaes
recebidas e gera as NFS-e (fluxo c).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxo d).
2.1.3 Consulta de Situao de Lote de DFS
Esse servio efetua a consulta da situao de um Lote de DFS j enviado.
Prestador

Prefeitura

Aplicao Cliente
2.b

2.c

<XML>
Identif. do Lote

Consulta

2.a

2.e
<XML>

Web Services

2.d NFS-e
Processamento
Resultado

Situao do Lote

XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_consultar_situacao_lote_rps_resposta.xsd

Passos para execuo

1. A aplicao acessa o servio de Consulta de Situao de Lote de DFS e
submete os dados para processamento (fluxo 2.b).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica o status do lote (fluxos 2.c e 2.d).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxo 2.e).

2.1.4 Consulta de NFS-e por DFS

Esse servio efetua a consulta de uma NFS-e a partir do nmero de DFS que a
gerou.
Prestador

ou

Prefeitura

Aplicao Cliente
2.

<XML>
Identif. do DFS

2.c

2.

?
Consulta

2.

Web Services

<XML>
NFS-e / Mensag.

2.
Processamento
NFS-e /

NFS-e

XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_consultar_nfse_rps_resposta.xsd

Passos para execuo

1. A aplicao acessa o servio de Consulta de NFS-e por DFS e submete os
dados para processamento (fluxo 2.b).
2. A requisio 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
servio (fluxo 2.e).
2.1.5 Consulta de Lote de DFS
Esse servio permite ao contribuinte obter as NFS-e que foram geradas a partir do
Lote de DFS enviado, quando o processamento ocorrer sem problemas; ou obter a
lista de erros e/ou inconsistncias encontradas nos DFS.
Na validao 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.
Prefeitura

Prestador
Aplicao Cliente
b

Web Services

<XML>
Identif. do DFS

Consulta

Processamento

<XML>
Grupo de NFS-e /
XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_consultar_lote_rps_resposta.xsd

NFS-e / Msg

NFS-e

Passos para execuo

1. A aplicao acessa o servio de Consulta de Lote de DFS e submete os dados
para processamento (fluxo b).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos c e d).
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 servio
(fluxo e).
2.1.6 Consulta de NFS-e
Esse servio permite a obteno de determinada NFS-e j gerada.
Prefeitura
Prestador

ou

Aplicao Cliente
2.

Consulta

2.

2.
<XML>
NFS-e /

2.c

<XML>
Identif. do DFS

Web Services

2.
Processamento
NFS-e /

NFS-e

XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_consultar_nfse_resposta.xsd

Passos para execuo

1. A aplicao acessa o servio de Consulta de NFS-e e submete os dados para
processamento ().
2. A requisio 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
servio.

2.1.7 Cancelamento de NFS-e

Esse servio permite o cancelamento direto de uma NFS-e sem substituio da
mesma por outra.
Prestador

Prefeitura

Aplicao Cliente
2.b

<XML>
Identif. da NFS-e

Cancelamento

2.a
2.d

2.c
Web Services

Processamento

NFS-e

<XML>
Mensagem
XML de Envio validado pelo Arquivo de Validao XSD, disponvel no portal da Prefeitura
XML de Resposta validado pelo arquivo: servico_cancelar_nfse_resposta.xsd

Passos para execuo

1. A aplicao acessa o servio de Cancelamento de NFS-e e submete os dados
para processamento (fluxo 2.b).
2. A requisio 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
servio (fluxo 2.d).
2.2

Padres Tcnicos
HTTPS
Requisio

Contribuinte

Prefeitura

2.2.1 Padro de Comunicao

O meio fsico de comunicao utilizado entre os sistemas de informao dos
contribuintes e o aplicativo da Nota Fiscal de Servio Eletrnica da Prefeitura
Municipal de Cachoeirinha ser a Internet, por meio do protocolo SSL, que alm de
garantir um duto de comunicao seguro na Internet, permite a identificao do
servidor e do cliente atravs de certificados digitais, eliminando a necessidade de
identificao do usurio atravs de nome ou cdigo de usurio e senha.

10

O modelo de comunicao segue o padro de Web Services definido pelo WS-I

Basic Profile.
A troca de mensagens entre o Web Service do aplicativo da Nota Fiscal de Servio
Eletrnica da Prefeitura Municipal de Cachoeirinha e o sistema do contribuinte ser
realizada no padro SOAP, com troca de mensagens XML no padro
Style/Enconding: Document/Literal, wrapped. A opo wrapped representa a
chamada aos mtodos disponveis com a passagem de mais de um parmetro. Para
descrever os servios disponibilizados, ser utilizado um documento WSDL (Web
Service Description Language). O WSDL o padro recomendado para descrio
de servios SOAP.

SOAP
Requerente

Provedor

As chamadas aos servios sero feitas enviando, como parmetro, um documento

XML a ser processado pelo sistema. Esse documento no far parte da descrio do
servio (arquivo WSDL), e o formato do XML, correspondente ao servio dever ser
consultado nesse manual de integrao, seo 3.5.

2.2.2 Padro de Certificado Digital

Os certificados digitais utilizados no aplicativo da Nota Fiscal de Servio Eletrnica
da Prefeitura Municipal de Cachoeirinha sero emitidos por Autoridade Certificadora
credenciada pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil, de
pessoa fsica ou jurdica, dos tipos A1, A3 ou certificado de servidor1 (hbrido).
Para a assinatura digital dos documentos envolvidos aceitar-se- que o certificado
digital seja do estabelecimento emissor ou de pessoa fsica ou jurdica autorizada.
Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a
integrao entre o sistema do contribuinte e o Web Service da Prefeitura Municipal
de Cachoeirinha:
1

O certificado de servidor poder ser utilizado somente para Web Service, no podendo ser utilizado no aplicativo on-line da

NFS-e.

11

Assinatura de Mensagens: O certificado digital utilizado para essa funo

dever conter o CNPJ do estabelecimento emissor da NFS-e. O certificado
digital dever ter o uso da chave previsto para a funo de assinatura digital,
respeitando a Poltica do Certificado.
Transmisso (durante a transmisso das mensagens entre os servidores do
contribuinte e os servios disponibilizados pela Prefeitura Municipal de
Cachoeirinha): O certificado digital utilizado para identificao do aplicativo do
contribuinte dever conter o CNPJ da empresa responsvel pela transmisso
das mensagens devendo ter a extenso extended Key Usage com permisso
de "Autenticao Cliente".

2.2.3 Padro de Assinatura Digital

As mensagens enviadas aos servios disponibilizados pela Prefeitura Municipal de
Cachoeirinha so documentos eletrnicos elaborados no padro XML e devem ser
assinados digitalmente com um certificado digital e-CNPJ do estabelecimento
autorizado pelo municpio para emisso de NFS-e.
Para garantir minimamente a integridade das informaes prestadas e a correta
formao dos arquivos XML, o contribuinte dever submeter as mensagens XML,
para validao, antes de seu envio, pela linguagem de Schema do XML (XSD XML
Schema Definition), disponibilizada pela Prefeitura Municipal de Cachoeirinha.
Os elementos abaixo esto presentes dentro do Certificado do contribuinte tornando
desnecessria a sua representao individualizada no arquivo XML. Portanto, o
arquivo XML no deve conter os elementos:
<X509SubjectName>
<X509IssuerSerial>
<X509IssuerName>
<X509SerialNumber>
<X509SKI>
Deve-se evitar o uso das TAGs abaixo, pois as informaes sero obtidas a partir do
Certificado do emitente:
<KeyValue>
<RSAKeyValue>
<Modulus>
<Exponent>
O Projeto NFS-e utiliza um subconjunto do padro de assinatura XML, definido pelo
http://www.w3.org/TR/xmldsig-core/, que tem o seguinte leiaute:
#

Campo

XS01 Signature

Elemento
Raiz

Pai

Tipo Ocorrncia

Descrio

12

XS02 Id

XS01

1-1

XS03 SignedInfo

XS01

1-1

XS04 CanonicalizationMethod

XS03

1-1

Grupo do Mtodo de Canonicalizao

1-1

Atributo Algorithm de CanonicalizationMethod:

http://www.w3.org/TR/2001/REC-xml-c14n-20010315

1-1

Grupo do Mtodo de Assinatura

1-1

Atributo Algorithm de SignedInfo:

http://www.w3.org/2000/09/xmldsig#rsa-sha1

1-1

Grupo do Mtodo de Reference

XS05 Algorithm

XS04

XS06 SignatureMethod

XS03

XS07 Algorithm

XS06

XS08 Reference

XS03

XS09 URI

XS08

1-1

Atributo URI da tag Reference

XS10 Transforms

XS08

1-1

Grupo do algorithm de Transform

RC

XS10

1-1

Regra para o atributo Algorithm do Transform ser

nico

XS12 Transform

XS10

2-2

Grupo de Transform

XS13 Algorithm

XS12

1-1

Atributos vlidos Algorithm do Transform:

http://www.w3.org/TR/2001/REC-xml-c14n-20010315
http://www.w3.org/2000/09/xmldsig#envelopedsignature

XS14 Xpath

XS12

0-N

Xpath

XS15 DigestMethod

XS08

XS11 Unique_Transf_Alg

XS16 Algorithm

Grupo da Informao da assinatura

1-1

Grupo do Mtodo de DigestMethod

1-1

Atributo Algorithm de DigestMethod:

http://www.w3.org/2000/09/xmldsig#sha1

XS15

XS17 DigestValue

XS08

XS18 SignatureValue

XS01

1-1

Grupo do Signature Value

Digest Value (Hash SHA-1 Base64)

XS19 KeyInfo

XS01

1-1

Grupo do KeyInfo

XS20 X509Data

XS19

1-1

Grupo X509

XS21 X509Certificate

XS20

1-1

Certificado Digital x509 em Base64b

2.2.4 Validao de Assinatura Digital pelo Sistema NFS-e

Para a validao da assinatura digital, seguem as regras que sero adotadas pela
Prefeitura Municipal de Cachoeirinha:
1. Extrair a chave pblica do certificado;
2. Verificar o prazo de validade do certificado utilizado;
3. Montar e validar a cadeia de confiana dos certificados validando, tambm, 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 (no sero aceitos certificados do tipo S);
5. Garantir que o certificado utilizado de um usurio final e no de uma
Autoridade Certificadora;
6. Adotar as regras definidas pelo RFC 3280 para LCRs e para a cadeia de
confiana;
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 conferncia da LCR fica a critrio da Prefeitura Municipal de
Cachoeirinha, podendo ser feita de 2 (duas) maneiras: On-line ou Download

13

peridico. As assinaturas digitais das mensagens sero verificadas considerando o

horrio fornecido pelo Observatrio Nacional.

2.2.5 Uso de Assinatura com Certificado Digital

Para garantir a autenticidade dos dados gerados, algumas informaes devero ser
assinadas digitalmente. Abaixo, seguem as informaes que devero ser assinadas
e quem dever faz-lo em cada momento:

2.3

O DFS, pelo contribuinte, antes do envio do mesmo atravs do Lote de DFS;

O Lote de DFS (apenas as informaes do lote), pelo contribuinte, antes do
envio do mesmo;
A NFS-e:
o Pelo contribuinte, quando gerada pela Aplicao On Line.
O Pedido de cancelamento da NFS-e, pelo contribuinte;
A Confirmao de cancelamento da NFS-e;
Padro das Mensagens XML

A especificao adotada para as mensagens XML a recomendao W3C para

XML 1.0, disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres
ser em iso-8859-1.
As chamadas dos Web Services disponibilizados pela Prefeitura Municipal de
Cachoeirinha e os respectivos resultados do processamento so realizadas atravs
das mensagens com o seguinte padro:

rea de Cabealho estrutura XML padro para todas as mensagens de

chamada e retorno de resultado dos Web Services disponibilizados pelas
Secretarias de Fazenda Estaduais ou Secretaria da Receita Federal, que
contm os dados de controle da mensagem. A rea de cabealho est sendo
utilizada para armazenar a verso do leiaute da estrutura XML informado na
rea de dados
rea de Dados estrutura XML varivel, definida na documentao do Web
Service acessado.

2.3.1 rea do Cabealho

Abaixo, o leiaute da rea de Cabealho padro:
#
1
2

Nome

Elemento

Pai

Tipo

Ocorrncia

Tamanho

1-1

Descrio

cabecalho

TAG raiz do cabealho da mensagem.

Verso

1-1

Verso do leiaute.

versaoDados

1-1

O contedo deste campo indica a

14

verso do leiaute XML da estrutura

XML informada na rea de dados da
mensagem.

O campo versaoDados deve conter a informao da verso do leiaute da estrutura

XML armazenada na rea de dados da mensagem.
A estrutura XML armazenada na rea de dados est definida na documentao do
Web Service acessado.

2.3.2 Validao da estrutura das Mensagens XML

Para garantir minimamente a integridade das informaes prestadas e a correta
formao das mensagens XML, o contribuinte dever submeter cada uma das
mensagens XML de pedido de servio para validao pelo seu respectivo arquivo
XSD (XML Schema Definition, definio 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 contedo de uma mensagem XML, descrevendo os seus
atributos, elementos e a sua organizao, alm de estabelecer regras de
preenchimento de contedo e de obrigatoriedade de cada elemento ou grupo de
informao.
A validao da estrutura da mensagem XML realizada por um analisador sinttico
(parser) que verifica se a mensagem XML atende as definies e regras de seu
respectivo Schema XML.
Qualquer divergncia da estrutura da mensagem XML em relao ao seu respectivo
Schema XML, provoca um erro de validao do Schema XML. Neste caso, o
contedo da mensagem XML de pedido do servio no poder ser processado.
A primeira condio para que a mensagem XML seja validada com sucesso que
ela seja submetida ao Schema XML correto.
Assim, os sistemas de informao dos contribuintes devem estar preparados para
gerar mensagens XML em seus respectivos Schemas XML em vigor.

15

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 no link
http://www.abrasf.org.br/ABRASF/arquivos/nfse.xsd.

2.3.4 Verso dos Schemas XML

Toda mudana de leiaute das mensagens XML do Web Service implica na
atualizao do seu respectivo Schema XML.
A identificao da verso dos Schemas XML ser realizada com o acrscimo do
nmero da verso com dois dgitos no nome do arquivo XSD precedida da literal
_v, como segue:
<Nome do Arquivo>_v<Nmero da Verso>.xsd
Exemplo:
EnvioLoteRps_v01.xsd
A maioria dos Schemas XML definidos para a utilizao do Web Service do
aplicativo da Nota Fiscal de Servio Eletrnica da Prefeitura Municipal de
Cachoeirinha utiliza as definies de tipos simples ou tipos complexos que esto
definidos em outros Schemas XML. Nestes casos, a modificao de verso do
Schema bsico ser repercutida no Schema principal.
As modificaes de leiaute das mensagens XML do Web Service podem ser
causadas por necessidades tcnicas ou em razo da modificao de alguma
legislao. As modificaes decorrentes de alterao da legislao devero ser
implementadas nos prazos previstos no ato normativo que introduziu a alterao. As
modificaes de ordem tcnica sero divulgadas pela Prefeitura Municipal de
Cachoeirinha e podero ocorrer sempre que se fizerem necessrias.

ESTRUTURA DE DADOS DO WEB SERVICE

Existir um nico Web Service com todos os servios apresentados no item 2.

O fluxo de comunicao sempre iniciado pelo sistema do contribuinte atravs
do envio de uma mensagem XML ao Web Service com o pedido do servio
desejado.

3.1

Modelo Operacional

A forma de processamento das solicitaes de servios no projeto Nota Fiscal

de Servios Eletrnica pode ser: ou sncrona, caso o atendimento da
solicitao de servio seja realizada na mesma conexo; ou assncrona,
quando o processamento do servio solicitado no atendido na mesma
conexo, devido a uma demanda de processamento de grande quantidade de
informao. Nesta situao, torna-se necessria a realizao de mais de uma
conexo para a obteno do resultado do processamento.
As solicitaes de servios que exigem processamento intenso sero
executadas de forma assncrona e, as demais solicitaes de servios, de
forma sncrona.
Assim, os servios da NFS-e sero implementados da seguinte forma:
Servio

Implementao

Recepo e Processamento de Lote de DFS

Assncrona

Recepo e Processamento de Lote de at trs DFS

Sncrona

Consulta de Situao de Lote de DFS

Sncrona

Consulta de NFS-e por DFS

Sncrona

Consulta de Lote de DFS

Sncrona

Consulta de NFS-e

Sncrona

Cancelamento de NFS-e

Sncrona

3.1.1 Servios Sncronos

As solicitaes de servios de implementao sncrona so processadas
imediatamente e o resultado do processamento obtido em uma nica
conexo.

17

Abaixo, o fluxo simplificado de funcionamento:

Prefeitura
Prestador
Web Services

<XML>
Solicitao

Processamento
<XML>
Resultado

Etapas do processo ideal:

1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de
solicitao de servio para o Web Service;
2. O Web Service recebe a mensagem de solicitao de servio e encaminha
ao aplicativo da NFS-e que ir processar o servio solicitado;
3. O aplicativo da NFS-e recebe a mensagem de solicitao de servios 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 no exista outra mensagem, encerra a conexo.
3.1.2 Servios Assncronos
As solicitaes de servios de implementao assncrona so processadas de
forma distribuda por vrios processos e o resultado do processamento
somente obtido na segunda conexo.
Abaixo, o fluxo simplificado de funcionamento:
Prefeitura

Prestador
<XML>
Solicitao

Web Service
<XML>
Resultado

Etapas do processo ideal:

Fila de Processos

18

Solicitao e processamento:
1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de
solicitao de servio para o Web Service de recepo de solicitao de
servios;
2. O Web Service de recepo de solicitao de servios recebe a mensagem
de solicitao de servio e a coloca na fila de servios solicitados,
acrescentando o CNPJ do transmissor obtido do certificado digital do
transmissor;
3. O Web Service de recepo de solicitao de servios retorna o protocolo
da solicitao de servio e a data e hora de gravao na fila de servios
solicitados ao aplicativo do contribuinte;
4. O aplicativo do contribuinte recebe o protocolo;
5. Na estrutura interna do aplicativo de NFS-e, a solicitao de servios
retirada da fila de servios solicitados pelo aplicativo da NFS-e em momento
especfico, definido pela equipe tcnica da NFS-e;
6. O servio solicitado processado pelo aplicativo da NFS-e e o resultado do
processamento colocado na fila de servios processados.
Obteno do resultado do servio
1. O aplicativo do contribuinte, atravs do protocolo recebido, envia uma
consulta ao servio que retornar o resultado do processamento daquele
protocolo, iniciando uma conexo com o Web Service;
2. O Web Service recebe a mensagem de consulta e localiza o resultado de
processamento da solicitao de servio;
3. O Web Service devolve o resultado do processamento ao aplicativo
contribuinte;
4. O aplicativo do contribuinte recebe a mensagem de resultado do
processamento e, caso no exista outra mensagem, encerra a conexo.
3.2

Formatos e Padres Utilizados

Abaixo segue algumas formataes de dados que devem ser seguidas para
gerao correta na estrutura dos arquivos.
Formato

Data (date)

Data/Hora (datetime)

Valores Decimais (decimal)

Observao
Formato: AAAA-MM-DD
onde:
AAAA = ano com 4 caracteres
MM = ms com 2 caracteres
DD = dia com 2 caracteres
Formato AAAA-MM-DDTHH:mm:ss
onde:
AAAA = ano com 4 caracteres
MM = ms com 2 caracteres
DD = dia com 2 caracteres
T = caractere de formatao que deve existir separando a data da hora
HH = hora com 2 caracteres
mm: minuto com 2 caracteres
ss: segundo com 2 caracteres
Formato: 0.00
No deve ser utilizado separador de milhar. O ponto (.) deve ser utilizado para separar a
parte inteira da fracionria.

19

Valores Percentuais
(decimal)

Exemplo:
48.562,25 = 48562.25
1,00 = 1.00 ou 1
0,50 = 0.50 ou 0.5
Formato 0.0000
O formato em percentual presume o valor percentual em sua forma fracionria, contendo
5 dgitos. O ponto (.) separa a parte inteira da fracionria.
Exemplo:
62% = 0.62
150% = 1.5
25,32 = 0.2532

No deve ser inserido caractere no significativo para preencher o tamanho

completo do campo, ou seja, zeros antes de nmero ou espao em branco
aps cadeia de caracteres. A posio do campo definida na estrutura do
documento XML atravs de TAGs (<tag>contedo</tag>).
A regra constante do pargrafo anterior dever estender-se para os campos
onde no h indicao de obrigatoriedade e que, no entanto, seu
preenchimento torna-se obrigatrio por estar condicionado legislao
especfica ou ao negcio do contribuinte. Neste caso, dever constar a TAG
com o valor correspondente e, para os demais campos, devero ser eliminadas
as TAGs.
Para reduzir o tamanho final do arquivo XML da NFS-e, alguns cuidados de
programao devero ser assumidos:

no incluir "zeros no significativos" para campos numricos;

no incluir "espaos" no incio ou no final de campos numricos e
alfanumricos;
no incluir comentrios no arquivo XML;
no incluir anotao e documentao no arquivo XML (TAG annotation e
TAG documentation);
no incluir caracteres de formatao no arquivo XML ("line-feed",
"carriage return", "tab", caractere de "espao" entre as TAGs).

As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a
ser enviada.

3.3

Tipos Simples

A seguir encontra-se a tabela com a lista dos tipos simples que sero utilizados
como tipos de dados. A tabela est dividida em 4 colunas, a saber:

Campo: nome do tipo simples;

20

Tipo: tipo primitivo de dados utilizados pelo campo:

o C: Caractere;
o N: Nmero;
o D: Data ou Data/Hora;
Descrio: descreve informaes sobre o campo;
Tam.: tamanho do campo:
o Quando for caracteres, o tamanho define a quantidade mxima de
caracteres que o texto poder ter;
o Quando for numrico, o tamanho pode ser representado das
seguintes formas:


Nmero inteiro, que define o total de dgitos existente no nmero.
Exemplo: 15 significa que o nmero poder ter, no mximo, 15
dgitos;


Nmero fracionrio, que define o total de dgitos e quantos deles
sero designados para a parte fracionria. Exemplo: 15,2
significa que o nmero poder ter, no mximo, 15 dgitos sendo 2
deles a identificao da parte fracionria. A parte fracionria no
obrigatria quando assim definido;
o Quando for data, no haver definio de tamanho.

Campo

Tipo

Descrio
Nmero da Nota Fiscal de Servio Eletrnica, formado
pelo ano com 04 (quatro) dgitos e um nmero
seqencial com 11 posies Formato
AAAANNNNNNNNNNN.

Tam.

TsNumeroNfse

tsCodigoVerificacao

Cdigo de verificao do nmero da nota

TsStatusRps

Cdigo de status do DFS

1 Normal
2 Cancelado

TsStatusNfse

Cdigo de status da NFS-e

1 Normal
2 Cancelado

Cdigo de natureza da operao

5.2 - Imposto devido em Cachoeirinha, sem obrigao
de reteno na fonte,
5.3 - Imposto devido em Cachoeirinha com obrigao de
reteno na fonte,
5.8 - No Tributvel,
5.9 - Imposto recolhido pelo regime nico de
arrecadao,
6.2 - Imposto devido em Cachoeirinha, sem obrigao
de reteno na fonte,
6.3 - Imposto devido fora de Cachoeirinha, com
obrigao de reteno na fonte,
6.4 - Imposto devido fora de Cachoeirinha, sem
obrigao de reteno na fonte,
6.8 - No tributvel, 6.9 - Imposto recolhido pelo regime
nico de arrecadao,
7.8 - No tributvel,
7.9 - Imposto recolhido pelo regime nico de
arrecadao,
8.1 - Imposto recolhido por guia sem escriturao

Cdigo de identificao do regime especial de tributao

1 - Microempresa municipal
2 - Estimativa
3 - Sociedade de profissionais

tsNaturezaOperacao

tsRegimeEspecialTributacao

15

21

4 - Cooperativa
5 Microempresrio Individual (MEI)
6 Microempresrio e Empresa de Pequeno Porte (ME
e EPP)
TsSimNao

Identificao de Sim/No
1 - Sim
2 - No

TsQuantidadeRps

Quantidade de DFS do Lote

TsNumeroRps

Nmero do DFS

15

TsSerieRps

Nmero de srie do DFS

TsTipoRps

Cdigo de tipo de DFS

1 - DFS
2 - Nota Fiscal Conjugada (Mista)
3 - Cupom

tsOutrasInformacoes

Informaes adicionais ao documento.

255

Valor monetrio.
Formato: 0.00 (ponto separando casa decimal)
Ex: 1.234,56 = 1234.56
1.000,00 = 1000.00
1.000,00 = 1000

15,2

TsValor

tsItemListaServico

Cdigo de item da lista de servio

TsCodigoCnae

Cdigo CNAE

tsCodigoTributacao

Cdigo de Tributao

20

TsAliquota

Alquota. Valor percentual.

Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou 1

5,4

tsDiscriminacao

Discriminao do contedo da NFS-e

Cdigo de identificao do municpio conforme tabela do

IBGE

tsCodigoMunicipioIbge

2000
7

tsIncricaoMunicipal

Nmero de inscrio municipal

15

tsRazaoSocial

Razo Social do contribuinte

115

tsNomeFantasia

Nome fantasia

60

TsCnpj

Nmero CNPJ

14

tsEndereco

Endereo

125

tsNumeroEndereco

Nmero do endereo

10

tsComplementoEndereco

Complemento de endereo

60

tsBairro

Bairro

60

tsUf

Sigla da unidade federativa

tsCep

Nmero do CEP

tsEmail

E-mail

80

tsTelefone

Telefone

11

TsCpf

Nmero de CPF

11

tsIndicacaoCpfCnpj

Indicador de uso de CPF ou CNPJ

1 CPF
2 CNPJ
3 No Informado

tsCodigoObra

Cdigo de Obra

15

tsArt

Cdigo ART

15

tsNumeroLote

Nmero do Lote de DFS

15

TsNumeroProtocolo

Nmero do protocolo de recebimento do DFS

50

Cdigo de situao de lote de DFS

1 No Recebido
2 No Processado

tsSituacaoLoteRps

22

3 Processado com Erro

4 Processado com Sucesso
tsCodigoMensagemAlerta

Cdigo de mensagem de retorno de servio.

TsDescricaoMensagemAlerta

Descrio da mensagem de retorno de servio.

TsCodigoCancelamentoNfse

Cdigo de cancelamento com base na tabela de Erros e

alertas.

tsIdTag

Atributo de identificao da tag a ser assinada no

documento XML

3.4

4
200
4
255

Tipos Complexos

A seguir, sero detalhadas as tabelas de cada tipo composto e seus campos. A

tabela est dividida da seguinte forma:
(1)
(2)
Nome
(3)

Tipo

Ocorrncia

Descrio

(4)

(5)

(6)

(7)

(4)

(5)

(6)

(7)

1.
2.
3.
4.
5.
6.

Nome do tipo complexo;

Descrio do tipo complexo;
Identifica se a seqncia de campos far parte de uma escolha (Choice);
Nome do campo que faz parte do tipo complexo;
Tipo do campo, que pode ser de um tipo simples ou complexo;
Quantas vezes o campo se repete na estrutura de dados:
Formato: z-y onde x a quantidade mnima e y a quantidade mxima.
Se a quantidade mxima for indefinida, ser utilizado N no lugar do y;
7. Descrio do campo.
TcCpfCnpj
Nmero de CPF ou CNPJ
Nome
Choice

Tipo

Ocorrncia

Descrio

Cpf

tsCpf

1-1

Nmero do Cpf

Cnpj

tsCnpj

1-1

Nmero do Cnpj

TcEndereco
Representao completa do endereo
Nome

Tipo

Ocorrncia

Descrio

Endereco

tsEndereco

0-1

Endereo

Numero

tsNumeroEndereco

0-1

Nmero do endereo

Complemento

tsComplementoEndereco

0-1

Complemento do Endereo

Bairro

tsBairro

0-1

Nome do bairro

CodigoMunicipio

tsCodigoMunicipioIbge

0-1

Cdigo da cidade

Uf

tsUf

0-1

Sigla do estado

Cep

tsCep

0-1

CEP da localidade

23

TcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Nome

Tipo

Ocorrncia

Telefone

tsTelefone

0-1

Email

tsEmail

0-1

Descrio

tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador
Nome

Tipo

Ocorrncia

CodigoMunicipio

tsCodigoMunicipioIbge

1-1

Uf

tsUf

1-1

Descrio

tcIdentificacaoRps
Dados de identificao do DFS
Nome

Tipo

Ocorrncia

Numero

tsNumeroRps

1-1

Serie

tsSerieRps

1-1

Tipo

tsTipoRps

1-1

Descrio

tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
Nome

Tipo

Ocorrncia

Cnpj

tsCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

Descrio

tcIdentificacaoTomador
Representa dados para identificao do tomador de servio
Nome

Tipo

Ocorrncia

CpfCnpj

tcCpfCnpj

0-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

Descrio

tcDadosTomador
Representa dados do tomador de servio
Nome

Tipo

Ocorrncia

IdentificacaoTomador

TcIdentificacaoTomador

0-1

RazaoSocial

TsRazaoSocial

0-1

Endereco

TcEndereco

0-1

Contato

TcContato

0-1

Descrio

TcIdentificacaoIntermediarioServico
Representa dados para identificao de intermedirio do servio
Nome

Tipo

Ocorrncia

RazaoSocial

tsRazaoSocial

1-1

CpfCnpj

tcCpfCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

TcValores
Representa um conjunto de valores que compe o documento fiscal

Descrio

24

Nome
ValorServicos

Tipo

Ocorrncia

tsValor

ValorDeducoes

tsValor

0-1

ValorPis

tsValor

0-1

ValorCofins

tsValor

0-1

ValorInss

tsValor

0-1

ValorIr

tsValor

0-1

ValorCsll

tsValor

0-1

IssRetido

tsSimNao

1-1

ValorIss

tsValor

0-1

OutrasRetencoes

tsValor

0-1

BaseCalculo

tsValor

1-1

Aliquota

tsAliquota

0-1

ValorLiquidoNfse

Descrio

1-1

tsValor

(Valor dos servios - Valor das

dedues - descontos
incondicionados)
(ValorServicos - ValorPIS ValorCOFINS - ValorINSS - ValorIR ValorCSLL - OutrasRetenoes ValorISSRetido DescontoIncondicionado DescontoCondicionado)

0-1

ValorIssRetido

tsValor

0-1

DescontoCondicionado

tsValor

0-1

DescontoIncondicionado

tsValor

0-1

TcDadosServico
Representa dados que compe o servio prestado
Nome

Tipo

Ocorrncia

Valores

tcValores

1-1

ItemListaServico

tsItemListaServico

1-1

CodigoCnae

tsCodigoCnae

1-1

CodigoTributacaoMunicipio

tsCodigoTributacao

0-1

Discriminacao

tsDiscriminacao

1-1

CodigoMunicipio

tsCodigoMunicipioIbge

1-1

Descrio

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
Nome

Tipo

Ocorrncia

CodigoObra

tsCodigoObra

1-1

Art

tsArt

1-1

Descrio

tcDadosPrestador
Representa dados do prestador do servio
Nome

Tipo

Ocorrncia

IdentificacaoPrestador

tcIdentificacaoPrestador

1-1

RazaoSocial

tsRazaoSocial

1-1

NomeFantasia

tsNomeFantasia

0-1

Endereco

tcEndereco

1-1

Contato

tcContato

0-1

TcInfRps

Descrio

25

Representa dados informativos do Documento Fiscal de Servio (DFS)

Nome

Tipo

Ocorrncia

Descrio
Identificador da TAG a
ser assinada

Id

tsIdTag

IdentificacaoRps

TcIdentificacaoRps

1-1

DataEmissao

Datetime

1-1

NaturezaOperacao

TsNaturezaOperacao

1-1

RegimeEspecialTributacao

TsRegimeEspecialTributacao

0-1

OptanteSimplesNacional

TsSimNao

1-1

IncentivadorCultural

TsSimNao

1-1

Status

TsStatusRps

1-1

RpsSubstituido

TcIdentificacaoRps

0-1

Servico

TcDadosServico

1-1

Prestador

TcIdentificacaoPrestador

1-1

Tomador

TcDadosTomador

1-1

IntermediarioServico

tcIdentificacaoIntermediarioServico

0-1

ConstrucaoCivil

TcDadosContrucaoCivil

0-1

TcRps
Representa a estrutura do Documento Fiscal de Servio (DFS) assinado
Nome

Tipo

Ocorrncia

InfRps

tcInfRps

1-1

Signature

dsig:Signature

0-1

Descrio

tcIdentificacaoNfse
Representa dados que identificam uma Nota Fiscal de Servios Eletrnica
Nome

Tipo

Ocorrncia

Numero

tsNumeroNfse

Cnpj

tsCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

CodigoMunicipio

tsCodigoMunicipioIbge

Descrio

1-1

TcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Nome
Id

Tipo

Ocorrncia

Descrio
Identificador da TAG a
ser assinada

tsIdTag

Numero

tsNumeroNfse

1-1

CodigoVerificacao

tsCodigoVerificacao

1-1

DataEmissao

Datetime

1-1

IdentificacaoRps

tcIdentificacaoRps

0-1

DataEmissaoRps

Date

0-1

NaturezaOperacao

tsNaturezaOperacao

1-1

RegimeEspecialTributacao

tsRegimeEspecialTributacao

0-1

OptanteSimplesNacional

TsSimNao

1-1

IncetivadorCultural

TsSimNao

1-1

Competencia

Date

1-1

NfseSubstituida

tsNumeroNfse

0-1

OutrasInformacoes

tsOutrasInformacoes

0-1

Servico

tcDadosServico

1-1

26

ValorCredito

TsValor

0-1

PrestadorServico

tcDadosPrestador

1-1

TomadorServico

tcDadosTomador

1-1

IntermediarioServico

tcIdentificacaoIntermediarioServico

0-1

OrgaoGerador

tcIdentificacaoOrgaoGerador

1-1

ConstrucaoCivil

tcDadosContrucaoCivil

0-1

TcNfse
Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada
Nome

Tipo

Ocorrncia

InfNfse

tcInfNfse

1-1

Signature

Dsig:Signature

1-2

Descrio

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota Fiscal de
Servios Eletrnica.
Nome
Id

Tipo

Ocorrncia

Observao
Identificador da TAG a
ser assinada

tsIdTag

IdentificacaoNfse

tcIdentificacaoNfse

1-1

CodigoCancelamento

tsCodigoCancelamentoNfse

1-1

TcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome

Tipo

Ocorrncia

InfPedidoCancelamento

tcInfPedidoCancelamento

1-1

Signature

Dsig:Signature

0-1

Descrio

TcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Id

Tipo

Ocorrncia

Descrio
Identificador da TAG a
ser assinada

tsIdTag

Pedido

TcPedidoCancelamento

1-1

DataHoraCancelamento

datetime

1-1

TcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e.
Nome

Tipo

Ocorrncia

Confirmacao

TcConfirmacaoCancelamento

1-1

Signature

Dsig:Signature

1-1

Descrio

TcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e.
Nome

Tipo

Id

tsIdTag

NfseSubstituidora

tsNumeroNfse

Ocorrncia

Descrio
Identificador da TAG a ser
assinada

1-1

27

TcSubstituicaoNfse
Representa a estrutura de substituio de NFS-e.
Nome

Tipo

Ocorrncia

SubstituicaoNfse

tcInfSubstituicaoNfse

1-1

Signature

dsig:Signature

1-2

Descrio

TcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFS-e.
Nome

Tipo

Ocorrncia

Nfse

tcNfse

1-1

NfseCancelamento

tcCancelamentoNfse

0-1

NfseSubstituicao

tcSubstituicaoNfse

0-1

Descrio

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome

Tipo

Ocorrncia

Codigo

TsCodigoMensagemAlerta

1-1

Mensagem

tsDescricaoMensagemAlerta

1-1

Correcao

tsDescricaoMensagemAlerta

0-1

Descrio

ListaMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
MensagemRetorno

Tipo

Ocorrncia

tcMensagemRetorno

Descrio

1-N

tcMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio.
Nome
IdentificacaoRps

Tipo
TcIdentificacaoRps

Ocorrncia

Descrio

1-1

Codigo

TsCodigoMensagemAlerta

1-1

Mensagem

tsDescricaoMensagemAlerta

1-1

tcLoteRps
Nome

Tipo

Ocorrncia

Id

tsIdTag

NumeroLote

TsNumeroLote

1-1

Cnpj

TsCnpj

1-1

InscricaoMunicipal

TsInscricaoMunicipal

1-1

QuantidadeRps

TsQuantidadeRps

ListaRps
Rps

3.5

Observao
Identificador da TAG a ser
assinada

1-1
1-1

TcRps

1-N

Servios

A seguir, esto os servios disponveis, conforme descritos no item 2, no

WebService e seus XML Schema. O XML Schema define a estrutura e

28

formatao do arquivo XML que conter os dados a serem trafegados. Esses

documentos sero enviados de forma textual (como uma string) como
parmetros do servio oferecido pelo Web Service, de acordo com o descrito
em 2.2.1.
As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
#

Nome

Tipo

Pai

Ocorrncia

Observao

(2)

(3)

(4)

(5)

(6)

(7)

(8)

(9)

1.
2.
3.
4.
5.

Nmero identificador do campo, quando este contiver subitens;

Nome do campo;
Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo;
Indica quem o campo pai, para definio da hierarquia;
Quantas vezes o campo se repete na estrutura de dados:
Formato: z-y onde x a quantidade mnima e y a quantidade mxima.
Se a quantidade mxima for indefinida, ser utilizado N no lugar do y;
6. Descreve alguma observao pertinente;
7. Formato de grupo, utilizado para definio de uma escolha (ver prximo
item);
8. Identifica os campos ou grupos que faro parte de uma escolha (Choice).
3.5.1 Recepo de Lote de DFS
Esse servio ser executado, inicialmente, atravs da chamada ao mtodo
RecepcionarLoteRps, passando a mensagem XML como parmetro com a
estrutura definida na tabela que segue.
#
1

Nome

Tipo

Pai

Ocorrncia

EnviarLoteRpsEnvio

1-1

LoteRps

TcLoteRps

1-1

Signature

dsig:Signature

0-1

Observao

29

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#

Nome

Tipo

EnviarLoteRpsResposta

NumeroLote
DataRecebimento
Protocolo
ListaMensagemRetorno

Pai

Ocorrncia

Observao

1-1
tsNumeroLote
Datetime
tsNumeroProtocolo
ListaMensagemRetorno

1
1
1
1

1-1

Choice

1-1

O lote ser processado posteriormente, sendo o seu resultado disponibilizado

para consulta.

3.5.2 Recepo de Lote de at trs DFS

Esse servio ser executado, inicialmente, atravs da chamada ao mtodo
RecepcionarLoteRpsLimitado, passando a mensagem XML como parmetro
com a estrutura definida na tabela que segue.
#

Nome

EnviarLoteRpsEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

LoteRps

TcLoteRps

1-1

Signature

dsig:Signature

0-1

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#

Nome

Tipo

EnviarLoteRpsResposta

NumeroLote
DataRecebimento
Protocolo
ListaMensagemRetorno

Pai

Ocorrncia

Observao

1-1
tsNumeroLote
Datetime
tsNumeroProtocolo
ListaMensagemRetorno

1
1
1
1

1-1

Choice

1-1

O lote ser processado no momento do envio.

3.5.3 Consulta de Situao de Lote de DFS

Esse

servio

ser

executado

atravs

da

chamada

ao

mtodo

ConsultarSituacaoLoteRps, passando a mensagem XML como parmetro

com a estrutura definida na tabela que segue.

30

Nome

ConsultarSituacaoLoteRpsEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

Prestador

TcIdentificacaoPrestador

1-1

Protocolo

TsNumeroProtocolo

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#

Nome

ConsultarSituacaoLoteRpsRespo
sta

Tipo

NumeroLote
Situao
ListaMensagemRetorno

Pai

Ocorrncia

Observao

1-1
tsNumeroLote
tsSituacaoLoteRps
ListaMensagemRetorno

1
1
1

1-1

Choice

1-1

3.5.4 Consulta de NFS-e por DFS

Esse

servio

ser

executado

atravs

da

chamada

ao

mtodo

ConsultarNfsePorRps, passando a mensagem XML como parmetro com a

estrutura definida na tabela que segue.
#
1

Nome

Tipo

Pai

Ocorrncia

Observao

ConsultarNfseRpsEnvio
IdentificacaoRps

tcIdentificacaoRps

1-1

Prestador

tcIdentificacaoPrestador

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#
1
2

Nome

Tipo

Pai

Ocorrncia

Observao

ConsultarNfseRpsResposta
CompNfse

tcCompNfse

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

3.5.5 Consulta de NFS-e

Esse servio ser executado atravs da chamada ao mtodo ConsultarNfse,
passando a mensagem XML como parmetro com a estrutura definida na
tabela que segue.
#

Nome

ConsultarNfseEnvio

Tipo

Pai

Ocorrncia
1-1

Prestador

tcIdentificacaoPrestador

NumeroNfse

tsNumeroNfse

1-1

1-1

PeriodoEmissao

1-1

DataInicial

date

1-1

DataFinal

date

1-1

Observao

31

Tomador

tcIdentificacaoTomador

IntermediarioServico

TcIdentificacaoIntermediarioS
ervico

1
1

1-1
0-1

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#

Nome

Tipo

ConsultarNfseResposta

ListaNfse

Pai

Ocorrncia

Observao

1-1

CompNfse

tcCompNfse

1-1
0-N

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

3.5.6 Consulta de Lote de DFS

Esse

servio

ser

executado

atravs

da

chamada

ao

mtodo

ConsultarLoteRps, passando a mensagem XML como parmetro com a

estrutura definida na tabela que segue.
#
1

Nome

Tipo

Pai

ConsultarLoteRpsEnvio

Ocorrncia

Observao

1-1

Prestador

TcIdentificacaoPrestador

1-1

Protocolo

TsNumeroProtocolo

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#
1
2
3

Nome

Tipo

Pai

ConsultarLoteRpsResposta

Ocorrncia

Observao

1-1
1

1-1

CompNfse

ListaNfse
tcCompNfse

1-N

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

3.5.7 Cancelamento NFS-e

Esse servio ser executado atravs da chamada ao mtodo CancelarNfse,
passando a mensagem XML como parmetro com a estrutura definida na
tabela que segue.
#
1

Nome

Tipo

Pai

CancelarNfseEnvio
Pedido

Ocorrncia
1-1

TcPedidoCancelamento

1-1

Observao

32

Em resposta a chamada do servio ser devolvida a estrutura definida na

tabela a seguir.
#
1

Nome

Cancelamento
2

Tipo

Pai

Ocorrncia

Observao

CancelarNfseResposta

ListaMensagemRetorno

TcCancelamentoNfse
ListaMensagemRetorno

1-1

1-1
0-N

Choice

33

ANEXO

4.1

Tabela de Erros

Cdig Mensagem
o

Soluo
Reenvie asssinatura do Hash conforme
estabelecido no Manual de Instruo da NFS-e

algoritmo

E1

Assinatura do Hash no confere

E2

Data de competncia superior a de emisso do Informe uma data de competncia inferior ou igual a de
RPS ou da Nota
emisso do RPS ou da Nota.

E3

Natureza da operao no informada.

Utilize um dos tipos: 5.0 - Prestao de Servios no

Municpio, 5.2 - Imposto devido em Cachoeirinha, sem
obrigao de reteno na fonte, 5.3 - Imposto devido em
Cachoeirinha com obrigao de reteno na fonte, 5.8 - No
Tributvel, 5.9 - Imposto recolhido pelo regime nico de
arrecadao, 6.0 - Prestao de Servios para outros
municpios da federao, 6.2 - Imposto devido em
Cachoeirinha, sem obrigao de reteno na fonte, 6.3 Imposto devido fora de Cachoeirinha, com obrigao de
reteno na fonte,
6.4 - Imposto devido fora de
Cachoeirinha, sem obrigao de reteno na fonte, 6.8 No tributvel, 6.9 - Imposto recolhido pelo regime nico de
arrecadao, 7.0 - Prestao de Servios para o Exterior,
7.8 - No tributvel, 7.9 - Imposto recolhido pelo regime
nico de arrecadao, 8.0 - Prestao de servios de
competncias anteriores, 8.1 - Imposto recolhido por guia
sem escriturao

E4

Esse RPS no foi enviado para a nossa base de

Envie o RPS para emisso da NFS-e.
dados

E5

O nmero da NFS-E substituda informado no Informe um nmero de NFS-E substituda que j tenha sido
existe na base de dados do municpio.
emitida.

E6

O cancelamento de uma NFS-e com crdito deve ser feito

Essa NFS-e no pode ser cancelada atravs
atravs de processo administrativo aberto em uma repartio
desse servio, pois h crdito informado
fazendria.

E7

Essa NFS-e j foi substituda

E8

Campo de optante pelo simples nacional no

Utilize um dos tipos: 1 Sim; 2 - No.
informado

E9

Campo de incentivador cultural no informado

E10 RPS j informado.

Confira e informe novamente os dados da NFS-e que deseja

substituir.

Utilize um dos tipos: 1 Sim; 2 - No.

Para essa Inscrio Municipal/CNPJ j existe um RPS
informado com o mesmo nmero, srie e tipo.

E11 Nmero do RPS no informado

Informe o nmero do RPS

E12 Tipo do RPS no informado

Informe o tipo do RPS

E13 Campo tipo do RPS invlido.

Utilize um dos tipos especificados: "RPS", "RPS-C" ou "RPSM".

E14 Data da emisso do RPS no informada

Informe a Data da emisso do RPS no formato Date

E15 Data da emisso do RPS invlida

Informe a Data da emisso do RPS no formato Date

E16

A data da emisso do RPS no poder ser

Informe uma data de emisso de RPS vlida
superior a data de hoje

A data da emisso do RPS no poder ser

E17 inferior data de habilitao do prestador para Informe uma data de emisso de RPS vlida
emisso da NFS-e.
E18

O valor dos servios dever ser superior a R$

No permitido envio de valor de servios igual a zero.
0,00 (zero)

E19

O valor das dedues dever ser inferior ou igual No permitido valor de deduo superior ao valor de
ao valor dos servios
servios.

E20

O valor das dedues dever ser superior ou

No permitido valor de deduo inferior a zero (negativo).
igual a R$ 0,00 (zero)

E21

O valor dos descontos dever ser inferior ou igual No permitido valor de desconto superior ao valor de
ao valor dos servios
servios.

E22

O valor dos descontos dever ser superior ou

No permitido valor de desconto inferior a zero (negativo).
igual a R$ 0,00 (zero)

34

E23

O valor do PIS dever ser superior ou igual a R$

No permitido valor de reteno inferior a zero (negativo).
0,00 (zero)

E24

O valor da Cofins dever ser superior ou igual a

No permitido valor de reteno inferior a zero (negativo).
R$ 0,00 (zero)

E25

O valor do INSS dever ser superior ou igual a

No permitido valor de reteno inferior a zero (negativo).
R$ 0,00 (zero)

E26

O valor do IR dever ser superior ou igual a R$

No permitido valor de reteno inferior a zero (negativo).
0,00 (zero)

E27

O valor da CSLL dever ser superior ou igual a

No permitido valor de reteno inferior a zero (negativo).
R$ 0,00 (zero)

Item da lista de servio informado incompatvel

Consulte a legislao vigente para saber se o item informado
E28 com a informao de optante pelo simples
permite a opo pelo simples nacional
nacional
E29

O cdigo de servio prestado no permite Altere o campo "ISS Retido" para: 2 (Nota Fiscal sem ISS
reteno de ISS.
Retido).

E30 Item da lista de servio inexistente

Consulte a legislao vigente para saber o item da lista de

servio que dever ser informado neste campo.

E31

Item da lista de servio no informado para a

Informe o item relativo ao servio prestado nessa operao.
operao

E32

Cdigo CNAE informado incompatvel com a Consulte a legislao vigente para saber se o cdigo
informao de optante pelo simples nacional
informado permite a opo pelo simples nacional.

E33 Cdigo CNAE inexistente

Consulte a legislao vigente para saber o cdigo CNAE que

dever ser informado neste campo.

Cdigo de tributao informado incompatvel

Consulte a legislao vigente para saber se o cdigo
E34 com a informao de optante pelo simples
informado permite a opo pelo simples nacional.
nacional
E35 Cdigo de tributao inexistente

Consulte a legislao vigente para saber o Cdigo de

tributao que dever ser informado neste campo.

E36 Campo ISSRetido invlido.

Utilize um dos tipos: 1 para ISS Retido ou 2 para ISS no

Retido.

E37

Operaes isentas, imunes ou com exigibilidade suspensa

Apenas servios tributados, no municpio ou fora,
por deciso judicial ou procedimento administrativo no
podem sofrer reteno de ISS
podem sofrer reteno de ISS.

E38

Contribuintes enquadrados como MEI do simples No faa a reteno do ISS nos casos de empresas
nacional, Microempresa Municipal, Estimativa, enquadradas como MEI do simples nacional, Microempresa
Sociedade de Profissionais ou Incentivador Municipal, Estimativa, Sociedade de Profissionais ou
Cultural no podem sofrer reteno de ISS.
Incentivador Cultural.

O CNPJ e/ou a Inscrio Municipal informada do tomador

Apenas empresas tomadoras de servios no foi encontrada na base de dados do municpio, no
E39 inscritas neste municipio podem efetuar reteno sendo permitida a reteno. Acerte o CNPJ e/ou Inscrio
de ISS.
Municipal ou altere o campo ISS Retido para 2 (Sem
reteno de ISS).
E40 Valor do ISS retido no informado.

O valor do ISS retido deve ser informado quando o campo

"IssRetido" for marcado com 1- Sim.

E41

O campo discriminao dos servios no foi O preenchimento da discriminao dos servios obrigatrio
preenchido.
por lei, devendo ser preenchido adequadamente.

E42

Cdigo do municpio da prestao do servio Consulte a tabela do IBGE e utilize um dos tipos listados na
invlido
tabela

E43

Inscrio Municipal do prestador no encontrada

Informe a inscrio municipal correta do prestador.
na base de dados do municpio.

E44 CNPJ do prestador invlido

Informe o nmero do CNPJ correto do prestador.

E45 CNPJ no encontrado na base de dados

Confira o numero do CNPJ informado. Caso esteja correto, o

prestador no est inscrito no municpio.

E46 CNPJ do prestador no informado

Informe o CNPJ do prestador.

E47 CPF/CNPJ do tomador invlido

Informe o CPF/CNPJ correto do tomador.

O campo CPF/CNPJ do tomador dever ser

Preencher o campo CPF/CNPJ do Tomador com zeros
E48 preenchido com zeros quando for de CPF noquando se tratar de tomador com CPF no informado.
informado.
E49 Lote de RPS com excesso de inconsistncias.

O servio de validao de RPS abortado quando atinge o

nmero de 50 inconsistncias. Corrija os erros e reenvie o
lote de RPS.

35

E50 Inscricao Municipal do pretador invlida

Informe a inscricao municipal correta do prestador.

E51 Inscricao Municipal do tomador invlida

Informe a inscricao municipal correta do tomador.

E52

O tomador de servios informado o prprio Na emisso da NFS-e no permitido que o prestador seja
prestador.
igual ao tomador.

O campo Inscrio Municipal do tomador s

Para tomadores estabelecidos fora deste municpio no
E53 dever
ser
preenchido
para
tomadores
preencher inscrio municipal.
estabelecidos neste municpio
E54

CNPJ do tomador (<CNPJ enviado>) est Informe a Inscrio Municipal do tomador vinculada ao CNPJ
vinculado a mais de uma inscrio municipal.
informado.

E55

Endereo
do
tomador
(logradouro)
corresponde ao CEP informado

E56

Campo endereo do tomador no informado O preenchimento do endereo (logradouro) obrigatrio

(obrigatrio para tomador com CNPJ)
para tomadores Pessoas Jurdicas (com CNPJ).

no Corrija o endereo (logradouro) ou o CEP do tomador do

servio

E57 Bairro no corresponde ao CEP informado

Corrija o Bairro ou o CEP do tomador do servio

E58

Cdigo do municipio do tomador no corresponde Corrija o codigo do municipio ou o CEP do tomador do

ao CEP informado
servio

E59

Campo cidade do tomador no

(obrigatrio para tomador com CNPJ)

E60

A cidade do tomador informada no

encontrada na base de dados da prefeitura.

E61

Sigla da UF do tomador no corresponde ao CEP

Corrija a sigla da UF ou o CEP do tomador do servio
informado

informado O preenchimento da Cidade do Tomador obrigatrio para

tomadores Pessoas Jurdicas (com CNPJ).

E62 Cep no existe na tabela DNE dos Correios.

foi Informe a cidade correta do tomador. No caso de cidade do

exterior (fora do pas), informe o campo com 99999.

Informar o Cep correto

Razao social do intermedirio do servio no

E63 informada com CNPJ/CPF ou Inscrio Municipal Informe a razao social do intermedirio do servio
do intermedirio informada.
E64

Inscrio Municipal do intermedirio do servio Informe a Inscrio Municipal correta do intermedirio do

invlida
servio.

E65

Inscrio Municipal do intermedirio do servio Acerte a Inscrio Municipal

no esta vinculada ao CNPJ/CPF informado.
intermedirio do servio.

ou

CNPJ/CPF

E66 CNPJ/CPF do Intermediario do Servio invalido

Informe o CNPJ/CPF correto do intermediario do servio.

E67 Cdigo da obra invlido

Informe o cdigo da obra correto

E68 Status do RPS invlido

Utilize um dos tipos:1 Normal; 2 Cancelado;

E69 Quantidade de RPS incorreta

Informe a quantidade de RPS correta

do

Inscrio Municipal do prestador especificada no

Informe corretamente a Inscrio Municipal do prestador no
E70 lote no confere com o prestador informado no
lote e no RPS.
RPS.
E71 RPS em duplicidade no arquivo enviado.
Campo
Quantidade
E72
incorretamente.

de

RPS

Remova do arquivo o registro de RPS excedente.

informado O campo quantidade de RPS numrico e dever ter

tamanho mximo de 4 dgitos.

Data de emisso da Nota Fiscal no est

Utilize no cabealho do arquivo datas de emisso da Nota
compreendida entre <data inicio de emisso do
E74
Fiscal compreendidas entre a data incio de emisso do lote
lote> e <data fim de emisso do lote> conforme
e a data fim de emisso do lote.
especificado no cabealho do arquivo.
E75

Nmero do RPS substitudo no informado para

Informe o nmero do RPS substitudo.
status do RPS igual a "3"

E76

O nmero do RPS substitudo informado no

Informe o nmero do RPS substitudo correto
existe na base de dados

E77 Nmero da NFS-e no informado

E78

Informe o nmero da NFS-e.

Nmero da NFS-e inexistente na base de dados

Informe o nmero correto da NFS-e.
para o prestador de servio pesquisado

E79 Essa NFS-e j est cancelada

Confira e informe novamente os dados da NFS-e que deseja

cancelar.

E80 Cdigo de verificao no informado

Informe o cdigo de verificao da NFS-e.

E81

Cdigo de verificao no corresponde NFS-e

Informe o cdigo de verificao correto.
consultada

E82

Pesquisa pela atividade s pode ser feita com a

Informe um cep ou um bairro.
indicao de um cep ou bairro

36

E83

Campo Inscrio Municipal do tomador informado O campo Inscrio Municipal do tomador numrico e
incorretamente
dever ter tamanho mximo de 15 dgitos.

E84

Pesquisa pelo cep s pode ser feita com a

Informe uma atividade.
indicao de uma atividade

E85

Pesquisa pelo bairro s pode ser feita com a

Informe uma atividade.
indicao de uma atividade

E86

Nmero do protocolo de recebimento do lote Confira se o lote foi enviado e informe o nmero correto do
inexistente na base de dados
protocolo de recebimento.

E87 Nmero de lote inexistente na base de dados

Confira se o lote foi enviado e informe o nmero correto.

E88 Nmero de lote no informado

Informe o nmero do lote.

No existe na base de dados uma NFS-e emitida

E89
Informe o nmero correto do RPS.
para o nmero de RPS informado
Informe um nmero de RPS que corresponda seqncia
utilizada pelo prestdor de servio.

E90 Nmero do RPS invlido

E91

Esse RPS no foi enviado para a nossa base de

Exija do prestador do servio a emisso da NFS-e.
dados

E92

Esse RPS foi enviado para a nossa base de

Faa uma nova consulta mais tarde.
dados, mas ainda no foi processado

E93 Srie informada invlida

Informe a srie correta para o RPS pesquisado.

E94 Data de competncia no informada.

Informe a data de competncia no formato data.

E95 Data de competncia informada incorretamente.

Informe a data de competncia no formato data.

E96

Campo
nmero
incorretamente

do

RPS

informado O campo Nmero do RPS nmerico e dever ter tamanho

mximo de 15 dgitos.

E97 Campo srie do RPS informado incorretamente

O campo Srie do RPS alfa-nmerico e dever ter

tamanho mximo de 5 caracteres.

E98 Valor dos servios no informado.

Informe o valor dos servios.

E99

Valor da reteno dever ser inferior ou igual ao No permitido valor de reteno superior ao valor de
valor dos servios
servios.

E100

Campo
valor
incorretamente

dos

servios

informado

O campo valor dos servios nmerico e dever ter

tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e
dois decimais.

E101 Campo dedues informado incorretamente

O campo valor das dedues nmerico e dever ter

tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e
dois decimais.

E102 Campo descontos informado incorretamente

O campo valor dos descontos nmerico e dever ter

tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e
dois decimais.

tributo

federal

informada

O campo referente a reteno de tributo federal nmerico e

dever ter tamanho mximo de 15,2, ou seja, 15 nmeros
inteiros e dois decimais.

E103

Retenao
de
incorretamente

E104

Campo item da lista de servio informado O campo item da lista de servio dever ter tamanho mximo
incorretamente
de 4 caracteres.

E105 Campo cdigo CNAE informado incorretamente

O campo cdigo CNAE dever ter tamanho mximo de 7

caracteres.

E106

Campo cdigo de tributao

informado incorretamente

E107

Campo discriminao
incorretamente.

E108

Campo municpio da prestao do servio O campo municpio da prestao do servio dever ter
informado incorretamente.
tamanho mximo de 7 dgitos.

E109

Campo
cidade
incorretamente.

E110

Quando a natureza da operao for tributao

fora do municpio, o campo municpio da
Informar o municpio da prestao do servio corretamente.
prestao do servio dever ser diferente do
municpio do prestador

do

do

do

municpio O campo cdigo de tributao do municpio dever ter

tamanho mximo de 20 caracteres.

servio

informado O campo discriminao do servio dever ter tamanho

mximo de 2000 caracteres.

tomador

informado O campo cidade do tomador dever ter tamanho mximo de

7 dgitos, consulte tabela do IBGE..

E111 Municpio da prestao do servio no informado.

E112

Informe o municpio da prestao do servio, de acordo com

a tabela do IBGE.

Campo Inscrio Municipal do intermediario O campo Inscrio Municipal do intermediario numrico e

informado incorretamente
dever ter tamanho mximo de 15 dgitos.

37

E113

Campo nmero do endereo do tomador no A informao do nmero do endereo do tomador

informado (obrigatrio para tomador com CNPJ) obrigatria para tomadores pessoas jurdicas (com CNPJ).

E114

Campo bairro do tomador no

(obrigatrio para tomador com CNPJ)

E115

Campo UF do tomador no informado (obrigatrio O preenchimento da UF do tomador obrigatrio para

para tomador com CNPJ)
tomadores pessoas jurdicas (com CNPJ).

E116

Informe a UF correta do tomador. Em caso de cidades do

A UF do tomador informada no foi encontrada
exterior (fora do pas), preencher a UF com "EX" e a cidade
na base de dados.
do tomador com 99999.

E117

Campo razo social do tomador informado O campo razo social do tomador dever ter tamanho
incorretamente.
mximo de 115 caracteres.

informado A informao do bairro do tomador obrigatria para

tomadores Pessoas Jurdicas (com CNPJ).

E118 Campo razo social do tomador no informado

do

E119

Campo endereo
incorretamente.

E120

Campo nmero do endereo

informado incorretamente.

E121

Campo complemento do endereo do tomador O campo complemento do endereo do tomador dever ter
informado incorretamente.
tamanho mximo de 60 caracteres.

E122

Campo
bairro
incorretamente.

E123

Campo AliquotaServicos no informado para Informe a aliquota do ISS quando a tributao for fora do
tributao fora do municpio.
municpio

do

tomador

O campo razo social do tomador dever ser informado

quando o campo Indicador de CPF/CNPJ do tomador for
preenchido com 1 - CPF ou 2 - CNPJ.

informado O campo endereo do tomador dever ter tamanho mximo

de 125 caracteres.

do

tomador

tomador O campo nmero do endereo do tomador dever ter

tamanho mximo de 10 caracteres.

informado O campo bairro do tomador dever ter tamanho mximo de

60 caracteres.

E124 Campo UF do tomador informado incorretamente.

do

O campo UF do tomador dever ter tamanho mximo de 2

caracteres.

E125

Campo
CEP
incorretamente.

E126

Campo
e-mail
incorretamente.

E127

Campo
telefone
incorretamente.

E128

Campo razo social do intermedirio do servio O campo razo social do intermedirio do servio dever ter
informado incorretamente.
tamanho mximo de 115 caracteres.

do
do

tomador

informado O campo CEP do tomador dever ter tamanho mximo de 8

dgitos.

tomador

informado O campo e-mail do tomador dever ter tamanho mximo de

80 caracteres.

tomador

informado O campo telefone do tomador dever ter tamanho mximo

de 11 caracteres.

E129 Campo cdigo da obra informado incorretamente.

O campo cdigo da obra dever ter tamanho mximo de 15

caracteres.

E130 Campo ART informado incorretamente.

O campo ART dever ter tamanho mximo de 15 caracteres.

E131 Campo data inicial preenchido incorretamente

A data informada dever estar no formato DD/MM/AAAA, ou

seja, dia (2 dgitos), seguido de ms (2 dgitos) e ano (4
dgitos) e deve ser uma data vlida.

E132 Campo data final preenchido incorretamente

A data informada dever estar no formato DD/MM/AAAA, ou

seja, dia (2 dgitos), seguido de ms (2 dgitos) e ano (4
dgitos) e deve ser uma data vlida.

E133

Data final da pesquisa no poder ser supeiror a

Informe uma data final igual ou anterior a data de hoje
data de hoje.

E134 A data final no poder ser anterior data inicial

Informe uma data final igual ou superior a data inicial da

pesquisa

E135

O perodo de pesquisa no poder ser superior a

Limitar as datas de incio e final a um perodo de um ano
um ano.

E136

Campo
nmero
incorretamente

E137

Data de emisso
incorretamente

da
da

NFS-e
NFS-e

informado O campo nmero da NFS-e nmerico e dever ter tamanho

mximo de 15 dgitos.
informada Informe a data correta da emisso da NFS-e a ser
consultada.

E138 CNPJ no autorizado a realizar o servio

Informe o CNPJ autorizado a executar o servio.

Campo nmero da NFS-e substituda informado O campo nmero da NFS-e substituda nmerico e dever
E139
incorretamente
ter tamanho mximo de 15 dgitos.
E140 Bairro do prestador inexistente
E141 Inscrio Municipal do prestador no informada

informe a Inscrio Municipal do prestador.

Inscrio Municipal do prestador

E142
vinculada ao CNPJ informado.

Acerte a Inscrio Municipal ou o CNPJ do prestador.

no

est

38

E143

Inscrio Municipal do tomador

vinculada ao CNPJ informado.

no

est

Acerte a Inscrio Municipal ou o CNPJ do tomador.

E144 Natureza da operao invlida.

Utilize um dos tipos: 5.0 - Prestao de Servios no

Municpio, 5.2 - Imposto devido em Cachoeirinha, sem
obrigao de reteno na fonte, 5.3 - Imposto devido em
Cachoeirinha com obrigao de reteno na fonte, 5.8 - No
Tributvel, 5.9 - Imposto recolhido pelo regime nico de
arrecadao, 6.0 - Prestao de Servios para outros
municpios da federao, 6.2 - Imposto devido em
Cachoeirinha, sem obrigao de reteno na fonte, 6.3 Imposto devido fora de Cachoeirinha, com obrigao de
reteno na fonte,
6.4 - Imposto devido fora de
Cachoeirinha, sem obrigao de reteno na fonte, 6.8 No tributvel, 6.9 - Imposto recolhido pelo regime nico de
arrecadao, 7.0 - Prestao de Servios para o Exterior,
7.8 - No tributvel, 7.9 - Imposto recolhido pelo regime
nico de arrecadao, 8.0 - Prestao de servios de
competncias anteriores, 8.1 - Imposto recolhido por guia
sem escriturao

E145 Regime Especial de Tributao invlido.

Utilize um dos tipos: 1 Microempresa Municipal; 2

Estimativa; 3 Sociedade de Profissionais; 4 Cooperativa;
5 Microempresrio Individual (MEI); 6 Microempresrio e
Empresa de Pequeno Porte (ME EPP).

E146

Informao de optante pelo simples nacional

Utilize um dos tipos: 1 Sim; 2 - No.
invlida.

E147 informao de incentivador cultural invlida.

Utilize um dos tipos: 1 Sim; 2 - No.

E148 Status do RPS no informado

Informe o status do RPS.

O campo CNPJPrestador nmerico e dever ter tamanho

E149 Campo CNPJPrestador informado incorretamente
mximo de 14 dgitos.
E150 Srie do RPS no informada

Campo de preenchimento obrigatrio, caso no utilize srie,

preencha o campo com 00000.

E151 Quantidade de RPS no informada

Informe a quantidade de RPS.

E152 Campo ISSRetido no informado.

Informe um dos tipos: 1 para ISS Retido ou 2 para ISS no

Retido.

O campo ValorISSRetido nmerico e dever ter tamanho

E153 Campo ValorISSRetido informado incorretamente mximo de 15,2, ou seja, 15 nmeros inteiros e dois
decimais.
E154

Campo CNPJ/CPF do Intermediario do Servio O campo CNPJ/CPF do Intermediario do Servio nmerico

informado incorretamente
e dever ter tamanho mximo de 14 dgitos.

E155

Campo
CPFCNPJTomador
incorretamente

informado O campo CPFCNPJTomador nmerico e dever ter

tamanho mximo de 14 dgitos.

E156 CNPJ do prestador no autorizado a emitir NFS-e

Solicite autorizao para emitir NFS-e para o CNPJ

informado.

E157

Usurio no est autorizado a utilizar esse Solicite ao contribuinte autorizao para utilizar o servio em
servio para esse contribuinte.
seu nome.

E158

Campo Inscrio Municipal

informado incorretamente

E159

CNPJ do prestador especificado no lote no Informe corretamente o CNPJ do prestador no lote e no

confere com o prestador informado no RPS.
RPS.

E160

Arquivo enviado fora da estrutura do arquivo XML Envie um arquivo dentro do schema do arquivo XML de
de entrada.
entrada.

E161

Campo ValorISS no informado para tributao Informe o valor do ISS quando a tributao for fora do
fora do municpio.
municpio

E162

A alquota do ISS de ME ou EPP do simoles nacional deve

Alquota do ISS de ME ou EPP do simples
ficar entre 2% e 5%, conforme enquadramento na tabela de
nacional informada incorretamente
receita do simples nacional.

do

prestador O campo Inscrio Municipal do prestador numrico e

dever ter tamanho mximo de 15 dgitos.

Campo AliquotaServicos no informado para ME

Informe a aliquota do ISS de acordo com o enquadramento
E163 ou EPP do simples nacional com reteno do
da ME ou EPP na tabela de receita do simples nacional.
ISS.
E164 Campo ValorISS informado incorretamente.
E165

Campo
AliquotaServicos
incorretamente

O campo ValorISS nmerico e dever ter tamanho mximo

de 15,2, ou seja, 15 nmeros inteiros e dois decimais.

informado O campo AliquotaServicos nmerico e dever ter tamanho

mximo de 5,2, ou seja, 5 nmeros inteiros e dois decimais..

39

E166

Quando se tratar de empresa optante do simples nacional

Campo RegimeEspecialTributao no informado marcar o campo RegimeEspecialTributao com uma das
para empresa optante do simples nacional..
opes: 05 - MEI do simples nacional ou 06 - ME ou EPP
do simples nacional.

E167 Campo IndicaoCPFCNPJ no informado

Utilize um dos tipos: 1 CPF; 2 - CNPJ; 3 - No informado.

informado

O Campo IndicaoCPFCNPJ numrico, com tamanho

maximo de 1 dgito e dever ser utilizado um dos tipos:: 1
CPF; 2 - CNPJ; 3 - No informado.

E168

Campo
IndicaoCPFCNPJ
incorretamente.

E169

Municpio informado no pertence Unidade

Acerte o municpio ou a Unidade Federartiva.
Federativa.

E170

Campo Cep do tomador no deve ser preenchido Deixe o campo Cep do tomador em branco em caso de
para tomador do exterior.
tomador do exterior.

E171

Campo CPF/CNPJ do tomador no deve ser Deixe o campo CPF/CNPJ do tomador em branco em caso
preenchido para tomador do exterior.
de tomador do exterior.

O documento que realizou a assinatura do lote de

E172 RPS no possui autorizao para realizar esse Acerte a assinatura do lote do RPS.
servio.
E173

O documento que realizou a assinatura do RPS

Acerte a assinatura do RPS.
no possui autorizao para realizar esse servio.

E174 Arquivo enviado com erro na assinatura.

Acerte a assinatura do arquivo.

E175 Lote sem assinatura.

Assine o lote de RPS

E176 RPS sem assinatura.

Assine o RPS

O somatrio das dedues e do desconto

O somatrio das dedues e do desconto incondicionado
E177 incondicionado est maior que o valor dos
dever ser inferior ou igual ao valor dos servios
servios
O somatrio dos descontos, retenes federais e
O somatrio dos descontos, retenes federais e ISS retido
E178 ISS retido na fonte est maior que o valor dos
na fonte dever ser inferior ou igual ao valor dos servios
servios
E179

Pessoa Fsica no pode efetuar a reteno do

Acerte o campo do ISS retido ou do tomador do servio.
ISSQN

E180 O lote foi recebido mas no foi processado.

Aguarde para fazer a consulta novamente.

O documento XML de entrada do servio est Acerte o arquivo

E181
fora do padro
especificado.

de

acordo

com

XML

Schema

E182 Erro na autenticao.

O usurio correspondente ao documento utilizado para

autenticao no possui autorizao para realizar o servio
para a empresa parametrizada via CNPJ e inscrio
municipal do arquivo.

E183 Pedido de Cancelamento no est assinado.

O documento XML de dados de pedido de cancelamento no

est assinado digitalmente.

E184 E-mail do tomador de servios invlido

Utilize um E-mail no formato vlido.

E185 Telefone do tomador de servios invlido

Utilize um Telefone no formato vlido.

A data de emisso do RPS no pode ser inferior A gerao de NFS-e s permitida para competncia
E186 data de autorizao da empresa para gerao superior data de autorizao da empresa. No utilize
de NFS-e.
competncias anteriores essa data.
E187

Requisio
no
est
acompanhada
autenticao via certificao digital.

da necessrio efetuar o processo de autenticao SSL

bidirecional no sistema cliente.

E188

O documento XML do cabealho de dados esta Acerte o arquivo

fora do padrao especificado.
especificado.

E189

A verso de dados no mais suportada pelo Utilize uma verso de dados suportada para requisio dos
sistema.
servios.

com

XML

Schema

Requisio invlida. No conseguiu capturar o Verifique sua mensagem SOAP e a passagem desses
parmetro nfseCabecMsg e/ou nfseDadosMsg. parmetros necessrios.
Utilize uma verso de dados suportada para requisio dos
servios.

E192 A verso do cabealho no existe.

E500

acordo

Utilize uma verso de dados existente e suportada pelo

sistema.

E190 A verso de dados no existe.

E191

de

Nmero de
remessas

Lote

informado

em

E501 Valor do ISS informado incorretamente

outras

O nmero do Lote dever ter ser sequencial sem repeties

O clculo do valor do ISS igual [Base de clculo * alquota
/ 100]

40

E502 Atividade No Localizada

Cancelamento
E503
Lanado.

No

permitido.

Atividade No Localizada
Faturamento
Lote

no

Estorne o Faturamento

E504

Cancelamento No permitido.
processado com sucesso.

E505

Cdigo de Cancelamento No existe na tabela de

Use um cdigo vlido da tabela de erros e alertas
erros e alertas

Somente notas processadas podem ser canceladas

E506 Cancelamento de Nota

E507

O Valor do ISS deve ser ZERO para a natureza

Natureza escolhida NO tem tributao
escolhida

E508 Este Recibo provisrio j foi substituido

No pode ser substitudo um recibo provisrio j substitudo

E509

O Recibo provisrio substituido j uma NFS-E, O Recibo provisrio substituido j uma NFS-E, no pode
no pode mais ser substituido
mais ser substituido

E510

Para o processamento sncrono, o lote dever

O lote dever possuir no mximo 3 notas.
possuir no mximo 3 notas.

E511

Para a natureza escolhida, o tomador no pode Altere a natureza da operao ou o tipo do tomador de
ser pessoa fsica
servio.

E512 Valor da Base de Clculo est incorreto

Base
de
Clculo
=
valordescontoincondicionado

E513 Valor Lquido est incorreto

"Valor Lquido Nota = valorBruto - ValorPIS - ValorCOFINS ValorINSS - ValorIR - ValorCSLL - OutrasRetencoes ValorISSRetido
valorDescontoIncondicionado
valorDescontoCondicionado"

E514

valorBruto-valorDeducao-

Erro! No foi possivel converter os dados do XML

enviado.

E515 Erro ao validar assinatura

Devido a uma indisponibilidade do servio, no foi
processar
a
solicitao.
E516 possvel
novamente dentro de alguns instantes.

Tente

Ocorreu um erro de execuo no banco de

E517

dados. Contate o administrador do sistema.

Ocorreu um erro inesperado, por favor tente

E518 novamente. Caso o erro continue ocorrendo,

contate o administrador do sistema.
Web-Service de uso exclusivo da nota digitada ou
E519

para .xml importado via ERP.

E520 Nmero do protocolo no informado.

4.2

Informe o nmero do protocolo.

Tabela de Alertas

Cdigo

Mensagem

Soluo

A1

Item da lista de servio, cdigo CNAE ou cdigo

Verifique se o item ou cdigo informado est

de tributao informado para a operao no

correto. Se estiver, proceda a atualizao cadastral

est cadastrado para o prestador de servio

junto Prefeitura assim que possvel, pois o item ou

cdigo informado no est cadastrado para a sua
inscrio municipalItem da Lista de Servio, Cdigo
CNAE ou Cdigo de Tributao.

A2

A3

Item da lista de servio, cdigo CNAE ou cdigo

Consulte a legislao vigente para saber se o item

de tributao informado para a operao no

ou cdigo informado permite deduo da base de

permite deduo na base de clculo

clculo

Item da lista de servio informado para a

Consulte a legislao vigente para saber se o item

41

operao

no

permite

tributao

fora

do

informado permite a tributao fora do municpio

municpio

(Foi informada a Natureza da Operao "2")

A4

Valor do ISS retido diferente do ISS devido

Verifique se os valores esto corretos

A5

O CNPJ informado possui inscrio no municpio,

O sistema ir considerar o tomador conforme todos

porm foi informado endereo de fora do

os dados informados no arquivo (endereo de fora

municpio.

do municpio).

A inscrio municipal do tomador no foi

O sistema ir interpretar como se o tomador no

encontrada na base de dados de CCM.

tivesse inscrio no CCM.

Inscrio Municipal do tomador de servios

A inscrio municipal do tomador fornecida consta

consta como cancelada.

como cancelada na base de dados do municipio.

E-mail do tomador de servios invlido. E-mail

O e-mail do tomador de servios no vlido. Este

no ser enviado.

campo ser ignorado e no haver envio de e-mail.

A6

A7

A8