NFS-e

Manual de Integrao

Verso 1.0
29/12/2008

Pgina 2 de 36
Reviso 1.00

SUMRIO
1

INTRODUO ............................................................................................ 3

CONSIDERAES INICIAIS ...................................................................... 4

2.1
2.2

NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E ..................................... 4

RECIBO PROVISRIO DE SERVIO - RPS .................................................. 4

ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE ............... 6

3.1
MODELO CONCEITUAL ............................................................................. 6
3.1.1
Recepo e Processamento de Lote de RPS ............................... 6
3.1.2
Consulta de Situao de Lote de RPS .......................................... 7
3.1.3
Consulta de NFS-e por RPS ......................................................... 7
3.1.4
Consulta de Lote de RPS .............................................................. 8
3.1.5
Consulta de NFS-e ........................................................................ 8
3.1.6
Cancelamento de NFS-e ............................................................... 9
3.2
PADRES TCNICOS ............................................................................... 9
3.2.1
Padro de Comunicao ............................................................. 10
3.2.2 Padro de Certificado Digital .......................................................... 10
3.2.3
Padro de Assinatura Digital ....................................................... 11
3.2.4
Validao de Assinatura Digital pelo Sistema NFS-e .................. 12
3.2.5
Uso de Assinatura com Certificado Digital .................................. 13
3.3
PADRO DAS MENSAGENS XML............................................................. 13
3.3.1
rea do Cabealho ..................................................................... 14
3.3.2
Validao da estrutura das Mensagens XML .............................. 14
3.3.3
Schemas XML (arquivos XSD).................................................... 15
3.3.4
Verso dos Schemas XML .......................................................... 15

ESTRUTURA DE DADOS DO WEB SERVICE ........................................ 16

4.1
MODELO OPERACIONAL......................................................................... 16
4.1.1
Servios Sncronos ..................................................................... 16
4.1.2
Servios Assncronos .................................................................. 17
4.2
FORMATOS E PADRES UTILIZADOS ....................................................... 18
4.3
TIPOS SIMPLES ..................................................................................... 19
4.4
TIPOS COMPLEXOS ............................................................................... 21
4.5
SERVIOS ............................................................................................ 26
4.5.1
Recepo de Lote de RPS .......................................................... 27
4.5.2
Consulta de Situao de Lote de RPS ........................................ 27
4.5.3
Consulta de NFS-e por RPS ....................................................... 28
4.5.4
Consulta de NFS-e ...................................................................... 28
4.5.5
Consulta de Lote de RPS ............................................................ 28
4.5.6
Cancelamento NFS-e .................................................................. 29

ANEXO ...................................................................................................... 30
5.1

TABELA DE ERROS E ALERTAS ............................................................... 30

Pgina 3 de 36
Reviso 1.00

INTRODUO
Este manual tem como objetivo apresentar as
especificaes e critrios tcnicos necessrios para
utilizao do Web Service disponibilizado pelas
Secretarias Municipais de Fazenda para as empresas
prestadoras e/ou tomadoras de servios.
Atravs do Web Service as empresas podero
integrar seus prprios sistemas de informaes com o
Sistema de Notas Fiscais de Servio Eletrnicas das
Secretarias Municipais de Fazenda. Desta forma,
consegue-se automatizar o processo de gerao,
consulta e cancelamento de NFS-e.

Pgina 4 de 36
Reviso 1.00

1 CONSIDERAES INICIAIS
O projeto Nota Fiscal de Servios Eletrnica de Servios
est sendo concebido atravs de reunies das reas de
Negcio e Tecnologia da Informao com os
representantes dos municpios integrantes da Cmara
Tcnica da Associao Brasileira de Secretrios e
Dirigentes das Finanas dos Municpios das Capitais
(ABRASF), onde tiveram como principal objetivo a
gerao de um modelo de processo que considerasse as
necessidades e as legislaes de cada municpio.
O projeto tem como objetivo atender ao Protocolo de
Cooperao ENAT n 01/2006 - III ENAT, que instituiu a Nota Fiscal de
Servios Eletrnica NFS-e com vistas ao compartilhamento de informaes
entre os fiscos municipais, estaduais e federal, atravs do desenvolvimento de
uma soluo para a gerao desse documento fiscal eletrnico como
instrumento de controle da arrecadao e fiscalizao do ISS.
Visa o benefcio das administraes tributrias padronizando e melhorando a
qualidade das informaes, racionalizando os custos e gerando maior eficcia,
bem como o aumento da competitividade das empresas brasileiras pela
racionalizao das obrigaes acessrias (reduo do custo-Brasil), em
especial a dispensa da emisso e guarda de documentos em papel.
1.1

NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E

A Nota Fiscal de Servios Eletrnica (NFS-e) um documento de
existncia exclusivamente digital, gerado e armazenado
eletronicamente pela prefeitura ou por outra entidade conveniada,
para documentar as operaes de prestao de servios.

A gerao da NFS-e ser feita, automaticamente, por meio de servios

informatizados, disponibilizados aos contribuintes. Para que sua gerao seja
efetuada, dados que a compem sero informados, analisados, processados,
validados e, se corretos, geraro o documento.
A responsabilidade pelo cumprimento da obrigao acessria de emisso da
NFS-e e pelo correto fornecimento dos dados secretaria, para a gerao da
mesma, do contribuinte.
1.2 RECIBO PROVISRIO DE SERVIO - RPS
A NFS-e somente ser gerada atravs dos servios informatizados
disponibilizados pelas Secretarias Municipais de Fazenda. Esse tipo de servio

Pgina 5 de 36
Reviso 1.00

seguido de alguns riscos inerentes ininterrupta disponibilidade, podendo,

portanto, em alguns momentos tornar-se indisponvel.
Visando manter as atividades dos contribuintes ininterruptas, independente de
os servios informatizados disponibilizados pelas Secretarias Municipais de
Fazenda estarem disponveis, foi criado o Recibo Provisrio de Servios (RPS),
que um documento de posse e responsabilidade do contribuinte, que dever
ser gerado manualmente ou por alguma aplicao local, possuindo uma
numerao seqencial crescente e devendo ser convertido em NFS-e no prazo
estipulado pela legislao tributria municipal.

Pgina 6 de 36
Reviso 1.00

2 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE

2.1 MODELO CONCEITUAL
Atravs do Web Service, o Sistema de Notas Fiscais de Servio Eletrnicas
das Secretarias Municipais de Fazenda 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 RPS
Esse servio compreende a recepo do Lote de RPS, 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
Secretaria da Fazenda

Aplicao Cliente
b

<XML>
Lote de RPS

NFS-e

a
d
RPS

<XML>
Mensagem

Web Services

NFS-e

Fila de Processos

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 execuo

1. A aplicao acessa o servio de Recepo e Processamento de Lote
de RPS 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).

Pgina 7 de 36
Reviso 1.00

2.1.2 Consulta de Situao de Lote de RPS

Esse servio efetua a consulta da situao de um Lote de RPS j enviado.
Prestador

Secretaria da Fazenda

Aplicao Cliente
2.b

2.c

<XML>
Identif. do Lote

Consulta

2.a

2.e

Web Services

<XML>
Situao do Lote

2.d
NFS-e
Processamento
Resultado

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 execuo

1. A aplicao acessa o servio de Consulta de Situao de Lote de RPS
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 (fluxox 2.c e 2.d).
3. O Web Service retorna uma mensagem com o resultado do
processamento do servio (fluxo 2.e).
2.1.3 Consulta de NFS-e por RPS
Esse servio efetua a consulta de uma NFS-e a partir do nmero de RPS que a
gerou.
Prestador ou Tomador

Secretaria da Fazenda

Aplicao Cliente
2.b

<XML>
Identif. do RPS

2.c

2.a

?
Consulta

2.e
<XML>
NFS-e / Mensag.

Web Services

2.d
Processamento
NFS-e / Msg

NFS-e

XML de Envio validado pelo arquivo: servico_consultar_nfse_rps_envio.xsd

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 RPS 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).

Pgina 8 de 36
Reviso 1.00

3. O Web Service retorna uma mensagem com o resultado do

processamento do servio (fluxo 2.e).
2.1.4 Consulta de Lote de RPS
Esse servio 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 inconsistncias encontradas nos RPS.
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.
Secretaria da Fazenda

Prestador
Aplicao Cliente

Web Services

<XML>
Identif. do RPS

Consulta

Processamento

<XML>
Grupo de NFS-e / Msg.

NFS-e

NFS-e / Msg

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 execuo

1. A aplicao acessa o servio de Consulta de Lote de RPS 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 NFSe geradas ou as mensagens de erro) com o resultado do processamento
do servio (fluxo e).
2.1.5 Consulta de NFS-e
Esse servio permite a obteno de determinada NFS-e j gerada.
Secretaria da Fazenda
Prestador ou Tomador
Aplicao Cliente
2.b

2.c

<XML>
Identif. do RPS

Consulta

2.a

2.e
<XML>
NFS-e / Mensag.

Web Services

2.d
Processamento
NFS-e
NFS-e / Msg

Pgina 9 de 36
Reviso 1.00

XML de Envio validado pelo arquivo: servico_consultar_nfse_envio.xsd

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.6 Cancelamento de NFS-e
Esse servio permite o cancelamento direto de uma NFS-e sem substituio da
mesma por outra.
Prestador

Secretaria da Fazenda

Aplicao Cliente
2.b

<XML>
Identif. da NFS-e

Cancelamento

2.a

2.c

2.d
<XML>
Mensagem

Web Services

Processamento

NFS-e

XML de Envio validado pelo arquivo: servico_cancelar_nfse_envio.xsd

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

Secretaria Municipal da Fazenda

Pgina 10 de 36
Reviso 1.00

2.2.1 Padro de Comunicao

O meio fsico de comunicao utilizado entre os sistemas de informao dos
contribuintes e o Sistema de Notas Fiscais de Servio Eletrnicas das
Secretarias Municipais de Fazenda ser a Internet, com o uso 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.
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 Sistema de Notas Fiscais de
Servio Eletrnicas das Secretaria Municipais de Fazenda 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
do Servio

Provedor
do Servio

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 4.5.
2.2.2 Padro de Certificado Digital
Os certificados digitais utilizados no sistema de Notas Fiscais de
Servio Eletrnicas, das Secretarias Municipais de Fazenda, 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 servidor (hbrido).
Para a assinatura digital dos documentos envolvidos aceitar-se- que o
certificado digital seja de quaisquer dos estabelecimentos da empresa.
10

Pgina 11 de 36
Reviso 1.00

Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a

integrao entre o sistema do contribuinte e o Web Service das Secretarias
Municipais de Fazenda:

Assinatura de Mensagens: O certificado digital utilizado para essa

funo 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 funo de assinatura digital, respeitando a
Poltica do Certificado.
Transmisso (durante a transmisso das mensagens entre os servidores
do contribuinte e os servios disponibilizados pelas Secretarias
Municipais de Fazenda): O certificado digital utilizado para identificao
do aplicativo do contribuinte dever conter o CNPJ do responsvel pela
transmisso das mensagens, mas no necessita ser o mesmo CNPJ do
estabelecimento emissor da NFS-e, 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 pelas Secretarias
Municipais de Fazenda so documentos eletrnicos elaborados no padro 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 informaes prestadas e a
correta formao dos arquivos XML, o contribuinte dever submeter as
mensagens XML para validao pela linguagem de Schema do XML (XSD
XML Schema Definition), disponibilizada pelas Secretarias Municipais de
Fazenda antes de seu envio.
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>

11

Pgina 12 de 36
Reviso 1.00

<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:
#
XS01
XS02
XS03
XS04
XS05

XS06
XS07
XS08
XS09
XS10
XS11
XS12
XS13

XS14
XS15
XS16
XS17
XS18
XS19
XS20
XS21

Campo
Elemento Pai
Tipo Ocorrncia Descrio
Signature
Raiz
Id
A
XS01
C
1-1
SignedInfo
G
XS01
1-1
Grupo da Informao da assinatura
CanonicalizationMethod
G
XS03
1-1
Grupo do Mtodo de Canonicalizao
Algorithm
A
XS04
C
1-1
Atributo Algorithm de CanonicalizationMethod:
http://www.w3.org/TR/2001/REC-xml-c14n20010315
SignatureMethod
G
XS03
1-1
Grupo do Mtodo de Assinatura
Algorithm
A
XS06
C
1-1
Atributo Algorithm de SignedInfo:
http://www.w3.org/2000/09/xmldsig#rsa-sha1
Reference
G
XS03
1-1
Grupo do Mtodo de Reference
URI
A
XS08
C
1-1
Atributo URI da tag Reference
Transforms
G
XS08
1-1
Grupo do algorithm de Transform
Unique_Transf_Alg
RC
XS10
1-1
Regra para o atributo Algorithm do Transform ser
nico
Transform
G
XS10
2-2
Grupo de Transform
Algorithm
A
XS12
C
1-1
Atributos vlidos Algorithm do Transform:
http://www.w3.org/TR/2001/REC-xml-c14n20010315
http://www.w3.org/2000/09/xmldsig#envelopedsignature
Xpath
E
XS12
C
0-N
Xpath
DigestMethod
G
XS08
1-1
Grupo do Mtodo de DigestMethod
Algorithm
A
XS15
C
1-1
Atributo Algorithm de DigestMethod:
http://www.w3.org/2000/09/xmldsig#sha1
DigestValue
E
XS08
C
1
Digest Value (Hash SHA-1 Base64)
SignatureValue
G
XS01
1-1
Grupo do Signature Value
KeyInfo
G
XS01
1-1
Grupo do KeyInfo
X509Data
G
XS19
1-1
Grupo X509
X509Certificate
E
XS20
C
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
pelas Secretarias Municipais de Fazenda:
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;

12

Pgina 13 de 36
Reviso 1.00

6. Adotar as regras definidas pelo RFC 3280 para LCRs e 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 de cada Secretaria Municipal de
Fazenda, podendo ser feita de 2 (duas) maneiras: On-line ou Download
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 segue as informaes que devero
ser assinadas e quem dever faz-lo em cada momento:

O RPS, pelo contribuinte, antes do envio do mesmo atravs 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 Aplicao
On Line;
o Pela prefeitura nos demais casos;
O Pedido de cancelamento da NFS-e, pelo contribuinte;
A Confirmao de cancelamento da NFS-e, pela prefeitura;

2.3 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 UTF-8.
As chamadas dos Web Services disponibilizados pelas Secretarias Municipais
de Fazenda 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 Municipais de Fazenda, 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.

13

Pgina 14 de 36
Reviso 1.00

2.3.1 rea do Cabealho

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

Nome
cabecalho

Verso
versaoDados

Elemento Pai Tipo

G
A
E

1
1

N
N

Ocorrncia Tamanho Descrio

1-1
TAG raiz do cabealho da
mensagem.
1-1
4
Verso do leiaute.
1-1
4
O contedo deste campo indica a
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.

14

Pgina 15 de 36
Reviso 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 Servio Eletrnicas
das Secretarias Municipais de Fazenda.
2.3.4 Verso dos Schemas XML
Toda mudana de layout 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:
tipos_nfse_v01.xsd
A maioria dos Schemas XML definidos para a utilizao do Web Service do
Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de
Fazenda utilizam 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 layout 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 pelas
Secretarias Municipais de Fazenda e podero ocorrer sempre que se fizerem
necessrias.

15

Pgina 16 de 36
Reviso 1.00

3 ESTRUTURA DE DADOS DO WEB SERVICE

Existir um nico Web Service com todos os servios apresentados no item
2.1. 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 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 uma demanda de processamento de grande quantidade de
informao. Nesta situao torna-se necessria a realizao de mais 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
Recepo e Processamento de Lote de RPS
Consulta de Situao de Lote de RPS
Consulta de NFS-e por RPS
Consulta de Lote de RPS
Consulta de NFS-e
Cancelamento de NFS-e

Implementao
Assncrona
Sncrona
Sncrona
Sncrona
Sncrona
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.
Abaixo, o fluxo simplificado de funcionamento:
Secretaria da Fazenda
Prestador

<XML>
Solicitao

Web Services

Processamento
<XML>
Resultado

16

Pgina 17 de 36
Reviso 1.00

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:
Secretaria da Fazenda

Prestador
<XML>
Solicitao

Web Service
<XML>
Resultado

Fila de Processos

Etapas do processo ideal:

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;

17

Pgina 18 de 36
Reviso 1.00

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:
7. 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;
8. O Web Service recebe a mensagem de consulta e localiza o resultado
de processamento da solicitao de servio;
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 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

Observao

Data (date)

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.
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

Data/Hora (datetime)

Valores Decimais
(decimal)

Valores Percentuais
(decimal)

18

Pgina 19 de 36
Reviso 1.00

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;

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;
19

Pgina 20 de 36
Reviso 1.00

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

Tam.

TsNumeroNfse

15

tsCodigoVerificacao
TsStatusRps

C
N

TsStatusNfse

tsNaturezaOperacao

tsRegimeEspecialTributacao

TsSimNao

TsQuantidadeRps
TsNumeroRps
TsSerieRps
TsTipoRps

N
N
C
N

tsOutrasInformacoes
TsValor

C
N

tsItemListaServico
TsCodigoCnae
tsCodigoTributacao
TsAliquota

C
N
C
N

tsDiscriminacao

Nmero da Nota Fiscal de Servio Eletrnica,

formado pelo ano com 04 (quatro) dgitos e um
nmero seqencial com 11 posies Formato
AAAANNNNNNNNNNN.
Cdigo de verificao do nmero da nota
Cdigo de status do RPS
1 Normal
2 Cancelado
Cdigo de status da NFS-e
1 Normal
2 Cancelado
Cdigo de natureza da operao
1 Tributao no municpio
2 - Tributao fora do municpio
3 - Iseno
4 - Imune
5 Exigibilidade suspensa por deciso judicial
6 Exigibilidade suspensa por procedimento
administrativo
Cdigo de identificao do regime especial de
tributao
1 Microempresa municipal
2 - Estimativa
3 Sociedade de profissionais
4 Cooperativa
5 - Microempresrio Individual (MEI)
6 - Microempresrio e Empresa de Pequeno Porte
(ME EPP)
Identificao de Sim/No
1 - Sim
2 No
Quantidade de RPS do Lote
Nmero do RPS
Nmero de srie do RPS
Cdigo de tipo de RPS
1 - RPS
2 Nota Fiscal Conjugada (Mista)
3 Cupom
Informaes adicionais ao documento.
Valor monetrio.
Formato: 0.00 (ponto separando casa decimal)
Ex: 1.234,56 = 1234.56
1.000,00 = 1000.00
1.000,00 = 1000
Cdigo de item da lista de servio
Cdigo CNAE
Cdigo de Tributao
Alquota. Valor percentual.
Formato: 0.0000
Ex: 1% = 0.01
25,5% = 0.255
100% = 1.0000 ou 1
Discriminao do contedo da NFS-e

9
1

4
15
5
1

255
15,2

5
7
20
5,4

2000

20

Pgina 21 de 36
Reviso 1.00

tsCodigoMunicipioIbge

tsIncricaoMunicipal
tsRazaoSocial
tsNomeFantasia
TsCnpj
tsEndereco
tsNumeroEndereco
tsComplementoEndereco
tsBairro
tsUf
tsCep
tsEmail
tsTelefone
TsCpf
tsIndicacaoCpfCnpj

C
C
C
C
C
C
C
C
C
N
C
C
C
N

tsCodigoObra
tsArt
tsNumeroLote
TsNumeroProtocolo
tsSituacaoLoteRps

C
C
N
C
N

tsCodigoMensagemAlerta
TsDescricaoMensagemAlerta
TsCodigoCancelamentoNfse

C
C
C

tsIdTag

Cdigo de identificao do municpio conforme

tabela do IBGE
Nmero de inscrio municipal
Razo Social do contribuinte
Nome fantasia
Nmero CNPJ
Endereo
Nmero do endereo
Complemento de endereo
Bairro
Sigla da unidade federativa
Nmero do CEP
E-mail
Telefone
Nmero de CPF
Indicador de uso de CPF ou CNPJ
1 CPF
2 CNPJ
3 No Informado
Cdigo de Obra
Cdigo ART
Nmero do Lote de RPS
Nmero do protocolo de recebimento do RPS
Cdigo de situao de lote de RPS
1 No Recebido
2 No Processado
3 Processado com Erro
4 Processado com Sucesso
Cdigo de mensagem de retorno de servio.
Descrio da mensagem de retorno de servio.
Cdigo de cancelamento com base na tabela de
Erros e alertas.
Atributo de identificao da tag a ser assinada
no documento XML

7
15
115
60
14
125
10
60
60
2
8
80
11
11
1

15
15
15
50
1

4
200
4
255

3.4 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
(4)
(4)

(5)
(5)

Ocorrncia Descrio
(6)
(6)

(7)
(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:
a. Formato: x-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.

21

Pgina 22 de 36
Reviso 1.00

TcCpfCnpj
Nmero de CPF ou CNPJ
Nome
Cpf
Choice
Cnpj

Tipo
tsCpf
tsCnpj

Ocorrncia Descrio
1-1
Nmero do Cpf
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

TcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Nome
Tipo
Ocorrncia Descrio
Telefone
tsTelefone
0-1
Email
tsEmail
0-1

tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador
Nome
Tipo
Ocorrncia Descrio
CodigoMunicipio
tsCodigoMunicipioIbge
1-1
Uf
tsUf
1-1

tcIdentificacaoRps
Dados de identificao do RPS
Nome
Numero
Serie
Tipo

Tipo
tsNumeroRps
tsSerieRps
tsTipoRps

Ocorrncia Descrio
1-1
1-1
1-1

tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
Nome
Tipo
Ocorrncia Descrio
Cnpj
tsCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1

tcIdentificacaoTomador
Representa dados para identificao do tomador de servio
Nome
Tipo
Ocorrncia Descrio
CpfCnpj
tcCpfCnpj
0-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1

tcDadosTomador
Representa dados do tomador de servio
Nome
Tipo
Ocorrncia Descrio
IdentificacaoTomador
TcIdentificacaoTomador
0-1
RazaoSocial
TsRazaoSocial
0-1
Endereco
TcEndereco
0-1
Contato
TcContato
0-1

TcIdentificacaoIntermediarioServico
Representa dados para identificao de intermedirio do servio

22

Pgina 23 de 36
Reviso 1.00

Nome
RazaoSocial
CpfCnpj
InscricaoMunicipal

Tipo
tsRazaoSocial
tcCpfCnpj
tsInscricaoMunicipal

Ocorrncia Descrio
1-1
1-1
0-1

TcValores
Representa um conjunto de valores que compe o documento fiscal
Nome
Tipo
Ocorrncia Descrio
ValorServicos
tsValor
1-1
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
0-1
(Valor dos servios - Valor das
dedues - descontos
incondicionados)
Aliquota
tsAliquota
0-1
ValorLiquidoNfse
tsValor
0-1
(ValorServicos - ValorPIS ValorCOFINS - ValorINSS ValorIR - ValorCSLL OutrasRetenoes ValorISSRetido DescontoIncondicionado DescontoCondicionado)
ValorIssRetido
tsValor
0-1
DescontoCondicionado
tsValor
0-1
DescontoIncondicionado
tsValor
0-1

TcDadosServico
Representa dados que compe o servio prestado
Nome
Tipo
Ocorrncia Descrio
Valores
tcValores
1-1
ItemListaServico
tsItemListaServico
1-1
CodigoCnae
tsCodigoCnae
0-1
CodigoTributacaoMunicipio
tsCodigoTributacao
0-1
Discriminacao
tsDiscriminacao
1-1
CodigoMunicipio
tsCodigoMunicipioIbge
1-1

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
Nome
Tipo
CodigoObra
tsCodigoObra
Art
tsArt

Ocorrncia Descrio
1-1
1-1

tcDadosPrestador
Representa dados do prestador do servio
Nome
Tipo
Ocorrncia Descrio
IdentificacaoPrestador
tcIdentificacaoPrestador
1-1
RazaoSocial
tsRazaoSocial
1-1
NomeFantasia
tsNomeFantasia
0-1
Endereco
tcEndereco
1-1
Contato
tcContato
0-1

TcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS)

23

Pgina 24 de 36
Reviso 1.00

Nome
Id
IdentificacaoRps
DataEmissao
NaturezaOperacao
RegimeEspecialTributacao
OptanteSimplesNacional
IncentivadorCultural
Status
RpsSubstituido
Servico
Prestador
Tomador
IntermediarioServico
ConstrucaoCivil

Tipo
tsIdTag

Ocorrncia Descrio
Identificador da TAG
a ser assinada
TcIdentificacaoRps
1-1
Datetime
1-1
TsNaturezaOperacao
1-1
TsRegimeEspecialTributacao
0-1
TsSimNao
1-1
TsSimNao
1-1
TsStatusRps
1-1
TcIdentificacaoRps
0-1
TcDadosServico
1-1
TcIdentificacaoPrestador
1-1
TcDadosTomador
1-1
tcIdentificacaoIntermediarioServico
0-1
TcDadosContrucaoCivil
0-1

TcRps
Representa a estrutura do Recibo Provisrio de Servio (RPS) assinada
Nome
Tipo
Ocorrncia Descrio
InfRps
tcInfRps
1-1
dsig:Signature
0-1
Signature

tcIdentificacaoNfse
Representa dados que identificam uma Nota Fiscal de Servios Eletrnica
Nome
Tipo
Ocorrncia Descrio
Numero
tsNumeroNfse
1-1
Cnpj
tsCnpj
1-1
InscricaoMunicipal
tsInscricaoMunicipal
0-1
CodigoMunicipio
tsCodigoMunicipioIbge

TcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Nome
Tipo
Ocorrncia Descrio
Id
tsIdTag
Identificador da TAG
a ser assinada
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
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 Descrio
InfNfse
tcInfNfse
1-1

24

Pgina 25 de 36
Reviso 1.00

Signature

Dsig:Signature

1-2

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma
Nota Fiscal de Servios Eletrnica.
Nome
Tipo
Ocorrncia Observao
Id
tsIdTag
Identificador da TAG a
ser assinada
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 Descrio
InfPedidoCancelamento
tcInfPedidoCancelamento
1-1
Dsig:Signature
0-1
Signature

tcInfConfirmacaoCancelamento
Representa a estrutura de dados da confirmao de cancelamento Nota Fiscal de Servios Eletrnica feito
pelo Fisco Municipal.
Nome
Tipo
Ocorrncia Observao
Sucesso
boolean
1-1
DataHora
datetime
1-1

TcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Nome
Tipo
Ocorrncia Descrio
Id
tsIdTag
Identificador da TAG
a ser assinada
Pedido
TcPedidoCancelamento
1-1
InfConfirmacaoCancelamento
tcInfConfirmacaoCancelamento
1-1

TcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e.
Nome
Tipo
Ocorrncia Descrio
Confirmacao
TcConfirmacaoCancelamento
1-1
Dsig:Signature
1-1
Signature

TcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e.
Nome
Tipo
Id
tsIdTag
NfseSubstituidora

Ocorrncia

tsNumeroNfse

Descrio
Identificador da TAG a ser
assinada

1-1

TcSubstituicaoNfse
Representa a estrutura de substituio de NFS-e.
Nome
Tipo
SubstituicaoNfse
tcInfSubstituicaoNfse
dsig:Signature
Signature

Ocorrncia Descrio
1-1
1-2

TcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFS-e.
Nome
Tipo
Ocorrncia Descrio
Nfse
tcNfse
1-1
NfseCancelamento
tcCancelamentoNfse
0-1
NfseSubstituicao
tcSubstituicaoNfse
0-1

25

Pgina 26 de 36
Reviso 1.00

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
Codigo
TsCodigoMensagemAlerta
1-1
Mensagem
tsDescricaoMensagemAlerta
1-1
Correcao
tsDescricaoMensagemAlerta
0-1

ListaMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
MensagemRetorno
tcMensagemRetorno
1-N

tcMensagemRetornoLote
Representa a estrutura de mensagem de retorno de servio.
Nome
Tipo
Ocorrncia Descrio
IdentificacaoRps
TcIdentificacaoRps
1-1
Codigo
TsCodigoMensagemAlerta
1-1
Mensagem
tsDescricaoMensagemAlerta
1-1

tcLoteRps
Nome
Id

Tipo
tsIdTag

NumeroLote
Cnpj
InscricaoMunicipal
QuantidadeRps
ListaRps
Rps

TsNumeroLote
TsCnpj
TsInscricaoMunicipal
TsQuantidadeRps
TcRps

Ocorrncia Observao
Identificador da TAG a ser
assinada
1-1
1-1
1-1
1-1
1-1
1-N

3.5 SERVIOS
A seguir esto os servios disponveis, conforme descritos no item 2.1, no
WebService e seus XML Schema. O XML Schema define a estrutura e
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, como descrito em 2.2.1.
As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
# Nome
(2)

Tipo
(3)

(4)

Pai
(5)

Ocorrncia
(6)
(8)

Observao
(7)
(9)

1. Nmero 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 definio da hierarquia;
5. Quantas vezes o campo se repete na estrutura de dados:

26

Pgina 27 de 36
Reviso 1.00

a. 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 RPS
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
EnviarLoteRpsEnvio
LoteRps

Signature

Tipo
TcLoteRps
dsig:Signature

Pai
1
1

Ocorrncia
1-1
1-1
0-1

Observao

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

tabela a seguir.
#
1

Nome
EnviarLoteRpsResposta
NumeroLote
DataRecebimento
Protocolo
ListaMensagemRetorno

Tipo
tsNumeroLote
Datetime
tsNumeroProtocolo
ListaMensagemRetorno

Pai
1
1
1
1

Ocorrncia
1-1
1-1

Observao

Choice

1-1

O lote ser processado posteriormente, sendo o seu resultado disponibilizado

para consulta.
3.5.2 Consulta de Situao de Lote de RPS
Esse servio ser executado atravs da chamada ao mtodo
ConsultarSituacaoLoteRps, passando a mensagem XML como parmetro
com a estrutura definida na tabela que segue.
#
1

Nome
ConsultarSituacaoLoteRpsEn
vio
Prestador
Protocolo

Tipo

TcIdentificacaoPrestador
TsNumeroProtocolo

Pai

Ocorrncia
1-1

1
1

1-1
1-1

Observao

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

tabela a seguir.
#
1

Nome
ConsultarSituacaoLoteRpsRe
sposta

Tipo

Pai

Ocorrncia
1-1

Observao

27

Pgina 28 de 36
Reviso 1.00

NumeroLote
Situao
ListaMensagemRetorno

tsNumeroLote
tsSituacaoLoteRps
ListaMensagemRetorno

1
1
1

1-1

Choice

1-1

3.5.3 Consulta de NFS-e por RPS

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
ConsultarNfseRpsEnvio
IdentificacaoRps
Prestador

Tipo
tcIdentificacaoRps
tcIdentificacaoPrestador

Pai

Ocorrncia

1
1

1-1
1-1

Observao

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

tabela a seguir.
#
1
2

Nome
ConsultarNfseRpsResposta
CompNfse
ListaMensagemRetorno

Tipo
tcCompNfse
ListaMensagemRetorno

Pai

Ocorrncia

1
1

1-1
1-1

Observao
Choice

3.5.4 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.
#
1

Nome
ConsultarNfseEnvio
Prestador
NumeroNfse
PeriodoEmissao
DataInicial
DataFinal
Tomador
IntermediarioServico

Tipo
tcIdentificacaoPrestador
tsNumeroNfse
date
date
tcIdentificacaoTomador
TcIdentificacaoIntermediar
ioServico

Pai
1
1
1
2
2
1
1

Ocorrncia
1-1
1-1
0-1
0-1
1-1
1-1
0-1
0-1

Observao

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

tabela a seguir.
#
1
2
3

Nome
ConsultarNfseResposta
ListaNfse
CompNfse
ListaMensagemRetorno

Tipo

tcCompNfse
ListaMensagemRetorno

Pai
1
2
1

Ocorrncia
1-1
1-1
0-N
1-1

Observao

Choice

3.5.5 Consulta de Lote de RPS

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

Pgina 29 de 36
Reviso 1.00

#
1

Nome
ConsultarLoteRpsEnvio
Prestador
Protocolo

Tipo
TcIdentificacaoPrestador
TsNumeroProtocolo

Pai
1
1

Ocorrncia
1-1
1-1
1-1

Observao

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

tabela a seguir.
#
1
2
3

Nome
ConsultarLoteRpsResposta
ListaNfse
CompNfse
ListaMensagemRetorno

Tipo

tcCompNfse
ListaMensagemRetorno

Pai
1
2
1

Ocorrncia
1-1
1-1
1-N
1-1

Observao

Choice

3.5.6 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
CancelarNfseEnvio
Pedido

Tipo
TcPedidoCancelamento

Pai
1

Ocorrncia
1-1
1-1

Observao

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

tabela a seguir.
#
1
2

Nome
CancelarNfseResposta
Cancelamento
ListaMensagemRetorno

Tipo
TcCancelamentoNfse
ListaMensagemRetorno

Pai

Ocorrncia

1
1

1-1
1-1

Observao
Choice

29

Pgina 30 de 36
Reviso 1.00

4 ANEXO
4.1

TABELA DE ERROS

CD.

MENSAGEM

SOLUO

E1

Assinatura do Hash no confere

E2

Ms de competncia superior ao de emisso

do RPS ou da Nota
Natureza da operao no informada.

Reenvie asssinatura do Hash conforme algoritmo

estabelecido no Manual de Instruo da NFS-e
Informe um ms de competncia inferior ou
igual ao de emisso do RPS ou da Nota.
Utilize um dos tipos: 01 Tributao no
municipio; 02 Tributao fora do municipio; 03
Iseno; 04 Imune; 05 Exigibilidade
suspensa por deciso judicial; 06 Exigibilidade
suspensa por procedimento administrativo.
Envie o RPS para emisso da NFS-e.

E3

E4
E5

Esse RPS no foi enviado para a nossa base

de dados
O nmero da NFS-E substituda informado
no existe na base de dados do municpio.
Essa NFS-e no pode ser cancelada atravs
desse servio, pois h crdito informado

E11

Informe um nmero de NFS-E substituda que j

tenha sido emitida.
O cancelamento de uma NFS-e com crdito deve
ser feito atravs de processo administrativo
aberto em uma repartio fazendria.
Essa NFS-e j foi substituda
Confira e informe novamente os dados da NFS-e
que deseja substituir.
Campo de optante pelo simples nacional no Utilize um dos tipos: 1 Sim; 2 - No.
informado
Campo de incentivador cultural no
Utilize um dos tipos: 1 Sim; 2 - No.
informado
RPS j informado.
Para essa Inscrio Municipal/CNPJ j existe um
RPS informado com o mesmo nmero, srie e
tipo.
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.

E14

Data da emisso do RPS no informada

E15

Data da emisso do RPS invlida

E16

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

Informe a Data da emisso do RPS no formato
Date
Informe a Data da emisso do RPS no formato
Date
Informe uma data de emisso de RPS vlida

A data da emisso do RPS no poder ser

superior a data de hoje
Informe uma data de emisso de RPS vlida
A data da emisso do RPS no poder ser
inferior data de habilitao do prestador
para emisso da NFS-e.
O valor dos servios dever ser superior a R$ No permitido envio de valor de servios igual
0,00 (zero)
a zero.
O valor das dedues dever ser inferior ou No permitido valor de deduo superior ao
igual ao valor dos servios
valor de servios.
O valor das dedues dever ser superior ou No permitido valor de deduo inferior a zero
igual a R$ 0,00 (zero)
(negativo).
O valor dos descontos dever ser inferior ou No permitido valor de desconto superior ao
igual ao valor dos servios
valor de servios.
O valor dos descontos dever ser superior ou No permitido valor de desconto inferior a zero
igual a R$ 0,00 (zero)
(negativo).
O valor do PIS dever ser superior ou igual a No permitido valor de reteno inferior a zero
R$ 0,00 (zero)
(negativo).
O valor da Cofins dever ser superior ou igual No permitido valor de reteno inferior a zero
a R$ 0,00 (zero)
(negativo).
O valor do INSS dever ser superior ou igual No permitido valor de reteno inferior a zero
a R$ 0,00 (zero)
(negativo).
O valor do IR dever ser superior ou igual a No permitido valor de reteno inferior a zero

E6

E7
E8
E9
E10

E17

E18
E19
E20
E21
E22
E23
E24
E25
E26

30

Pgina 31 de 36
Reviso 1.00

E27
E28

E29
E30

E31
E32

R$ 0,00 (zero)

(negativo).

O valor da CSLL dever ser superior ou igual

a R$ 0,00 (zero)
Item da lista de servio informado
incompatvel com a informao de optante
pelo simples nacional
O cdigo de servio prestado no permite
reteno de ISS.
Item da lista de servio inexistente

No permitido valor de reteno inferior a zero

(negativo).
Consulte a legislao vigente para saber se o
item informado permite a opo pelo simples
nacional
Altere o campo "ISS Retido" para: 2 (Nota Fiscal
sem ISS Retido).
Consulte a legislao vigente para saber o item
da lista de servio que dever ser informado
neste campo.
Informe o item relativo ao servio prestado
nessa operao.
Consulte a legislao vigente para saber se o
cdigo informado permite a opo pelo simples
nacional.
Consulte a legislao vigente para saber o cdigo
CNAE que dever ser informado neste campo.
Consulte a legislao vigente para saber se o
cdigo informado permite a opo pelo simples
nacional.
Consulte a legislao vigente para saber o
Cdigo de tributao que dever ser informado
neste campo.
Utilize um dos tipos: 1 para ISS Retido ou 2 para
ISS no Retido.
Operaes isentas, imunes ou com exigibilidade
suspensa por deciso judicial ou procedimento
administrativo no podem sofrer reteno de
ISS.
No faa a reteno do ISS nos casos de
empresas enquadradas como Microempresa
Municipal, Estimativa, Sociedade de Profissionais
ou Incentivador Cultural.
O CNPJ e/ou a Inscrio Municipal informada do
tomador no foi encontrada na base de dados do
municpio, no sendo permitida a reteno.
Acerte o CNPJ e/ou Inscrio Municipal ou altere
o campo ISS Retido para 2 (Sem reteno de
ISS).
O valor do ISS retido deve ser informado quando
o campo "IssRetido" for marcado com 1- Sim.
O preenchimento da discriminao dos servios
obrigatrio por lei, devendo ser preenchido
adequadamente.
Consulte a tabela do IBGE e utilize um dos tipos
listados na tabela
Informe a inscrio municipal correta do
prestador.
Informe o nmero do CNPJ correto do prestador.

Item da lista de servio no informado para a

operao
Cdigo CNAE informado incompatvel com a
informao de optante pelo simples nacional

E33

Cdigo CNAE inexistente

E34

E35

Cdigo de tributao informado

incompatvel com a informao de optante
pelo simples nacional
Cdigo de tributao inexistente

E36

Campo ISSRetido invlido.

E37

Apenas servios tributados, no municpio ou

fora, podem sofrer reteno de ISS

E38

Contribuintes enquadrados como

Microempresa Municipal, Estimativa,
Sociedade de Profissionais ou Incentivador
Cultural no podem sofrer reteno de ISS.
Apenas empresas tomadoras de servios
inscritas neste municipio podem efetuar
reteno de ISS.

E39

E40

Valor do ISS retido no informado.

E41

O campo discriminao dos servios no foi

preenchido.

E42

E44

Cdigo do municpio da prestao do servio

invlido
Inscrio Municipal do prestador no
encontrada na base de dados do municpio.
CNPJ do prestador invlido

E45

CNPJ no encontrado na base de dados

E46

CNPJ do prestador no informado

E47

CPF/CNPJ do tomador invlido

Informe o CPF/CNPJ correto do tomador.

E48

E49

O campo CPF/CNPJ do tomador dever ser

preenchido com zeros quando for de CPF
no-informado.
Lote de RPS com excesso de inconsistncias.

E50

Inscricao Municipal do pretador invlida

Preencher o campo CPF/CNPJ do Tomador com

zeros quando se tratar de tomador com CPF no
informado.
O servio de validao de RPS abortado
quando atinge o nmero de 50 inconsistncias.
Corrija os erros e reenvie o lote de RPS.
Informe a inscricao municipal correta do
prestador.

E43

Confira o numero do CNPJ informado. Caso

esteja correto, o prestador no est inscrito no
municpio.
Informe o CNPJ do prestador.

31

Pgina 32 de 36
Reviso 1.00

E51
E52
E53

E54
E55
E56

E57
E58
E59

Inscricao Municipal do tomador invlida

Informe a inscricao municipal correta do

tomador.
O tomador de servios informado o prprio Na emisso da NFS-e no permitido que o
prestador.
prestador seja igual ao tomador.
O campo Inscrio Municipal do tomador s Para tomadores estabelecidos fora deste
dever ser preenchido para tomadores
municpio no preencher inscrio municipal.
estabelecidos neste municpio
CNPJ do tomador (<CNPJ enviado>) est
Informe a Inscrio Municipal do tomador
vinculado a mais de uma inscrio municipal. vinculada ao CNPJ informado.
Endereo do tomador (logradouro) no
Corrija o endereo (logradouro) ou o CEP do
corresponde ao CEP informado
tomador do servio
Campo endereo do tomador no informado O preenchimento do endereo (logradouro)
(obrigatrio para tomador com CNPJ)
obrigatrio para tomadores Pessoas Jurdicas
(com CNPJ).
Bairro no corresponde ao CEP informado
Corrija o Bairro ou o CEP do tomador do servio
Cdigo do municipio do tomador no
corresponde ao CEP informado
Campo cidade do tomador no informado
(obrigatrio para tomador com CNPJ)

E60

A cidade do tomador informada no foi

encontrada na base de dados da prefeitura.

E61

Sigla da UF do tomador no corresponde ao

CEP informado
Cep no existe na tabela DNE dos Correios.

E62
E63

Corrija o codigo do municipio ou o CEP do

tomador do servio
O preenchimento da Cidade do Tomador
obrigatrio para tomadores Pessoas Jurdicas
(com CNPJ).
Informe a cidade correta do tomador. No caso de
cidade do exterior (fora do pas), informe o
campo com 99999.
Corrija a sigla da UF ou o CEP do tomador do
servio
Informar o Cep correto

E67

Razao social do intermedirio do servio no Informe a razao social do intermedirio do

informada com CNPJ/CPF ou Inscrio
servio
Municipal do intermedirio informada.
Inscrio Municipal do intermedirio do
Informe a Inscrio Municipal correta do
servio invlida
intermedirio do servio.
Acerte a Inscrio Municipal ou o CNPJ/CPF do
Inscrio Municipal do intermedirio do
intermedirio do servio.
servio no esta vinculada ao CNPJ/CPF
informado.
CNPJ/CPF do Intermediario do Servio
Informe o CNPJ/CPF correto do intermediario do
invalido
servio.
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

E70

Inscrio Municipal do prestador especificada Informe corretamente a Inscrio Municipal do

prestador no lote e no RPS.
no lote no confere com o prestador
informado no RPS.
RPS em duplicidade no arquivo enviado.
Remova do arquivo o registro de RPS excedente.

E64
E65

E66

E71
E72
E73
E74

E75
E76
E77
E78
E79

Campo Quantidade de RPS informado

incorretamente.
Campo tipo do RPS invlido para o tipo de
registro='3' (Cupons).
Data de emisso da Nota Fiscal no est
compreendida entre <data inicio de emisso
do lote> e <data fim de emisso do lote>
conforme especificado no cabealho do
arquivo.
Nmero do RPS substitudo no informado
para status do RPS igual a "S"
O nmero do RPS substitudo informado no
existe na base de dados
Nmero da NFS-e no informado

O campo quantidade de RPS numrico e

dever ter tamanho mximo de 4 dgitos.
Utilize o tipo RPS-C"
Utilize no cabealho do arquivo datas de emisso
da Nota Fiscal compreendidas entre a data incio
de emisso do lote e a data fim de emisso do
lote.
Informe o nmero do RPS substitudo.
Informe o nmero do RPS substitudo correto
Informe o nmero da NFS-e.

Nmero da NFS-e inexistente na base de

Informe o nmero correto da NFS-e.
dados para o prestador de servio pesquisado
Essa NFS-e j est cancelada
Confira e informe novamente os dados da NFS-e
que deseja cancelar.

32

Pgina 33 de 36
Reviso 1.00

E80

Cdigo de verificao no informado

E81

Cdigo de verificao no corresponde NFS- Informe o cdigo de verificao correto.

e consultada
Pesquisa pela atividade s pode ser feita com Informe um cep ou um bairro.
a indicao de um cep ou bairro
Campo Inscrio Municipal do tomador
O campo Inscrio Municipal do tomador
informado incorretamente
numrico e dever ter tamanho mximo de 15
dgitos.
Pesquisa pelo cep s pode ser feita com a
Informe uma atividade.
indicao de uma atividade
Pesquisa pelo bairro s pode ser feita com a Informe uma atividade.
indicao de uma atividade
Nmero do protocolo de recebimento do lote Confira se o lote foi enviado e informe o nmero
inexistente na base de dados
correto do protocolo de recebimento.
Nmero de lote inexistente na base de dados Confira se o lote foi enviado e informe o nmero
correto.
Nmero de lote no informado
Informe o nmero do lote.

E82
E83

E84
E85
E86
E87
E88
E89
E90
E91

No existe na base de dados uma NFS-e

emitida para o nmero de RPS informado
Nmero do RPS invlido

E93

Esse RPS no foi enviado para a nossa base

de dados
Esse RPS foi enviado para a nossa base de
dados, mas ainda no foi processado
Srie informada invlida

E94

Ms de competncia no informado.

E95

Ms de competncia informado
incorretamente.
Campo nmero do RPS informado
incorretamente
Campo srie do RPS informado
incorretamente
Valor dos servios no informado.

E92

E96
E97
E98
E99
E100

E101

E102

E103

E104
E105
E106
E107
E108
E109

Informe o cdigo de verificao da NFS-e.

Informe o nmero correto do RPS.

Informe um nmero de RPS que corresponda
seqncia utilizada pelo prestdor de servio.
Exija do prestador do servio a emisso da NFSe.
Faa uma nova consulta mais tarde.
Informe a srie correta para o RPS pesquisado.
Informe o ms de competncia no formato
AAAAMM.
Informe o ms de competncia no formato
AAAAMM.
O campo Nmero do RPS nmerico e dever
ter tamanho mximo de 15 dgitos.
O campo Srie do RPS alfa-nmerico e dever
ter tamanho mximo de 5 caracteres.
Informe o valor dos servios.

Valor da reteno dever ser inferior ou igual No permitido valor de reteno superior ao
ao valor dos servios
valor de servios.
Campo valor dos servios informado
O campo valor dos servios nmerico e dever
incorretamente
ter tamanho mximo de 15,2, ou seja, 15
nmeros inteiros e dois decimais.
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.
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.
Retenao de tributo federal informada
O campo referente a reteno de tributo federal
incorretamente
nmerico e dever ter tamanho mximo de
15,2, ou seja, 15 nmeros inteiros e dois
decimais.
Campo item da lista de servio informado
O campo item da lista de servio dever ter
incorretamente
tamanho mximo de 4 caracteres.
Campo cdigo CNAE informado
O campo cdigo CNAE dever ter tamanho
incorretamente
mximo de 7 caracteres.
Campo cdigo de tributao do municpio
O campo cdigo de tributao do municpio
informado incorretamente
dever ter tamanho mximo de 20 caracteres.
Campo discriminao do servio informado
O campo discriminao do servio dever ter
incorretamente.
tamanho mximo de 2000 caracteres.
Campo municpio da prestao do servio
O campo municpio da prestao do servio
informado incorretamente.
dever ter tamanho mximo de 7 dgitos.
Campo cidade do tomador informado
O campo cidade do tomador dever ter tamanho
incorretamente.
mximo de 7 dgitos, consulte tabela do IBGE..

33

Pgina 34 de 36
Reviso 1.00

E110

E111
E112

E113

E114
E115
E116

E117
E118

E119
E120
E121
E122
E123
E124
E125
E126
E127
E128
E129
E130
E131

E132

E133
E134
E135
E136

Quando a natureza da operao for

tributao fora do municpio, o campo
municpio da prestao do servio dever ser
diferente do municpio do prestador
Municpio da prestao do servio no
informado.
Campo Inscrio Municipal do intermediario
informado incorretamente

Informar o municpio da prestao do servio

corretamente.

Informe o municpio da prestao do servio, de

acordo com a tabela do IBGE.
O campo Inscrio Municipal do intermediario
numrico e dever ter tamanho mximo de 15
dgitos.
Campo nmero do endereo do tomador no A informao do nmero do endereo do
informado (obrigatrio para tomador com
tomador obrigatria para tomadores pessoas
CNPJ)
jurdicas (com CNPJ).
Campo bairro do tomador no informado
A informao do bairro do tomador obrigatria
(obrigatrio para tomador com CNPJ)
para tomadores Pessoas Jurdicas (com CNPJ).
Campo UF do tomador no informado
O preenchimento da UF do tomador obrigatrio
para tomadores pessoas jurdicas (com CNPJ).
(obrigatrio para tomador com CNPJ)
A UF do tomador informada no foi
Informe a UF correta do tomador. Em caso de
encontrada na base de dados.
cidades do exterior (fora do pas), preencher a
UF com "EX" e a cidade do tomador com 99999.
Campo razo social do tomador informado
O campo razo social do tomador dever ter
incorretamente.
tamanho mximo de 115 caracteres.
Campo razo social do tomador no
O campo razo social do tomador dever ser
informado
informado quando o campo Indicador de
CPF/CNPJ do tomador for preenchido com 1 CPF ou 2 - CNPJ.
Campo endereo do tomador informado
O campo endereo do tomador dever ter
incorretamente.
tamanho mximo de 125 caracteres.
Campo nmero do endereo do tomador
O campo nmero do endereo do tomador
informado incorretamente.
dever ter tamanho mximo de 10 caracteres.
Campo complemento do endereo do
O campo complemento do endereo do tomador
tomador informado incorretamente.
dever ter tamanho mximo de 60 caracteres.
Campo bairro do tomador informado
O campo bairro do tomador dever ter tamanho
incorretamente.
mximo de 60 caracteres.
Campo AliquotaServicos no informado para Informe a aliquota do ISS quando a tributao
tributao fora do municpio.
for fora do municpio
Campo UF do tomador informado
O campo UF do tomador dever ter tamanho
incorretamente.
mximo de 2 caracteres.
Campo CEP do tomador informado
O campo CEP do tomador dever ter tamanho
incorretamente.
mximo de 8 dgitos.
Campo e-mail do tomador informado
O campo e-mail do tomador dever ter tamanho
incorretamente.
mximo de 80 caracteres.
Campo telefone do tomador informado
O campo telefone do tomador dever ter
incorretamente.
tamanho mximo de 11 caracteres.
Campo razo social do intermedirio do
O campo razo social do intermedirio do servio
servio informado incorretamente.
dever ter tamanho mximo de 115 caracteres.
Campo cdigo da obra informado
O campo cdigo da obra dever ter tamanho
incorretamente.
mximo de 15 caracteres.
Campo ART informado incorretamente.
O campo ART dever ter tamanho mximo de 15
caracteres.
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.
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.
Data final da pesquisa no poder ser
Informe uma data final igual ou anterior a data
supeiror a data de hoje.
de hoje
A data final no poder ser anterior data
Informe uma data final igual ou superior a data
inicial
inicial da pesquisa
O perodo de pesquisa no poder ser
Limitar as datas de incio e final a um perodo de
superior a um ano.
um ano
Campo nmero da NFS-e informado
O campo nmero da NFS-e nmerico e dever

34

Pgina 35 de 36
Reviso 1.00

incorretamente

ter tamanho mximo de 15 dgitos.

Data de emisso da NFS-e informada

incorretamente
CNPJ no autorizado a realizar o servio

Informe a data correta da emisso da NFS-e a

ser consultada.
Informe o CNPJ autorizado a executar o servio.

E139

Campo nmero da NFS-e substituda

informado incorretamente

O campo nmero da NFS-e substituda

nmerico e dever ter tamanho mximo de 15
dgitos.

E140

Bairro do prestador inexistente

E141

Inscrio Municipal do prestador no

informada
Inscrio Municipal do prestador no est
vinculada ao CNPJ informado.
Inscrio Municipal do tomador no est
vinculada ao CNPJ informado.
Natureza da operao invlida.

E137
E138

E142

informe a Inscrio Municipal do prestador.

E147

Acerte a Inscrio Municipal ou o CNPJ do

prestador.
Acerte a Inscrio Municipal ou o CNPJ do
tomador.
Utilize um dos tipos: 01 Tributao no
municipio; 02 Tributao fora do municipio; 03
Iseno; 04 Imune; 05 Exigibilidade
suspensa por deciso judicial; 06 Exigibilidade
suspensa por procedimento administrativo.
Regime Especial de Tributao invlido.
Utilize um dos tipos: 01 Microempresa
Municipal; 02 Estimativa; 03 Sociedade de
Profissionais; 4 Cooperativa; 5 Microempresrio Individual (MEI)
6 - Microempresrio e Empresa de Pequeno
Porte (ME EPP).
Informao de optante pelo simples nacional Utilize um dos tipos: 1 Sim; 2 - No.
invlida.
informao de incentivador cultural invlida. Utilize um dos tipos: 1 Sim; 2 - No.

E148

Status do RPS no informado

Informe o status do RPS.

E149
E150

Campo CNPJPrestador informado

incorretamente
Srie do RPS no informada

E151

Quantidade de RPS no informada

O campo CNPJPrestador nmerico e dever ter

tamanho mximo de 14 dgitos.
Campo de preenchimento obrigatrio, caso no
utilize srie, preencha o campo com 00000.
Informe a quantidade de RPS.

E152

Campo ISSRetido no informado.

E143
E144

E145

E146

E153

E154

E155
E156
E157
E158

E159
E160
E161

Informe um dos tipos: 1 para ISS Retido ou 2

para ISS no Retido.
Campo ValorISSRetido informado
O campo ValorISSRetido nmerico e dever ter
tamanho mximo de 15,2, ou seja, 15 nmeros
incorretamente
inteiros e dois decimais.
Campo CNPJ/CPF do Intermediario do Servio O campo CNPJ/CPF do Intermediario do Servio
informado incorretamente
nmerico e dever ter tamanho mximo de 14
dgitos.
Campo CPFCNPJTomador informado
O campo CPFCNPJTomador nmerico e dever
incorretamente
ter tamanho mximo de 14 dgitos.
CNPJ do prestador no autorizado a emitir
Solicite autorizao para emitir NFS-e para o
NFS-e
CNPJ informado.
Usurio no est autorizado a utilizar esse
Solicite ao contribuinte autorizao para utilizar
servio para esse contribuinte.
o servio em seu nome.
Campo Inscrio Municipal do prestador
O campo Inscrio Municipal do prestador
informado incorretamente
numrico e dever ter tamanho mximo de 15
dgitos.
CNPJ do prestador especificado no lote no
Informe corretamente o CNPJ do prestador no
confere com o prestador informado no RPS. lote e no RPS.
Arquivo enviado fora da estrutura do arquivo Envie um arquivo dentro do schema do arquivo
XML de entrada.
XML de entrada.
Campo ValorISS no informado para
Informe o valor do ISS quando a tributao for
tributao fora do municpio.
fora do municpio

35

Pgina 36 de 36
Reviso 1.00

4.2

TABELA DE ALERTAS

CD.

MENSAGEM

INTERPRETAO

A1

Item da lista de servio, cdigo CNAE ou

cdigo de tributao informado para a
operao no est cadastrado para o
prestador de servio

A2

Item da lista de servio, cdigo CNAE ou

cdigo de tributao informado para a
operao no permite deduo na base de
clculo
Item da lista de servio informado para a
operao no permite tributao fora do
municpio

Verifique se o item ou cdigo informado est

correto. Se estiver, proceda a atualizao
cadastral 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.
Consulte a legislao vigente para saber se o
item ou cdigo informado permite deduo da
base de clculo

A3

A4

Valor do ISS retido diferente do ISS devido

A5

O CNPJ informado possui inscrio no

municpio, porm foi informado endereo de
fora do municpio.
A inscrio municipal do tomador no foi
encontrada na base de dados de CCM.
Inscrio Municipal do tomador de servios
consta como cancelada.

A6
A7

A8

E-mail do tomador de servios invlido. Email no ser enviado.

Consulte a legislao vigente para saber se o

item informado permite a tributao fora do
municpio (Foi informada a Natureza da
Operao "2")
Verifique se os valores esto corretos
O sistema ir considerar o tomador conforme
todos os dados informados no arquivo (endereo
de fora do municpio).
O sistema ir interpretar como se o tomador no
tivesse inscrio no CCM.
A inscrio municipal do tomador fornecida
consta como cancelada na base de dados do
municipio.
O e-mail do tomador de servios no vlido.
Este campo ser ignorado e no haver envio de
e-mail.

36