Você está na página 1de 42

Manual de Integrao

Verso 2.02
Novembro/2012

Pgina 2 de 42
Reviso 2.02

SUMRIO
1

INTRODUO ..................................................................................................... 4

CONSIDERAES INICIAIS .............................................................................. 5


2.1
2.2

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


RECIBO PROVISRIO DE SERVIO - RPS........................................................... 5

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

ESTRUTURA DE DADOS DO WEB SERVICE................................................. 20


4.1
4.1.1
4.1.2
4.2
4.3
4.4
4.5
4.5.1
4.5.2
4.5.3
4.5.4
4.5.5
4.5.6

MODELO OPERACIONAL ................................................................................. 20


SERVIOS SNCRONOS ............................................................................... 20
SERVIOS ASSNCRONOS ........................................................................... 21
FORMATOS E PADRES UTILIZADOS ................................................................ 21
TIPOS SIMPLES ............................................................................................. 21
TIPOS COMPLEXOS ........................................................................................ 21
SERVIOS ..................................................................................................... 21
RECEPO DE LOTE DE RPS...................................................................... 21
ENVIAR LOTE DE RPS SNCRONO ............................................................... 21
GERAO DE NFS-E .................................................................................. 21
CANCELAMENTO NFS-E ............................................................................. 21
SUBSTITUIO NFS-E ................................................................................ 21
CONSULTA DE LOTE DE RPS ...................................................................... 21
2

Pgina 3 de 42
Reviso 2.02

4.5.7
4.5.8
4.5.9
4.5.10

CONSULTA DE NFS-E POR RPS.................................................................. 21


CONSULTA DE NFS-E SERVIOS PRESTADOS ........................................... 21
CONSULTA DE NFS-E SERVIOS TOMADOS OU INTERMEDIADOS ................. 21
CONSULTA DE NFS-E POR FAIXA ................................................................. 21

Pgina 4 de 42
Reviso 2.02

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 42
Reviso 2.02

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 42
Reviso 2.02

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 42
Reviso 2.02

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.
Prestador
Administrao Tributria Municipal

Aplicao Cliente
b

<XML>
Lote de RPS

c
NFS-e

a
d
RPS

<XML>
Mensagem

Web Services

NFS-e

Fila de Processos

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

Pgina 8 de 42
Reviso 2.02

Prestador

Administrao Tributria Municipal

Aplicao Cliente
2.c

<XML>
Lote de RPS

2.b

Consistncia

2.a

2.e

Web Services

<XML>
NFS-e / Mensag.

2.d
NFS-e
Processamento
Resultado

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).
2. A requisio recebida pelo servidor do Web Service que grava as informaes
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.
Prestador

Administrao Tributria Municipal

Aplicao Cliente
2.b

2.c

<XML>
RPS

Consistncia

2.a

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

Web Services

2.d
NFS-e
Processamento
Resultado

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).
2. A requisio recebida pelo servidor do Web Service que grava as informaes
recebidas e processa o RPS (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).

Pgina 9 de 42
Reviso 2.02

3.1.4 Cancelamento de NFS-e


Esse servio permite o cancelamento direto de uma NFS-e sem a sua substituio por outra.
Administrao Tributria Municipal

Prestador
Aplicao Cliente
2.b

<XML>
Identif. da NFS-e

Cancelamento

2.a

2.c

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

Web Services

Processamento

NFS-e

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).
3. O Web Service retorna uma mensagem com o resultado do processamento do
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).

Pgina 10 de 42
Reviso 2.02

2. A requisio recebida pelo servidor do Web Service, que verifica os dados


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.

Administrao Tributria Municipal

Prestador
Aplicao Cliente
b

Web Services

<XML>
Identif. do RPS

Consulta

e
<XML>
Grupo de NFS-e / Msg.

Processamento

NFS-e

NFS-e / Msg

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).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos c e d).
3. O Web Service retorna uma mensagem (a estrutura com a lista da NFS-e geradas ou
as mensagens de erro) com o resultado do processamento do servio (fluxo e).

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.

10

Pgina 11 de 42
Reviso 2.02

Administrao Tributria Municipal

Prestador ou Tomador
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 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).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica a NFS-e correspondente (fluxos 2.c e 2.d).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxo 2.e).

3.1.8 Consulta de NFS-e Servios Prestados


Esse servio permite a obteno de determinada NFS-e j gerada.

Administrao Tributria Municipal


MUNICIPAL

Prestador
Aplicao Cliente

2.C

<XML>
2.B

Identif. do RPS

Consulta

2.A

2.E
<XML>

Web Services

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

NFS-e / Mensag

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).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos 2.C e 2.D).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxos 2.E).

11

Pgina 12 de 42
Reviso 2.02

3.1.9 Consulta de NFS-e Servios Tomados ou Intermediados


Esse servio permite a obteno de determinada NFS-e j gerada.
Administrao Tributria Municipal
Prestador ou Tomador
Aplicao Cliente

2.C

<XML>
2.B

Identif. do RPS

?
Consulta

2.A

2.E

Web Services

<XML>

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

NFS-e / Mensag.

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).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos 2.C e 2.D).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxos 2.E).

3.1.10 Consulta de NFS-e por faixa


Esse servio permite a obteno de determinada NFS-e j gerada.

Administrao Tributria Municipal


Prestador ou Tomador
Aplicao Cliente
2.b

2.c

<XML>
Identif. da NFS-e

Consulta

2.a

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

Web Services

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

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

12

Pgina 13 de 42
Reviso 2.02

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).
2. A requisio recebida pelo servidor do Web Service, que verifica os dados
preenchidos e identifica as NFS-e correspondentes (fluxos 2.c e 2.d).
3. O Web Service retorna uma mensagem com o resultado do processamento do
servio (fluxos 2.e).

3.2

Padres Tcnicos

HTTPS
REQUISIO

CONTRIBUINTE

ADMINISTRAO TRIBUTRIA MUNICIPAL

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.

13

Pgina 14 de 42
Reviso 2.02

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

14

Pgina 15 de 42
Reviso 2.02

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

XS01 Signature

Elemento Pai

Tipo Ocorrncia Descrio

Raiz

XS02 Id

XS01

XS03 SignedInfo

XS01

1-1

Grupo da Informao da assinatura

XS04 CanonicalizationMethod

XS03

1-1

Grupo do Mtodo de Canonicalizao

XS05 Algorithm

XS04

1-1

Atributo Algorithm de
CanonicalizationMethod:
http://www.w3.org/TR/2001/REC-xmlc14n-20010315

XS06 SignatureMethod

XS03

1-1

Grupo do Mtodo de Assinatura

XS07 Algorithm

XS06

1-1

Atributo Algorithm de SignedInfo:


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

XS08 Reference

XS03

1-1

Grupo do Mtodo de Reference

XS09 URI

XS08

1-1

Atributo URI da tag Reference

XS10 Transforms

XS08

1-1

Grupo do algorithm de Transform

RC

XS10

1-1

Regra para o atributo Algorithm do


Transform ser nico

XS12 Transform

XS10

2-2

Grupo de Transform

XS13 Algorithm

XS12

1-1

Atributos vlidos Algorithm do


Transform:
http://www.w3.org/TR/2001/REC-xmlc14n-20010315

XS11 Unique_Transf_Alg

1-1

15

Pgina 16 de 42
Reviso 2.02

Campo

Elemento Pai

Tipo Ocorrncia Descrio


http://www.w3.org/2000/09/xmldsig#e
nveloped-signature

XS14 Xpath

XS12

0-N

Xpath

XS15 DigestMethod

XS08

1-1

Grupo do Mtodo de DigestMethod

XS16 Algorithm

XS15

1-1

Atributo Algorithm de DigestMethod:


http://www.w3.org/2000/09/xmldsig#sh
a1

XS17 DigestValue

XS08

XS18 SignatureValue

XS01

1-1

Grupo do Signature Value

XS19 KeyInfo

XS01

1-1

Grupo do KeyInfo

XS20 X509Data

XS19

1-1

Grupo X509

XS21 X509Certificate

XS20

1-1

Certificado Digital x509 em Base64b

Digest Value (Hash SHA-1 Base64)

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.

16

Pgina 17 de 42
Reviso 2.02

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:

3.3

O RPS, pelo contribuinte, antes do envio do Lote de RPS que o contenha;


O Lote de RPS, 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.

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

cabecalho

Verso

1-1

Verso do leiaute.

versaoDados

1-1

O contedo deste campo indica a


verso do leiaute XML da estrutura
XML informada na rea de dados da
mensagem.

Elemento

Pai

Tipo

Ocorrncia

Tamanho Descrio

1-1

TAG raiz do cabealho da


mensagem.

17

Pgina 18 de 42
Reviso 2.02

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

18

Pgina 19 de 42
Reviso 2.02

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.

19

Pgina 20 de 42
Reviso 2.02

4 ESTRUTURA DE DADOS DO WEB SERVICE


Existir um nico Web Service com todos os servios apresentados no item 3.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
Recepo e Processamento de Lote de RPS

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

20

Pgina 21 de 42
Reviso 2.02

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:

Administrao Tributria Municipal

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

21

Pgina 22 de 42
Reviso 2.02

Administrao Tributria Municipal


Prestador

<XML>
Solicitao

Web Services

Processamento
<XML>
Resultado

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

22

Pgina 23 de 42
Reviso 2.02

Formato

Observao

Valores Percentuais
(decimal)

Formato 00.00
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
15% = 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:

23

Pgina 24 de 42
Reviso 2.02

o
o

Quando forem caracteres o tamanho define a quantidade mxima de


caracteres que o texto poder ter;
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;
Quando for data, no haver definio de tamanho.

Campo

Tipo

Descrio

Tam.

tsNumeroNfse

Nmero da Nota Fiscal de Servio Eletrnica,


formado por um nmero seqencial com 15
posies

15

tsCodigoVerificacao

Cdigo de verificao do nmero da nota

tsStatusRps

Cdigo de status do RPS


1 Normal
2 Cancelado

tsStatusNfse

Cdigo de status da NFS-e


1 Normal
2 Cancelado

tsExigibilidadeIss

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

tsNumeroProcesso

Nmero do processo judicial ou administrativo de


suspenso da exigibilidade

30

tsRegimeEspecialTributacao

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)

tsSimNao

Identificao de Sim/No
1 Sim
2 No

tsResponsavelRetencao

Identificao do responsvel pela reteno do


ISS
1 Tomador
2 Intermedirio

tsPagina

Nmero da pgina da consulta

tsNumeroRps

Nmero do RPS

15

24

Pgina 25 de 42
Reviso 2.02

Campo

Tipo

Descrio

Tam.

tsSerieRps

Nmero de srie do RPS

tsTipoRps

Cdigo de tipo de RPS


1 RPS
2 Nota Fiscal Conjugada (Mista)
3 Cupom

tsOutrasInformacoes

Informaes adicionais ao documento.

255

tsValor

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

Cdigo de item da lista de servio

tsCodigoCnae

Cdigo CNAE

tsCodigoTributacao

Cdigo de Tributao

20

tsAliquota

Alquota. Valor percentual.


Formato: 00.00
Ex: 1% = 1
25,5% = 25.5
10% = 10

4,2

tsDiscriminacao

Discriminao do contedo da NFS-e

tsCodigoMunicipioIbge

Cdigo de identificao do municpio conforme


tabela do IBGE

tsInscricaoMunicipal

Nmero de inscrio municipal

tsRazaoSocial

Razo Social do contribuinte

tsNomeFantasia

Nome fantasia

60

tsCnpj

Nmero CNPJ

14

tsEndereco

Tipo e nome do logradouro (Av.., Rua..., ...)

tsNumeroEndereco

Nmero do imvel

10

tsComplementoEndereco

Complemento de endereo

60

tsBairro

Bairro

60

tsUf

Sigla da unidade federativa

tsCodigoPaisBacen

Cdigo de identificao do municpio conforme


tabela do BACEN

tsCep

Nmero do CEP

tsEmail

E-mail

80

tsTelefone

Telefone

20

tsCpf

Nmero de CPF

11

tsCodigoObra

Cdigo de Obra

15

tsArt

Cdigo ART

15

tsNumeroLote

Nmero do Lote de RPS

15

tsNumeroProtocolo

Nmero do protocolo de recebimento do lote RPS

50

2000
7
15
150

125

25

Pgina 26 de 42
Reviso 2.02

Campo

Tipo

Descrio

Tam.

tsSituacaoLoteRps

Cdigo de situao de lote de RPS


1 No Recebido
2 No Processado
3 Processado com Erro
4 Processado com Sucesso

tsQuantidadeRps

Quantidade de RPS do Lote

tsCodigoMensagemAlerta

Cdigo de mensagem de retorno de servio.

tsDescricaoMensagemAlerta

Descrio da mensagem de retorno de servio.

200

tsCodigoCancelamentoNfse

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
Administrao Tributria Municipal
tsIdTag

Atributo de identificao da tag a ser assinada no


documento XML

tsVersao

Verso do leiaute.
Formato: [1-9]{1}[0-9]{0,1}\.[0-9]{2}

4.4

255

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)

(4)

(5)

(6)

(7)

(3)

Legenda da tabela:
(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 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.

26

Pgina 27 de 42
Reviso 2.02

tcCpfCnpj
Nmero de CPF ou CNPJ
Nome

Tipo

Ocorrncia Descrio

Cpf

tsCpf

1-1

Nmero do Cpf

Cnpj

tsCnpj

1-1

Nmero do Cnpj

Choice

tcEndereco
Representao completa do endereo
Nome

Tipo

Ocorrncia Descrio

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

Tipo

Ocorrncia Descrio

Numero

tsNumeroRps

1-1

Serie

tsSerieRps

1-1

Tipo

tsTipoRps

1-1

27

Pgina 28 de 42
Reviso 2.02

tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio
Nome

Tipo

Ocorrncia Descrio

CpfCnpj

tcCpfCnpj

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

tcIdentificacaoConsulente
Representa dados para identificao do prestador de servio
Nome

Tipo

Ocorrncia Descrio

CpfCnpj

tcCpfCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

tcIdentificacaoIntermediario
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

tcDadosIntermediario
Representa dados para identificao de intermedirio do servio
Nome

Tipo

Ocorrncia Descrio

IdentificacaoIntermediario

tcIdentificacaoIntermediario

1-1

RazaoSocial

tsRazaoSocial

1-1

28

Pgina 29 de 42
Reviso 2.02

tcValoresDeclaracaoServico
Representa um conjunto de valores que compe a declarao do servio
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

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
Nome

Tipo

Ocorrncia Descrio

BaseCalculo

tsValor

0-1

Aliquota

tsAliquota

0-1

ValorIss

tsValor

0-1

ValorLiquidoNfse

tsValor

1-1

(Valor dos servios - Valor


das dedues - descontos
incondicionados)

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

29

Pgina 30 de 42
Reviso 2.02

tcDadosServico
Representa dados que compe o servio prestado
Nome

Tipo

Ocorrncia

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

CodigoMunicipio

tsCodigoMunicipioIbge

1-1

CodigoPais

tsCodigoPaisBacen

0-1

ExigibilidadeISS

tsExigibilidadeISS

1-1

MunicipioIncidencia

tsCodigoMunicipioIbge

0-1

NumeroProcesso

tsNumeroProcesso

0-1

Descrio

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil
Nome

Tipo

Ocorrncia Descrio

CodigoObra

tsCodigoObra

0-1

Art

tsArt

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

30

Pgina 31 de 42
Reviso 2.02

tcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS)
Nome

Tipo

Ocorrncia Descrio

IdentificacaoRps

tcIdentificacaoRps

1-1

DataEmissao

Date

1-1

Status

tsStatusRps

1-1

RpsSubstituido

tcIdentificacaoRps

0-1

Id

tsIdTag

Identificador da TAG a ser


assinada

tcInfDeclaracaoPrestacaoServico
Representa dados do da declarao do prestador do servio
Nome

Tipo

Ocorrncia

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

Descrio

Identificador da TAG a
ser assinada

tcDeclaracaoPrestacaoServico
Representa a estrutura da declarao da prestao do servio assinada
Nome

Tipo

Ocorrncia Descrio

InfDeclaracaoPrestacaoServico

tcInfDeclaracaoPrestacaoServico

1-1

Signature

dsig:Signature

0-1

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

Tipo

Ocorrncia Descrio

Numero

tsNumeroNfse

1-1

CpfCnpj

tcCpfCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

CodigoMunicipio

tsCodigoMunicipioIbge

1-1

31

Pgina 32 de 42
Reviso 2.02

tcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica
Nome

Tipo

Ocorrncia Descrio

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

PrestadorServico

tcDadosPrestador

1-1

OrgaoGerador

tcIdentificacaoOrgaoGerador

1-1

DeclaracaoPrestacaoServico

tcDeclaracaoPrestacaoServico

1-1

Id

tsIdTag

Dentro dessa estrutura


est o RPS, como no
obrigatrio
Identificador da TAG a ser
assinada

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

Tipo

Ocorrncia Descrio

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

Tipo

Ocorrncia Descrio

IdentificacaoNfse

tcIdentificacaoNfse

1-1

CodigoCancelamento

tsCodigoCancelamentoNfse

0-1

Id

tsIdTag

Identificador da TAG a ser


assinada

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

Tipo

Ocorrncia Descrio

InfPedidoCancelamento

tcInfPedidoCancelamento

1-1

Signature

Dsig:Signature

0-1

32

Pgina 33 de 42
Reviso 2.02

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

Tipo

Ocorrncia Descrio

Pedido

tcPedidoCancelamento

1-1

DataHora

datetime

1-1

Id

tsIdTag

Identificador da TAG a ser


assinada

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

Tipo

Ocorrncia Descrio

Confirmacao

tcConfirmacaoCancelamento

1-1

Signature

Dsig:Signature

0-1

versao

tsVersao

1-1

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

Tipo

Ocorrncia Descrio

NfseCancelamento

tcCancelamentoNfse

1-1

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

Tipo

Ocorrncia Descrio

NfseSubstituidora

tsNumeroNfse

Id

tsIdTag

1-1
Identificador da TAG a ser
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

33

Pgina 34 de 42
Reviso 2.02

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

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

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
Representa a estrutura do lote de RPS para fila de processamento
Nome

Tipo

Ocorrncia Descrio

NumeroLote

tsNumeroLote

1-1

CpfCnpj

tcCpfCnpj

1-1

InscricaoMunicipal

tsInscricaoMunicipal

0-1

QuantidadeRps

tsQuantidadeRps

1-1

ListaRps

1-1

Rps

tcDeclaracaoPrestacaoServico

Id

tsIdTag

versao

tsVersao

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

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

Tipo

MensagemRetorno

tcMensagemRetornoLote

Ocorrncia Descrio
1-N

34

Pgina 35 de 42
Reviso 2.02

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

Tipo

Ocorrncia Descrio

MensagemRetorno

tcMensagemRetorno

1-N

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

Tipo

Ocorrncia Descrio

MensagemRetorno

tcMensagemRetorno

1-N

cabecalho
Representa a estrutura do cabealho
Nome

Tipo

versaoDados

tsVersao

versao

tsVersao

Ocorrncia Descrio
1-1

CompNfse
Representa a estrutura da NFS-e.
Nome

Tipo

CompNfse

tcCompNfse

4.5

Ocorrncia Descrio
1-1

Servios

A seguir esto os servios relacionados disponveis, conforme descritos no item 3.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

(2)

Tipo
(3)

(4)

Pai

Ocorrncia

(5)

(6)

Observao
(7)

(8)

(9)

Legenda da tabela:
(1)
(2)
(3)

Elemento
Nmero identificador do campo, quando este contiver subitens;
Nome do campo;

35

Pgina 36 de 42
Reviso 2.02

(4)
(5)
(6)

Nome do tipo do campo que pode ser do tipo primitivo, simples ou complexo;
Indica qual o campo pai, para definio da hierarquia;
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);
(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
#

Nome

EnviarLoteRpsEnvio

Tipo

Pai

Ocorrncia

LoteRps

tcLoteRps

1-1

Signature

dsig:Signature

0-1

Observao

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


EnviarLoteRpsResposta
#

Nome

EnviarLoteRpsResposta

Tipo

Pai

Ocorrncia

Observao

1-1

NumeroLote

tsNumeroLote

DataRecebimento

Datetime

Protocolo

tsNumeroProtocolo

ListaMensagemRetorno

ListaMensagemRetorno

Choice
1-1

1-1

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
#

Nome

EnviarLoteRpsSincronoEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

LoteRps

tcLoteRps

1-1

Signature

dsig:Signature

0-1

36

Pgina 37 de 42
Reviso 2.02

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


EnviarLoteRpsSincronoResposta
#

Nome

EnviarLoteRpsSincronoResposta

Tipo

Pai

Ocorrncia

Observao

1-1

NumeroLote

tsNumeroLote

0-1

DataRecebimento

Datetime

0-1

Protocolo

tsNumeroProtocolo

0-1

ListaNfse

ListaNfse

1-1

CompNfse

CompNfse

1-N

ListaMensagemAlertaRetorno

ListaMensagemAlertaRetorno

0-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

ListaMensagemRetornoLote

ListaMensagemRetornoLote

1-1

Choice

4.5.3 Gerao de NFS-e


Esse servio ser executado, inicialmente, pelo mtodo GerarNfse, passando a mensagem
XML como parmetro com a estrutura definida na tabela que segue.
GerarNfseEnvio
#

Nome

GerarNfseEnvio
RPS

Tipo

Pai

Ocorrncia

Observao

1-1
tcDeclaracaoPrestacaoServico

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


GerarNfseResposta
#

Nome

GerarNfseResposta

ListaNfse

ListaNfse

CompNfse

CompNfse

ListaMensagemAlertaRetorno

ListaMensagemAlertaRetorno

ListaMensagemRetorno

ListaMensagemRetorno

Tipo

Pai

Ocorrncia

Observao

1-1
1-1
0-1

Choice

1-1

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.

37

Pgina 38 de 42
Reviso 2.02

CancelarNfseEnvio
#

Nome

CancelarNfseEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

Pedido

tcPedidoCancelamento

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


CancelarNfseResposta
#

Nome

CancelarNfseResposta

Tipo

Pai

Ocorrncia

RetCancelamento

tcRetCancelamento

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Observao

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
#

Nome

SubstituirNfseEnvio

SubstituicaoNfse

Tipo

Pai

Ocorrncia

1-1
1-1

Pedido

tcPedidoCancelamento

Rps

tcDeclaracaoPrestacaoServico

Id

tsIdTag

0-1

Signature

dsig:Signature

0-1

Observao

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


SubstituirNfseResposta
#

Nome

Tipo

Pai

SubstutuirNfseResposta

RetSubstituicao

NfseSubstituida

Ocorrncia

Observao

1-1

1-1

CompNfse

CompNfse

1-1

ListaMensagemAlertaRetorno

ListaMensagemAlertaRetorno

0-1

NfseSubstituidora

CompNfse

CompNfse

ListaMensagemRetorno

ListaMensagemRetorno

Choice

1-1
1-1
1-1

38

Pgina 39 de 42
Reviso 2.02

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
#

Nome

ConsultarLoteRpsEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

Prestador

tcIdentificacaoPrestador

1-1

Protocolo

tsNumeroProtocolo

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


ConsultarLoteRpsResposta
#

Nome

Tipo

Pai

Ocorrncia

ConsultarLoteRpsResposta

Situao

tsSituacaoLoteRps

1-1

ListaNfse

ListaNfse

1-1

CompNfse

CompNfse

1-N

ListaMensagemAlertaRetorno

ListaMensagemAlertaRetorno

0-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

ListaMensagemRetornoLote

ListaMensagemRetornoLote

1-1

Observao

1-1

Choice

4.5.7 Consulta de NFS-e por RPS


Esse servio ser executado pelo mtodo ConsultarNfsePorRps, passando a mensagem
XML como parmetro com a estrutura definida na tabela que segue.
ConsultarNfseRpsEnvio
#

Nome

ConsultarNfseRpsEnvio

Tipo

Pai

Ocorrncia

IdentificacaoRps

tcIdentificacaoRps

1-1

Prestador

tcIdentificacaoPrestador

1-1

Observao

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


ConsultarNfseRpsResposta
#

Nome

ConsultarNfseRpsResposta

Tipo

Pai

Ocorrncia

CompNfse

CompNfse

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Observao

Choice
2

39

Pgina 40 de 42
Reviso 2.02

4.5.8 Consulta de NFS-e Servios Prestados


Esse servio ser executado pelo mtodo ConsultarNfseServicoPrestado, passando a
mensagem XML como parmetro com a estrutura definida na tabela que segue.
ConsultarNfseServicoPrestadoEnvio
#

Nome

ConsultarNfseEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

Prestador

tcIdentificacaoPrestador

1-1

NumeroNfse

tsNumeroNfse

0-1

0-1
1-1

PeriodoEmissao
DataInicial

date

DataFinal

date

1-1
Choice

PeriodoCompetencia

0-1
1-1

DataInicial

date

DataFinal

date

Tomador

tcIdentificacaoTomador

0-1

Intermediario

tcIdentificacaoIntermediario

0-1

Pagina

tsPagina

1-1

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


ConsultarNfseServicoPrestadoResposta
#

Nome

ConsultarNfseResposta

ListaNfse

Tipo

Pai

Ocorrncia

Observao

1-1
1

1-1
1-50

CompNfse

CompNfse

Pagina

tsPagina

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

1-1

4.5.9 Consulta de NFS-e Servios Tomados ou Intermediados


Esse servio ser executado pwlomtodo ConsultarNfseServicoTomado, passando a
mensagem XML como parmetro com a estrutura definida na tabela que segue.
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

40

Pgina 41 de 42
Reviso 2.02

ConsultarNfseServicoTomadoEnvio
#

Nome

ConsultarNfseEnvio

Tipo

Pai

Ocorrncia

Observao

1-1

Consulente

tcIdentificacaoConsulente

1-1

NumeroNfse

tsNumeroNfse

0-1

0-1
1-1

PeriodoEmissao
DataInicial

date

DataFinal

date

PeriodoCompetencia

1-1

0-1
1-1

DataInicial

date

DataFinal

date

Prestador

tcIdentificacaoPrestador

0-1

Tomador

tcIdentificacaoTomador

0-1

Intermediario

tcIdentificacaoIntermediario

0-1

Pagina

tsPagina

1-1

Choice

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.


ConsultarNfseServicoTomadoResposta
#

Nome

ConsultarNfseResposta

ListaNfse

Tipo

Pai

Ocorrncia

Observao

1-1
1

1-1

CompNfse

CompNfse

1-50

Pagina

tsPagina

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

4.5.10 Consulta de NFS-e por faixa


Esse servio ser executado pelo mtodo ConsultarNfseFaixa, passando a mensagem
XML como parmetro com a estrutura definida na tabela que segue.
ConsultarNfseFaixaEnvio
#

Nome

ConsultarNfseFaixaEnvio
Prestador

Tipo

Pai

Ocorrncia

Observao

1-1
tcIdentificacaoPrestador

Faixa

1-1

0-1

NumeroNfseInicial

tsNumeroNfse

1-1

NumeroNfseFinal

tsNumeroNfse

1-1

Pagina

tsPagina

1-1

Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a seguir.

41

Pgina 42 de 42
Reviso 2.02

ConsultarNfseFaixaResposta
#

Nome

ConsultarNfseFaixaResposta

ListaNfse

Tipo

Pai

Ocorrncia

Observao

1-1
1

1-1

CompNfse

CompNfse

1-50

Pagina

tsPagina

1-1

ListaMensagemRetorno

ListaMensagemRetorno

1-1

Choice

42