NFSE-NACIONAL Manual de Integrao Verso 2-01

Verso 2.
01
AbrilDezembro/2011

M
M
a
a
n
n
u
u
a
a
l
l
d
d
e
e
I
I
n
n
t
t
e
e
g
g
r
r
a
a
o
o

Pgina 2 de 43

Reviso 1.002.01

2
SUMRIO

1 INTRODUO..................................................................................................... 4
2 CONSIDERAES INICIAIS .............................................................................. 5
2.1 NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E ............................................. 5
2.2 RECIBO PROVISRIO DE SERVIO - RPS........................................................... 5
3 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE ....................... 7
3.1 MODELO CONCEITUAL...................................................................................... 7
3.1.1 RECEPO E PROCESSAMENTO DE LOTE DE RPS.......................................... 7
3.1.2 ENVIAR LOTE DE RPS SNCRONO ................................................................. 7
3.1.3 GERAO DE NFS-E.................................................................................... 8
3.1.4 CANCELAMENTO DE NFS-E........................................................................... 9
3.1.5 SUBSTITUIO DE NFS-E ............................................................................. 9
3.1.6 CONSULTA DE LOTE DE RPS ...................................................................... 10
3.1.7 CONSULTA DE NFS-E POR RPS.................................................................. 10
3.1.8 CONSULTA DE NFS-E SERVIOS PRESTADOS ........................................... 11
3.1.9 CONSULTA DE NFS-E SERVIOS TOMADOS OU INTERMEDIADOS ................ 12
3.1.10 CONSULTA DE NFS-E POR FAIXA................................................................. 12
3.2 PADRES TCNICOS...................................................................................... 13
3.2.1 PADRO DE COMUNICAO ........................................................................ 13
3.2.2 PADRO DE CERTIFICADO DIGITAL .............................................................. 14
3.2.3 PADRO DE ASSINATURA DIGITAL................................................................ 14
3.2.4 VALIDAO DE ASSINATURA DIGITAL PELO SISTEMA NFS-E .......................... 16
3.2.5 USO DE ASSINATURA COM CERTIFICADO DIGITAL ......................................... 17
3.3 PADRO DAS MENSAGENS XML ..................................................................... 17
3.3.1 REA DO CABEALHO ................................................................................ 17
3.3.2 VALIDAO DA ESTRUTURA DAS MENSAGENS XML....................................... 18
3.3.3 SCHEMAS XML (ARQUIVOS XSD)................................................................ 18
3.3.4 VERSO DOS SCHEMAS XML...................................................................... 18
4 ESTRUTURA DE DADOS DO WEB SERVICE................................................. 20
4.1 MODELO OPERACIONAL ................................................................................. 20
4.1.1 SERVIOS SNCRONOS............................................................................... 20
4.1.2 SERVIOS ASSNCRONOS ........................................................................... 21
4.2 FORMATOS E PADRES UTILIZADOS................................................................ 22
4.3 TIPOS SIMPLES ............................................................................................. 23
4.4 TIPOS COMPLEXOS........................................................................................ 26
4.5 SERVIOS................................................................................................. 3635
4.5.1 RECEPO DE LOTE DE RPS.................................................................. 3736
4.5.2 ENVIAR LOTE DE RPS SNCRONO ........................................................... 3736
4.5.3 GERAO DE NFS-E.............................................................................. 3837
4.5.4 CANCELAMENTO NFS-E ......................................................................... 3837
4.5.5 SUBSTITUIO NFS-E............................................................................ 3938
4.5.6 CONSULTA DE LOTE DE RPS .................................................................. 4039

Pgina 3 de 43

Reviso 1.002.01

3
4.5.7 CONSULTA DE NFS-E POR RPS.............................................................. 4039
4.5.8 CONSULTA DE NFS-E SERVIOS PRESTADOS ....................................... 4140
4.5.9 CONSULTA DE NFS-E SERVIOS TOMADOS OU INTERMEDIADOS............. 4140
4.5.10 CONSULTA DE NFS-E POR FAIXA............................................................. 4241

Pgina 4 de 43

Reviso 1.002.01

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

Pgina 5 de 43

Reviso 1.002.01

5
2 CONSIDERAES INICIAIS
O projeto Nota Fiscal de Servios Eletrnica est sendo concebido
em 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), que 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, por meio do
desenvolvimento de uma soluo para a gerao desse documento fiscal eletrnico como
instrumento de controle da arrecadao e fiscalizao do ISS.
Visa a beneficiar as administraes tributrias padronizando e melhorando a qualidade das
informaes, racionalizando os custos e gerando maior eficcia, bem como aumentar a
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.
2.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
Administrao Tributria Municipal 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 Administrao Tributria Municipal, para a gerao da
mesma, do contribuinte.
2.2 Recibo Provisrio de Servio - RPS
A NFS-e somente ser gerada com a utilizao dos servios informatizados disponibilizados
pelas Administraes Tributrias Municipais. Esse tipo de servio pressupe riscos inerentes
ininterrupta disponibilidade, podendo, eventualmente, em alguns momentos tornar-se
indisponvel.
Visando manter as atividades dos contribuintes ininterruptas, independente de os servios
informatizados disponibilizados pelas Administraes Tributrias Municipais estarem

Pgina 6 de 43

Reviso 1.002.01

6
disponveis, a administrao poder criar, segundo a sua convenincia, 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
sequencial crescente e devendo ser convertido em NFS-e no prazo estipulado pela
legislao tributria municipal.
Por opo da Administrao Tributria Municipal, um RPS poder ser reenviado. Nesse
caso, ser entendido como uma retificao do RPS anteriormente enviado. Nessa situao,
se o RPS reenviado for idntico ao anterior, ser ignorado. Se for diferente do anterior, ser
emitida uma nova NFS-e substituta e cancelada a anterior. Esta funcionalidade dever ser
implementada quando for prevista a circulao do RPS.

Pgina 7 de 43

Reviso 1.002.01

7
3 ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE
3.1 Modelo Conceitual
Utilizando Web Service, o Sistema de Notas Fiscais de Servio Eletrnicas das
Administraes Tributrias Municipais disponibilizar servios que podero ser acessados
pelos sistemas dos contribuintes. A seguir, esto resumidos os servios disponveis e suas
respectivas funcionalidades bsicas.
3.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 quando sero feitas as
validaes necessrias e gerao das NFS-e.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: EnviarLoteRpsEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: EnviarLoteRpsResposta
Passos para execuo
1. A aplicao acessa o servio de Recepo e Processamento de Lote de RPS
enviando o lote de pelo menos 2 (dois) at 50 (cinquenta) RPS (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).
3.1.2 Enviar Lote de RPS Sncrono
Esse servio compreende a recepo do Lote de RPS. Quando efetuada a recepo, o Lote
ser processado e sero feitas as validaes necessrias e gerao das NFS-e.

Prestador
Aplicao Cliente
b
RPS
a
<XML>
Mensagem
<XML>
Lote de RPS
Administrao Tributria Municipal
d Web Services
NFS-e
c
Fila de Processos
NFS-e
e

Pgina 8 de 43

Reviso 1.002.01

8
XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: EnviarLoteRpsSincronoEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: EnviarLoteRpsSincronoResposta
Passos para execuo
1. A aplicao acessa o servio de Enviar Lote de RPS Sncrono enviando o lote (fluxo
2.b).
recebidas e processa o lote (fluxo 2.c).
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 2.d).
3.1.3 Gerao de NFS-e
Esse servio compreende a recepo do RPS. Quando efetuada a recepo, e sero feitas
as validaes necessrias do RPS e gerao das NFS-e.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: GerarNfseEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: GerarNfseResposta
Passos para execuo
1. A aplicao acessa o servio de Gerao de NFS-e enviando o RPS (fluxo 2.b).
recebidas e processa o RPS (fluxo 2.c).
as mensagens de erro) com o resultado do processamento do servio (fluxo 2.d).

2.e Web Services
NFS-e Processamento
Consistncia
? ?
Resultado
2.c
2.d
Prestador
<XML>
Lote de RPS
<XML>
NFS-e / Mensag.

Aplicao Cliente
2.a
2.b

2.e Web Services
NFS-e Processamento
Consistncia
? ?
Resultado
2.c
2.d
Prestador
<XML>
RPS
<XML>
NFS-e / Mensag.

Aplicao Cliente
2.a
2.b

Pgina 9 de 43

Reviso 1.002.01

9
3.1.4 Cancelamento de NFS-e
Esse servio permite o cancelamento direto de uma NFS-e sem a sua substituio por outra.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: CancelarNfseEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: CancelarNfseResposta

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).
servio (fluxo 2.d).
3.1.5 Substituio de NFS-e
Esse servio permite o cancelamento de uma NFS-e com sua substituio por outra.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: SubstituirNfseEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: SubstituirNfseResposta
Passos para execuo
1. A aplicao acessa o servio de Substituio de NFS-e e submete os dados para
processamento (fluxo 2.b).
Prestador
<XML>
Identif. da NFS-e
<XML>
NFS-e / Mensag.

Aplicao Cliente
2.a
2.b

2.d
Web Services
NFS-e Processamento
2.c
Cancelamento

Pgina 10 de 43

Reviso 1.002.01

10
fornecidos, identifica a NFS-e correspondente, processa o RPS, gera a nova NFS-e
e efetua o cancelamento da NFS-e substituda (fluxo 2.c).
3. O Web Service retorna uma mensagem (a estrutura com NFS-e gerada e a
substituda ou as mensagens de erro) como resultado do processamento do servio
(fluxo 2.d).
3.1.6 Consulta de Lote de RPS
Esse servio permite que contribuinte obtenha as NFS-e que foram geradas a partir do Lote
de RPS enviado, quando o processamento ocorrer sem problemas; ou que obtenha 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.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarLoteRpsEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: ConsultarLoteRpsResposta
Passos para execuo
1. A aplicao acessa o servio de Consulta de Lote de RPS e submete os dados para
processamento (fluxo b).
preenchidos e identifica as NFS-e correspondentes (fluxos c e d).
as mensagens de erro) com o resultado do processamento do servio (fluxo e).
3.1.7 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

Processamento
c
d
Consulta
? ?
NFS-e / Msg
NFS-e
e
Web Services <XML>
Identif. do RPS
Aplicao Cliente
a
b
Grupo de NFS-e / Msg.
<XML>

Pgina 11 de 43

Reviso 1.002.01

11

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseRpsEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseRpsResposta
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).
preenchidos e identifica a NFS-e correspondente (fluxos 2.c e 2.d).
servio (fluxo 2.e).
3.1.8 Consulta de NFS-e Servios Prestados
Esse servio permite a obteno de determinada NFS-e j gerada.

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseServicoPrestadoEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd:
ConsultarNfseServicoPrestadoResposta
Passos para execuo
1. A aplicao acessa o servio de Consulta de NFS-e e submete os dados para
processamento (fluxo 2.B).
preenchidos e identifica as NFS-e correspondentes (fluxos 2.C e 2.D).
servio (fluxos 2.E).
Prestador ou Tomador
<XML>
Identif. do RPS
<XML>
NFS-e / Mensag.
Aplicao Cliente
2.a
2.b

2.e
Web Services NFS-e Processamento
Consulta
? ?
NFS-e / Msg
2.c
2.d
Prestador
<XML>
Identif. do RPS

<XML>
NFS-e / Mensag
Aplicao Cliente

2.A
2.B
MUNICIPAL
2.E
Web Services

NFS-e

Processamento

Consulta

? ?
2.C
NFS-e / Msg

2.D

Pgina 12 de 43

Reviso 1.002.01

12
3.1.9 Consulta de NFS-e Servios Tomados ou Intermediados

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseServicoTomadoEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd:
ConsultarNfseServicoTomadoResposta
Passos para execuo
1. A aplicao acessa o servio de Consulta de NFS-e e submete os dados para
processamento (fluxo 2.B).
preenchidos e identifica as NFS-e correspondentes (fluxos 2.C e 2.D).
servio (fluxos 2.E).
3.1.10 Consulta de NFS-e por faixa

XML de Envio validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseFaixaEnvio
XML de Resposta validado pelo elemento do schema do arquivo nfse.xsd: ConsultarNfseFaixaResposta
<XML>
Identif. da NFS-e
<XML>
NFS-e / Mensag.
Aplicao Cliente
2.a
2.b

2.e
Web Services NFS-e Processamento
Consulta
? ?
2.c
NFS-e / Msg
2.d
<XML>
Identif. do RPS

<XML>
NFS-e / Mensag.
Aplicao Cliente
2.A
2.B

2.E
Web Services

NFS-e

Processamento

Consulta
? ?
2.C
NFS-e / Msg

2.D

Pgina 13 de 43

Reviso 1.002.01

13
Passos para execuo
1. A aplicao acessa o servio de Consulta de NFS-e por faixa e submete os dados
para processamento(fluxo 2.b).
preenchidos e identifica as NFS-e correspondentes (fluxos 2.c e 2.d).
servio (fluxos 2.e).
3.2 Padres Tcnicos
3.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 Administraes Tributrias Municipais
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 com a utilizao de
certificados digitais, eliminando a necessidade de identificao do usurio com a utilizao
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 Administraes Tributrias Municipais 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.
CONTRIBUINTE ADMINISTRAO TRIBUTRIA MUNICIPAL
REQUISIO
HTTPS

Pgina 14 de 43

Reviso 1.002.01

14

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 est definido neste manual de
integrao, seo 4.5.
3.2.2 Padro de Certificado Digital
Os certificados digitais utilizados no sistema de Notas Fiscais de Servio
Eletrnicas das Administraes Tributrias Municipais, sero emitidos por
Autoridade Certificadora credenciada pela Infra-estrutura de Chaves Pblicas
Brasileira ICP-Brasil, de pessoa fsica ou jurdica, dos tipos A1 ou A3.
Para a assinatura digital dos documentos envolvidos aceitar-se- que o certificado digital
seja de quaisquer dos estabelecimentos da empresa.
Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao
entre o sistema do contribuinte e o Web Service das Administraes Pblicas Municipais:

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 ou CPF quando o prestador de servios for pessoa fsica. 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 Administraes Pblicas Municipais.
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 ou CPF, quando o prestador de servios for
pessoa fsica, emissor da NFS-e, devendo ter a extenso extended Key Usage com
permisso de "Autenticao Cliente".
3.2.3 Padro de Assinatura Digital
As mensagens enviadas aos servios disponibilizados pelas Administraes Tributrias
Municipais 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 ou o CPF do prestador de servios emissor da NFS-e objeto do
pedido.
SOAP
Provedor
do Servio
Requerente
do Servio

Pgina 15 de 43

Reviso 1.002.01

15
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
Administraes Tributrias Municipais 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>
<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 Elemento Pai Tipo Ocorrncia Descrio
XS01 Signature Raiz
XS02 Id A XS01 C 1-1
XS03 SignedInfo G XS01 1-1 Grupo da Informao da assinatura
XS04 CanonicalizationMethod G XS03 1-1 Grupo do Mtodo de Canonicalizao
XS05 Algorithm A XS04 C 1-1 Atributo Algorithm de
CanonicalizationMethod:
http://www.w3.org/TR/2001/REC-xml-
c14n-20010315
XS06 SignatureMethod G XS03 1-1 Grupo do Mtodo de Assinatura
XS07 Algorithm A XS06 C 1-1 Atributo Algorithm de SignedInfo:
http://www.w3.org/2000/09/xmldsig#rs
a-sha1
XS08 Reference G XS03 1-1 Grupo do Mtodo de Reference
XS09 URI A XS08 C 1-1 Atributo URI da tag Reference
XS10 Transforms G XS08 1-1 Grupo do algorithm de Transform
XS11 Unique_Transf_Alg RC XS10 1-1 Regra para o atributo Algorithm do
Transform ser nico
XS12 Transform G XS10 2-2 Grupo de Transform
XS13 Algorithm A XS12 C 1-1 Atributos vlidos Algorithm do
Transform:
http://www.w3.org/TR/2001/REC-xml-
c14n-20010315

Pgina 16 de 43

Reviso 1.002.01

16
# Campo Elemento Pai Tipo Ocorrncia Descrio
http://www.w3.org/2000/09/xmldsig#e
nveloped-signature
XS14 Xpath E XS12 C 0-N Xpath
XS15 DigestMethod G XS08 1-1 Grupo do Mtodo de DigestMethod
XS16 Algorithm A XS15 C 1-1 Atributo Algorithm de DigestMethod:
http://www.w3.org/2000/09/xmldsig#sh
a1
XS17 DigestValue E XS08 C 1 Digest Value (Hash SHA-1 Base64)
XS18 SignatureValue G XS01 1-1 Grupo do Signature Value
XS19 KeyInfo G XS01 1-1 Grupo do KeyInfo
XS20 X509Data G XS19 1-1 Grupo X509
XS21 X509Certificate E XS20 C 1-1 Certificado Digital x509 em Base64b

Observao:
Os RPSs e lote devem ser assinados conforme os seguintes passos:
1. Assinatura do RPS isoladamente neste momento deve ser identificado o
namespace (http://www.abrasf.org.br/nfse.xsd) em cada RPS que ser assinado
2. Agrupar todos os RPS assinados em um nico lote
3. Assinar o lote com os RPS's, tambm identificando o namespace
http://www.abrasf.org.br/nfse.xsd
3.2.4 Validao de Assinatura Digital pelo Sistema NFS-e
Para a validao da assinatura digital, seguem as regras que sero adotadas pelas
Administraes Tributrias Municipais:
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 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 Administrao Tributria Municipal,
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.

Pgina 17 de 43

Reviso 1.002.01

17
3.2.5 Uso de Assinatura com Certificado Digital
Para garantir a autenticidade dos dados gerados, algumas informaes podero ser
assinadas digitalmente, conforme determinao Administrao Tributria Municipal. Abaixo
seguem as informaes que podero ser assinadas e quem dever faz-lo em cada
momento:
O RPS, pelo contribuinte, antes do envio do Lote de RPS que o contenha;
O Lote de RPS (apenas as informaes do lote), pelo contribuinte, antes do seu
envio;
A NFS-e:
o Pela Administrao Tributria Municipal e pelo contribuinte, quando gerada
pela Aplicao On Line;
o Pela Administrao Tributria Municipal nos demais casos;
O Pedido de cancelamento da NFS-e, pelo contribuinte;
A Confirmao de cancelamento da NFS-e, pela Administrao Tributria Municipal;
A Confirmao de substituio da NFS-e, pela Administrao Tributria Municipal.
3.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 Administraes Tributrias Municipais e os
respectivos resultados do processamento so realizadas com utilizao de 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 Administraes
Tributrias Municipais, que contm os dados de controle da mensagem. A rea de
cabealho est sendo utilizada para armazenar a verso do leiaute da estrutura XML
informada na rea de dados
rea de Dados estrutura XML varivel definida na documentao do Web Service
acessado.
3.3.1 rea do Cabealho
Abaixo, o leiaute da rea de Cabealho padro:
# Nome Elemento Pai Tipo Ocorrncia Tamanho Descrio
1 cabecalho G 1-1 TAG raiz do cabealho da
mensagem.
Verso A 1 N 1-1 4 Verso do leiaute.
2 versaoDados E 1 N 1-1 4 O contedo deste campo indica a
verso do leiaute XML da estrutura
XML informada na rea de dados da
mensagem.

Pgina 18 de 43

Reviso 1.002.01

18
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.
3.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, seus 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 s 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.
3.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 Administraes Tributrias Municipais.
3.3.4 Verso dos Schemas XML
Toda mudana de layout das mensagens XML do Web Service implica a 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

Pgina 19 de 43

Reviso 1.002.01

19
Exemplo:
EnvioLoteRps_v01.xsd
A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de
Notas Fiscais de Servio Eletrnicas das Administraes Tributrias Municipais utilizam as
definies de tipos simples ou tipos complexos que esto definidos em outros Schemas
XML. Nesses 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 Administraes Tributrias Municipais e ocorrero sempre que se fizerem
necessrias.

Pgina 20 de 43

Reviso 1.002.01

20
4 ESTRUTURA DE DADOS DO WEB SERVICE
Existir um nico Web Service com todos os servios apresentados no item 3.13.1. O fluxo
de comunicao sempre iniciado pelo sistema do contribuinte com o envio de uma
mensagem XML ao Web Service com o pedido do servio desejado.
4.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 a uma demanda de processamento de grande
quantidade de informao. Nessa 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 Implementao
Recepo e Processamento de Lote de RPS Assncrona
Enviar Lote de RPS Sncrono Sncrona
Gerao de NFS-e Sncrona
Cancelamento de NFS-e Sncrona
Substituio de NFS-e Sncrona
Consulta de Lote de RPS Sncrona
Consulta de NFS-e por RPS Sncrona
Consulta de NFS-e Servios Prestados Sncrona
Consulta de NFS-e Servios Tomados ou Intermediados Sncrona
Consulta de NFS-e por faixa Sncrona
4.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:
Etapas do processo ideal:
1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao
de servio para o Web Service;

Pgina 21 de 43

Reviso 1.002.01

21
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.
4.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:

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 ou CPF 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;
Prestador
<XML>
Resultado
<XML>
Solicitao
Web Service
Fila de Processos

Pgina 22 de 43

Reviso 1.002.01

22

Obteno do resultado do servio:
1. O aplicativo do contribuinte, utilizando o 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.
4.2 Formatos e Padres Utilizados
Abaixo seguem 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
Data/Hora (datetime) 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
Valores Decimais
(decimal)
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
Prestador

Processamento
Web Services <XML>
Solicitao
<XML>
Resultado

Pgina 23 de 43

Reviso 1.002.01

23
Formato Observao
Valores Percentuais
(decimal)
Formato 00.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% = 62
150% = 15
25,32 = 25.32

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 a 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 para os quais
no h indicao de obrigatoriedade e que, no entanto, seu preenchimento torna-se
obrigatrio seja condicionado legislao especfica ou ao negcio do contribuinte. Nesse
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);
Para quebra de linha na exibio para os campos contendo caracteres Discriminacao
e Outrasinformacoes, utilizar a sequncia \s\n.
As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser enviada
quando seus valores forem nulos.
4.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;
o T: Token
Descrio: descreve informaes sobre o campo;
Tam.: tamanho do campo:

Pgina 24 de 43

Reviso 1.002.01

24
o Quando forem 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 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 N Nmero da Nota Fiscal de Servio Eletrnica,
formado por um nmero seqencial com 11
posies
15
tsCodigoVerificacao C Cdigo de verificao do nmero da nota 9
tsStatusRps N Cdigo de status do RPS
1 Normal
2 Cancelado
1
tsStatusNfse N Cdigo de status da NFS-e
1 Normal
2 Cancelado
1
tsExigibilidadeIss N Cdigo de natureza da operao
1 Exigvel;
2 No incidncia;
3 Iseno;
4 Exportao;
5 Imunidade;
6 Exigibilidade Suspensa por Deciso Judicial;
7 Exigibilidade Suspensa por Processo
Administrativo
2
tsNumeroProcesso C Nmero do processo judicial ou administrativo de
suspenso da exigibilidade
30
tsRegimeEspecialTributacao N 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)
2
tsSimNao N Identificao de Sim/No
1 Sim
2 No
1
tsResponsavelRetencao N Identificao do responsvel pela reteno do
ISS
1 Tomador
2 Intermedirio
1
tsPagina N Nmero da pgina da consulta 6
tsNumeroRps N Nmero do RPS 15

Pgina 25 de 43

Reviso 1.002.01

25
tsSerieRps C Nmero de srie do RPS 5
tsTipoRps N Cdigo de tipo de RPS
1 RPS
2 Nota Fiscal Conjugada (Mista)
3 Cupom
1
tsOutrasInformacoes C Informaes adicionais ao documento. 255
tsValor N 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
tsItemListaServico C Cdigo de item da lista de servio 5
tsCodigoCnae N Cdigo CNAE 7
tsCodigoTributacao C Cdigo de Tributao 20
tsAliquota N Alquota. Valor percentual.
Formato: 00.00
Ex: 1% = 1
25,5% = 25.5
100% = 100
4,2
tsDiscriminacao C Discriminao do contedo da NFS-e 2000
tsCodigoMunicipioIbge N Cdigo de identificao do municpio conforme
tabela do IBGE
7
tsInscricaoMunicipal C Nmero de inscrio municipal 15
tsRazaoSocial C Razo Social do contribuinte 150
tsNomeFantasia C Nome fantasia 60
tsCnpj C Nmero CNPJ 14
tsEndereco C Tipo e nome do logradouro (Av.., Rua..., ...) 125
tsNumeroEndereco C Nmero do imvel 10
tsComplementoEndereco C Complemento de endereo 60
tsBairro C Bairro 60
tsUf C Sigla da unidade federativa 2
tsCodigoPaisBacen C Cdigo de identificao do municpio conforme
tabela do BACEN
4
tsCep C Nmero do CEP 8
tsEmail C E-mail 80
tsTelefone C Telefone 20
tsCpf C Nmero de CPF 11
tsCodigoObra C Cdigo de Obra 15
tsArt C Cdigo ART 15
tsNumeroLote N Nmero do Lote de RPS 15
tsNumeroProtocolo C Nmero do protocolo de recebimento do lote RPS 50

Pgina 26 de 43

Reviso 1.002.01

26
tsSituacaoLoteRps N Cdigo de situao de lote de RPS
1 No Recebido
2 No Processado
3 Processado com Erro
4 Processado com Sucesso
1
tsQuantidadeRps N Quantidade de RPS do Lote 4
tsCodigoMensagemAlerta C Cdigo de mensagem de retorno de servio. 4
tsDescricaoMensagemAlerta C Descrio da mensagem de retorno de servio. 200
tsCodigoCancelamentoNfse C Cdigo de cancelamento com base na tabela de
Erros e alertas.
1 Erro na emisso
2 Servio no prestado
3 Erro de assinatura
4 Duplicidade da nota
5 Erro de processamento
Importante: Os cdigos 3 (Erro de assinatura) e
5 (Erro de processamento) so de uso restrito da
4
tsIdTag C Atributo de identificao da tag a ser assinada no
documento XML
255
tsVersao T Verso do leiaute.
Formato: [1-9]{1}[0-9]{0,1}\.[0-9]{2}

4.4 Tipos Complexos
A seguir so detalhadas as tabelas de cada tipo composto e seus campos. A tabela est
dividida da seguinte forma:
(1)
(2)
Nome Tipo Ocorrncia Descrio
(4) (5) (6) (7)
(3)
(4) (5) (6) (7)

Legenda da tabela:
(1) Nome do tipo complexo;
(2) Descrio do tipo complexo;
(3) Identifica se a seqncia de campos far parte de uma escolha (Choice);
(4) Nome do campo que faz parte do tipo complexo;
(5) Tipo do campo, que pode ser simples ou complexo;
(6) 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.

Pgina 27 de 43

Reviso 1.002.01

27

tcCpfCnpj
Nmero de CPF ou CNPJ
Cpf tsCpf 1-1 Nmero do Cpf
Choice
Cnpj tsCnpj 1-1 Nmero do Cnpj

tcEndereco
Representao completa do endereo
Endereco tsEndereco 0-1 Tipo e nome do logradouro
Numero tsNumeroEndereco 0-1 Nmero do imvel
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
CodigoPais tsCodigoPaisBacen 0-1 Cdigo do pas
Cep tsCep 0-1 CEP da localidade

tcContato
Representa forma de contato com a pessoa (fsica/jurdica)
Telefone tsTelefone 0-1
Email tsEmail 0-1

tcIdentificacaoOrgaoGerador
Representa dados para identificao de rgo gerador
CodigoMunicipio tsCodigoMunicipioIbge 1-1
Uf tsUf 1-1

tcIdentificacaoRps
Dados de identificao do RPS
Numero tsNumeroRps 1-1
Serie tsSerieRps 1-1
Tipo tsTipoRps 1-1

Pgina 28 de 43

Reviso 1.002.01

28
tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
CpfCnpj tcCpfCnpj 1-1
InscricaoMunicipal tsInscricaoMunicipal 0-1

tcIdentificacaoTomador
Representa dados para identificao do tomador de servio

tcIdentificacaoConsulente
Representa dados para identificao do prestador de servio

tcIdentificacaoIntermediario
Representa dados para identificao do tomador de servio

tcDadosTomador
Representa dados do tomador de servio
IdentificacaoTomador tcIdentificacaoTomador 0-1
RazaoSocial tsRazaoSocial 0-1
Endereco tcEndereco 0-1
Contato tcContato 0-1

tcDadosIntermediario
Representa dados para identificao de intermedirio do servio
IdentificacaoIntermediario tcIdentificacaoIntermediario 1-1

Pgina 29 de 43

Reviso 1.002.01

29

tcValoresDeclaracaoServico
Representa um conjunto de valores que compe a declarao do servio
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
OutrasRetencoes tsValor 0-1
ValorIss tsValor 0-1
Aliquota tsAliquota 0-1
DescontoIncondicionado tsValor 0-1
DescontoCondicionado tsValor 0-1

tcValoresNfse
Representa um conjunto de valores que compe o documento fiscal
BaseCalculo tsValor 0-1 (Valor dos servios - Valor
das dedues - descontos
incondicionados)
Aliquota tsAliquota 0-1
ValorIss tsValor 0-1
ValorLiquidoNfse tsValor 1-1 (ValorServicos - ValorPIS -
ValorCOFINS - ValorINSS -
ValorIR - ValorCSLL -
OutrasRetenoes -
ValorISSRetido -
DescontoIncondicionado -
DescontoCondicionado)

Pgina 30 de 43

Reviso 1.002.01

30

tcDadosServico
Representa dados que compe o servio prestado
Valores tcValoresDeclaracaoServico 1-1
IssRetido tsSimNao 1-1
ResponsavelRetencao tsResponsavelRetencao 0-1
ItemListaServico tsItemListaServico 1-1
CodigoCnae tsCodigoCnae 0-1
CodigoTributacaoMunicipio tsCodigoTributacao 0-1
Discriminacao tsDiscriminacao 1-1
CodigoPais tsCodigoPaisBacen 0-1
ExigibilidadeISS tsExigibilidadeISS 1-1
MunicipioIncidencia tsCodigoMunicipioIbge 0-1
NumeroProcesso tsNumeroProcesso 0-1

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
CodigoObra tsCodigoObra 0-1
Art tsArt 1-1

tcDadosPrestador
Representa dados do prestador do servio
IdentificacaoPrestador tcIdentificacaoPrestador 1-1
NomeFantasia tsNomeFantasia 0-1
Endereco tcEndereco 1-1
Contato tcContato 0-1

Pgina 31 de 43

Reviso 1.002.01

31

tcInfDeclaracaoPrestacaoServico
Representa dados do da declarao do prestador do servio
Rps tcInfRps 0-1
Competencia Date 1-1
Servico tcDadosServico 1-1
Prestador tcIdentificacaoPrestador 1-1
TomadorServico tcDadosTomador 0-1
Intermediario tcDadosIntermediario 0-1
ConstrucaoCivil tcDadosConstrucaoCivil 0-1
RegimeEspecialTributacao tsRegimeEspecialTributacao 0-1
OptanteSimplesNacional tsSimNao 1-1
IncentivoFiscal tsSimNao 1-1
Id tsIdTag Identificador da TAG a
ser assinada

tcDeclaracaoPrestacaoServico
Representa a estrutura da declarao da prestao do servio assinada
InfDeclaracaoPrestacaoServico tcInfDeclaracaoPrestacaoServico 1-1
Signature dsig:Signature 0-1

tcIdentificacaoNfse
Representa dados que identificam uma Nota Fiscal de Servios Eletrnica
Numero tsNumeroNfse 1-1
tcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS)
IdentificacaoRps tcIdentificacaoRps 1-1
DataEmissao Datetime 1-1
Status tsStatusRps 1-1
RpsSubstituido tcIdentificacaoRps 0-1
Id tsIdTag Identificador da TAG a ser
assinada

Pgina 32 de 43

Reviso 1.002.01

32

tcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Numero tsNumeroNfse 1-1
CodigoVerificacao tsCodigoVerificacao 1-1
DataEmissao Datetime 1-1
NfseSubstituida tsNumeroNfse 0-1
OutrasInformacoes tsOutrasInformacoes 0-1
ValoresNfse tcValoresNfse 1-1
ValorCredito tsValor 0-1
EnderecoPrestadorServico tcDadosPrestadortcEndereco 1-1
OrgaoGerador tcIdentificacaoOrgaoGerador 1-1
DeclaracaoPrestacaoServico tcDeclaracaoPrestacaoServico 1-1 Dentro dessa estrutura
est o RPS, como no
obrigatrio
assinada

tcNfse
Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada
InfNfse tcInfNfse 1-1
Signature Dsig:Signature 0-1
versao tsVersao 1-1

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota
Fiscal de Servios Eletrnica.
IdentificacaoNfse tcIdentificacaoNfse 1-1
CodigoCancelamento tsCodigoCancelamentoNfse 0-1
assinada

tcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
InfPedidoCancelamento tcInfPedidoCancelamento 1-1

Pgina 33 de 43

Reviso 1.002.01

33

tcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada
Pedido tcPedidoCancelamento 1-1
DataHora datetime 1-1
assinada

tcRetCancelamento
NfseCancelamento tcNfseCancelamento 1-1

tcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e
Confirmacao tcConfirmacaoCancelamento 1-1
versao tsVersao 1-1

tcRetCancelamento
NfseCancelamento tcCancelamentoNfse 1-1

tcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e.
NfseSubstituidora tsNumeroNfse 1-1
assinada

tcSubstituicaoNfse
Representa a estrutura de substituio de NFS-e.
SubstituicaoNfse tcInfSubstituicaoNfse 1-1 SubstituicaoNfse
Signature dsig:Signature 0-2 Signature
versao tsVersao 1-1 versao

Pgina 34 de 43

Reviso 1.002.01

34

tcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFS-e.
Nfse tcNfse 1-1
NfseCancelamento tcCancelamentoNfse 0-1
NfseSubstituicao tcSubstituicaoNfse 0-1

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio.
Codigo tsCodigoMensagemAlerta 1-1
Mensagem tsDescricaoMensagemAlerta 1-1
Correcao tsDescricaoMensagemAlerta 0-1

tcMensagemRetornoLote
IdentificacaoRps tcIdentificacaoRps 1-1
Codigo tsCodigoMensagemAlerta 1-1
Mensagem tsDescricaoMensagemAlerta 1-1

tcLoteRps
Representa a estrutura do lote de RPS para fila de processamento
NumeroLote tsNumeroLote 1-1
QuantidadeRps tsQuantidadeRps 1-1
ListaRps 1-1
Rps tcDeclaracaoPrestacaoServico 1-N
assinada
versao tsVersao 1-1

ListaMensagemRetornoLote
MensagemRetorno tcMensagemRetornoLote 1-N

Pgina 35 de 43

Reviso 1.002.01

35

ListaMensagemRetorno
MensagemRetorno tcMensagemRetorno 1-N

Pgina 36 de 43

Reviso 1.002.01

36

ListaMensagemAlertaRetorno
MensagemRetorno tcMensagemRetorno 1-N

cabecalho
Representa a estrutura do cabealho
versaoDados tsVersao 1-1
versao tsVersao

CompNfse
Representa a estrutura da NFS-e.
CompNfse tcCompNfse 1-1
4.5 Servios
A seguir esto os servios relacionados disponveis, conforme descritos no item 3.13.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 3.2.1.
As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
(1)
# Nome Tipo Pai Ocorrncia Observao
(2) (3) (4) (5) (6) (7)

(8) (9)

Legenda da tabela:
(1) Elemento
(2) Nmero identificador do campo, quando este contiver subitens;
(3) Nome do campo;
(4) Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo;
(5) Indica qual o campo pai, para definio da hierarquia;
(6) Quantas vezes o campo se repete na estrutura de dados:
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;
(7) Descreve alguma observao pertinente;
(8) Formato de grupo, utilizado para definio de uma escolha (ver prximo item);

Pgina 37 de 43

Reviso 1.002.01

37
(9) Identifica os campos ou grupos que faro parte de uma escolha (Choice).
4.5.1 Recepo de Lote de RPS
Esse servio ser executado, pelo o mtodo RecepcionarLoteRps, passando a mensagem
XML como parmetro com a estrutura definida na tabela que segue.
EnviarLoteRpsEnvio
1 EnviarLoteRpsEnvio
LoteRps tcLoteRps 1 1-1
Signature dsig:Signature 1 0-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.
EnviarLoteRpsResposta
1 EnviarLoteRpsResposta 1-1
NumeroLote tsNumeroLote 1
DataRecebimento Datetime 1
Protocolo tsNumeroProtocolo 1
1-1
2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1
Choice

O lote ser processado posteriormente, sendo o seu resultado disponibilizado para consulta.
4.5.2 Enviar Lote de RPS Sncrono
Esse servio ser executado, inicialmente, pelo mtodo RecepcionarLoteRpsSincrono,
passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
EnviarLoteRpsSincronoEnvio
1 EnviarLoteRpsSincronoEnvio 1-1
LoteRps tcLoteRps 1 1-1

Pgina 38 de 43

Reviso 1.002.01

38
EnviarLoteRpsSincronoResposta
1 EnviarLoteRpsSincronoResposta 1-1
NumeroLote tsNumeroLote 1 0-1
DataRecebimento Datetime 1 0-1
Protocolo tsNumeroProtocolo 1 0-1
2 ListaNfse ListaNfse 1
CompNfse CompNfse 2
ListaMensagemAlertaRetorno ListaMensagemAlertaRetorno 2
1-1
1-N
0-1
4 ListaMensagemRetornoLote ListaMensagemRetornoLote 1 1-1
Choice
4.5.3 Gerao de NFS-e
Esse servio ser executado, inicialmente, pelo mtodo GerarNfse, passando a mensagem
GerarNfseEnvio
1 GerarNfseEnvio 1-1
RPS tcDeclaracaoPrestacaoServico 1 1-1

GerarNfseResposta
1 GerarNfseResposta 1-1
CompNfse CompNfse 2
1-1
1-N
0-1

Choice

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

Pgina 39 de 43

Reviso 1.002.01

39

CancelarNfseEnvio
1 CancelarNfseEnvio 1-1
Pedido tcPedidoCancelamento 1 1-1

CancelarNfseResposta
1 CancelarNfseResposta
RetCancelamento tcRetCancelamento 1 1-1
ListaMensagemRetorno ListaMensagemRetorno 1 1-1
Choice
4.5.5 Substituio NFS-e
Esse servio ser executado pelo mtodo SubstituirNfse, passando a mensagem XML
como parmetro com a estrutura definida na tabela que segue.
SubstituirNfseEnvio
1 SubstituirNfseEnvio
2 SubstituicaoNfse 1 1-1
Pedido tcPedidoCancelamento 2 1-1
Rps tcDeclaracaoPrestacaoServico 2
Id tsIdTag 2 0-1

SubstituirNfseResposta
1 SubstutuirNfseResposta
2 RetSubstituicao RetSubstituicao 1
3 NfseSubstituida NfseSubstituida 2
CompNfse CompNfse 3
4 NfseSubstituidora NfseSubstituidora 2
CompNfse CompNfse 4
1-1
1-1
1-1
0-1
1-1
1-1

Choice

Pgina 40 de 43

Reviso 1.002.01

40
4.5.6 Consulta de Lote de RPS
Esse servio ser executado pelo mtodo ConsultarLoteRps, passando a mensagem XML
como parmetro com a estrutura definida na tabela que segue.
ConsultarLoteRpsEnvio
1 ConsultarLoteRpsEnvio 1-1
Prestador tcIdentificacaoPrestador 1 1-1
Protocolo tsNumeroProtocolo 1 1-1

ConsultarLoteRpsResposta
1 ConsultarLoteRpsResposta 1-1
2 Situao tsSituacaoLoteRps 1 1-1
CompNfse CompNfse 3
1-1
1-N
0-1
5 ListaMensagemRetornoLote ListaMensagemRetornoLote 1 1-1
Choice
4.5.7 Consulta de NFS-e por RPS
Esse servio ser executado pelo mtodo ConsultarNfsePorRps, passando a mensagem
ConsultarNfseRpsEnvio
1 ConsultarNfseRpsEnvio
IdentificacaoRps tcIdentificacaoRps 1 1-1

ConsultarNfseRpsResposta
1 ConsultarNfseRpsResposta
CompNfse CompNfse 1 1-1
Choice

Pgina 41 de 43

Reviso 1.002.01

41
4.5.8 Consulta de NFS-e Servios Prestados
Esse servio ser executado pelo mtodo ConsultarNfseServicoPrestado, passando a
ConsultarNfseServicoPrestadoEnvio
1 ConsultarNfseEnvio 1-1
NumeroNfse tsNumeroNfse 1 0-1
2 PeriodoEmissao 1
DataInicial date 2
DataFinal date 2
0-1
1-1
1-1
3 PeriodoCompetencia 1
DataInicial date 3
DataFinal date 3
0-1
1-1
1-1
Choice
Tomador tcIdentificacaoTomador 1 0-1
Intermediario tcIdentificacaoIntermediario 1 0-1
4 Pagina tsPagina 1 1-1

ConsultarNfseServicoPrestadoResposta
1 ConsultarNfseResposta 1-1
2 ListaNfse 1
CompNfse CompNfse 2
Pagina tsPagina 2
1-1
1-50
1-1
Choice
4.5.9 Consulta de NFS-e Servios Tomados ou Intermediados
Esse servio ser executado pwlomtodo ConsultarNfseServicoTomado, passando a
Observao:
1. A identificao do Tomador ou a identificao do Intermedirio deve ser igual
identificao do Consulente
2. A identificao do Tomador ou a identificao do Intermedirio deve ser informada

Pgina 42 de 43

Reviso 1.002.01

42
ConsultarNfseServicoTomadoEnvio
1 ConsultarNfseEnvio 1-1
Consulente tcIdentificacaoConsulente 1 1-1
NumeroNfse tsNumeroNfse 1 0-1
2 PeriodoEmissao 1
DataInicial date 2
DataFinal date 2
0-1
1-1
1-1
3 PeriodoCompetencia 1
DataInicial date 3
DataFinal date 3
0-1
1-1
1-1

Choice
Tomador tcIdentificacaoTomador 1 0-1
Intermediario tcIdentificacaoIntermediario 1 0-1

ConsultarNfseServicoTomadoResposta
1 ConsultarNfseResposta 1-1
2 ListaNfse 1
CompNfse CompNfse 2
Pagina tsPagina 2
1-1
1-50
1-1
Choice
4.5.10 Consulta de NFS-e por faixa
Esse servio ser executado pelo mtodo ConsultarNfseFaixa, passando a mensagem
ConsultarNfseFaixaEnvio
1 ConsultarNfseFaixaEnvio 1-1
2 Faixa 1 0-1
NumeroNfseInicial tsNumeroNfse 2 1-1
NumeroNfseFinal tsNumeroNfse 2 1-1


Pgina 43 de 43

Reviso 1.002.01

43
ConsultarNfseFaixaResposta
1 ConsultarNfseFaixaResposta 1-1
2 ListaNfse 1
CompNfse CompNfse 2
Pagina tsPagina 2
1-1
1-50
1-1
Choice

NFSE-NACIONAL Manual de Integrao Verso 2-01

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

NFSE-NACIONAL Manual de Integrao Verso 2-01

Enviado por

Direitos autorais:

Formatos disponíveis

Verso 2.

Você também pode gostar