Você está na página 1de 43

Manual de Integrao

Verso 2.01 AbrilDezembro/2011

Pgina 2 de 43 Reviso 1.002.01

SUMRIO
1 2 INTRODUO ..................................................................................................... 4 CONSIDERAES INICIAIS .............................................................................. 5 2.1 2.2 3 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 ................................................................ 22 TIPOS SIMPLES ............................................................................................. 23 TIPOS COMPLEXOS ........................................................................................ 26 SERVIOS ................................................................................................. 3635 RECEPO DE LOTE DE RPS.................................................................. 3736 ENVIAR LOTE DE RPS SNCRONO ........................................................... 3736 GERAO DE NFS-E .............................................................................. 3837 CANCELAMENTO NFS-E ......................................................................... 3837 SUBSTITUIO NFS-E ............................................................................ 3938 CONSULTA DE LOTE DE RPS .................................................................. 4039 2

Pgina 3 de 43 Reviso 1.002.01

4.5.7 4.5.8 4.5.9 4.5.10

CONSULTA DE NFS-E POR RPS.............................................................. 4039 CONSULTA DE NFS-E SERVIOS PRESTADOS ....................................... 4140 CONSULTA DE NFS-E SERVIOS TOMADOS OU INTERMEDIADOS ............. 4140 CONSULTA DE NFS-E POR FAIXA ............................................................. 4241

Pgina 4 de 43 Reviso 1.002.01

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

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

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

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 Aplicao Cliente
b <XML> Lote de RPS

Administrao Tributria Municipal

c NFS-e NFS-e

a d RPS <XML> Mensagem Web Services Fila de Processos 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.

Pgina 8 de 43 Reviso 1.002.01

Prestador Aplicao Cliente


2.b 2.a <XML> Lote de RPS

Administrao Tributria Municipal


2.c

?
Consistncia

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: 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 Aplicao Cliente
2.b 2.a <XML> RPS 2.c

Administrao Tributria Municipal

?
Consistncia

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 43 Reviso 1.002.01

3.1.4 Cancelamento de NFS-e


Esse servio permite o cancelamento direto de uma NFS-e sem a sua substituio por outra.
Prestador Aplicao Cliente
2.b 2.a 2.d <XML> NFS-e / Mensag. Web Services <XML> Identif. da NFS-e Cancelamento 2.c Processamento NFS-e

Administrao Tributria Municipal

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 43 Reviso 1.002.01

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.

Prestador Aplicao Cliente


b a <XML> Identif. do RPS

Administrao Tributria Municipal


Web Services

?
Consulta d NFS-e

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

Processamento

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 43 Reviso 1.002.01

Prestador ou Tomador Aplicao Cliente


2.b 2.a <XML> Identif. do RPS

Administrao Tributria Municipal


2.c

?
Consulta NFS-e

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

Web Services

2.d Processamento NFS-e / Msg

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
<XML> 2.B 2.A Identif. do RPS 2.C

Prestador Aplicao Cliente

?
Consulta

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: 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 43 Reviso 1.002.01

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
<XML> 2.B 2.A Identif. do RPS 2.C

?
Consulta

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: 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.a <XML> Identif. da NFS-e 2.c

?
Consulta

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 43 Reviso 1.002.01

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 43 Reviso 1.002.01

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 43 Reviso 1.002.01

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 Raiz A G G A XS01 XS01 XS03 XS04 C C 1-1 1-1 1-1 1-1 Grupo da Informao da assinatura Grupo do Mtodo de Canonicalizao Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/REC-xmlc14n-20010315 Grupo do Mtodo de Assinatura Atributo Algorithm de SignedInfo: http://www.w3.org/2000/09/xmldsig#rs a-sha1 Grupo do Mtodo de Reference Atributo URI da tag Reference Grupo do algorithm de Transform Regra para o atributo Algorithm do Transform ser nico Grupo de Transform Atributos vlidos Algorithm do Transform: http://www.w3.org/TR/2001/REC-xmlc14n-20010315 Tipo Ocorrncia Descrio

XS01 Signature XS02 Id XS03 SignedInfo XS04 CanonicalizationMethod XS05 Algorithm

XS06 SignatureMethod XS07 Algorithm

G A

XS03 XS06 C

1-1 1-1

XS08 Reference XS09 URI XS10 Transforms XS11 Unique_Transf_Alg XS12 Transform XS13 Algorithm

G A G RC G A

XS03 XS08 XS08 XS10 XS10 XS12 C C

1-1 1-1 1-1 1-1 2-2 1-1

15

Pgina 16 de 43 Reviso 1.002.01

Campo

Elemento Pai

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

XS14 Xpath XS15 DigestMethod XS16 Algorithm

E G A

XS12 XS08 XS15

0-N 1-1

Xpath Grupo do Mtodo de DigestMethod Atributo Algorithm de DigestMethod: http://www.w3.org/2000/09/xmldsig#sh a1 Digest Value (Hash SHA-1 Base64) Grupo do Signature Value Grupo do KeyInfo Grupo X509 Certificado Digital x509 em Base64b

1-1

XS17 DigestValue XS18 SignatureValue XS19 KeyInfo XS20 X509Data XS21 X509Certificate

E G G G E

XS08 XS01 XS01 XS19 XS20

1 1-1 1-1 1-1

1-1

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 43 Reviso 1.002.01

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:
# 1 Nome cabecalho Verso 2 versaoDados Elemento G A E 1 1 N N Pai Tipo Ocorrncia 1-1 1-1 1-1 4 4 Tamanho Descrio TAG raiz do cabealho da mensagem. Verso do leiaute. O contedo deste campo indica a verso do leiaute XML da estrutura XML informada na rea de dados da mensagem.

17

Pgina 18 de 43 Reviso 1.002.01

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 43 Reviso 1.002.01

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 43 Reviso 1.002.01

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 Recepo e Processamento de Lote de RPS Enviar Lote de RPS Sncrono Gerao de NFS-e Cancelamento de NFS-e Substituio de NFS-e Consulta de Lote de RPS Consulta de NFS-e por RPS Consulta de NFS-e Servios Prestados Consulta de NFS-e Servios Tomados ou Intermediados Consulta de NFS-e por faixa Implementao Assncrona Sncrona Sncrona Sncrona Sncrona Sncrona Sncrona Sncrona Sncrona 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 43 Reviso 1.002.01

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:

Prestador
<XML> Solicitao

Administrao Tributria Municipal

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 43 Reviso 1.002.01

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
Data (date)

Observao
Formato: AAAA-MM-DD onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres Formato AAAA-MM-DDTHH:mm:ss onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres T = caractere de formatao que deve existir separando a data da hora HH = hora com 2 caracteres mm: minuto com 2 caracteres ss: segundo com 2 caracteres Formato: 0.00 No deve ser utilizado separador de milhar. O ponto (.) deve ser utilizado para separar a parte inteira da fracionria. Exemplo: 48.562,25 = 48562.25 1,00 = 1.00 ou 1 0,50 = 0.50 ou 0.5

Data/Hora (datetime)

Valores Decimais (decimal)

22

Pgina 23 de 43 Reviso 1.002.01

Formato
Valores Percentuais (decimal)

Observao
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:

23

Pgina 24 de 43 Reviso 1.002.01

o o

o
Campo
tsNumeroNfse

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

Descrio
Nmero da Nota Fiscal de Servio Eletrnica, formado por um nmero seqencial com 11 posies Cdigo de verificao do nmero da nota Cdigo de status do RPS 1 Normal 2 Cancelado Cdigo de status da NFS-e 1 Normal 2 Cancelado Cdigo de natureza da operao 1 Exigvel; 2 No incidncia; 3 Iseno; 4 Exportao; 5 Imunidade; 6 Exigibilidade Suspensa por Deciso Judicial; 7 Exigibilidade Suspensa por Processo Administrativo Nmero do processo judicial ou administrativo de suspenso da exigibilidade Cdigo de identificao do regime especial de tributao 1 Microempresa municipal 2 Estimativa 3 Sociedade de profissionais 4 Cooperativa 5 Microempresrio Individual (MEI) 6 Microempresrio e Empresa de Pequeno Porte (ME EPP) Identificao de Sim/No 1 Sim 2 No Identificao do responsvel pela reteno do ISS 1 Tomador 2 Intermedirio Nmero da pgina da consulta Nmero do RPS

Tam.
15

tsCodigoVerificacao tsStatusRps

C N

9 1

tsStatusNfse

tsExigibilidadeIss

tsNumeroProcesso tsRegimeEspecialTributacao

C N

30 2

tsSimNao

tsResponsavelRetencao

tsPagina tsNumeroRps

N N

6 15

24

Pgina 25 de 43 Reviso 1.002.01

Campo
tsSerieRps tsTipoRps

Tipo
C N

Descrio
Nmero de srie do RPS Cdigo de tipo de RPS 1 RPS 2 Nota Fiscal Conjugada (Mista) 3 Cupom Informaes adicionais ao documento. Valor monetrio. Formato: 0.00 (ponto separando casa decimal) Ex: 1.234,56 = 1234.56 1.000,00 = 1000.00 1.000,00 = 1000 Cdigo de item da lista de servio Cdigo CNAE Cdigo de Tributao Alquota. Valor percentual. Formato: 00.00 Ex: 1% = 1 25,5% = 25.5 100% = 100 Discriminao do contedo da NFS-e Cdigo de identificao do municpio conforme tabela do IBGE Nmero de inscrio municipal Razo Social do contribuinte Nome fantasia Nmero CNPJ Tipo e nome do logradouro (Av.., Rua..., ...) Nmero do imvel Complemento de endereo Bairro Sigla da unidade federativa Cdigo de identificao do municpio conforme tabela do BACEN Nmero do CEP E-mail Telefone Nmero de CPF Cdigo de Obra Cdigo ART Nmero do Lote de RPS Nmero do protocolo de recebimento do lote RPS

Tam.
5 1

tsOutrasInformacoes tsValor

C N

255 15,2

tsItemListaServico tsCodigoCnae tsCodigoTributacao tsAliquota

C N C N

5 7 20 4,2

tsDiscriminacao tsCodigoMunicipioIbge tsInscricaoMunicipal tsRazaoSocial tsNomeFantasia tsCnpj tsEndereco tsNumeroEndereco tsComplementoEndereco tsBairro tsUf tsCodigoPaisBacen tsCep tsEmail tsTelefone tsCpf tsCodigoObra tsArt tsNumeroLote tsNumeroProtocolo

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

2000 7 15 150 60 14 125 10 60 60 2 4 8 80 20 11 15 15 15 50

25

Pgina 26 de 43 Reviso 1.002.01

Campo
tsSituacaoLoteRps

Tipo
N

Descrio
Cdigo de situao de lote de RPS 1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso Quantidade de RPS do Lote Cdigo de mensagem de retorno de servio. Descrio da mensagem de retorno de servio. Cdigo de cancelamento com base na tabela de Erros e alertas. 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

Tam.
1

tsQuantidadeRps tsCodigoMensagemAlerta tsDescricaoMensagemAlerta tsCodigoCancelamentoNfse

N C C C

4 4 200 4

tsIdTag tsVersao

C T

Atributo de identificao da tag a ser assinada no documento XML Verso do leiaute. Formato: [1-9]{1}[0-9]{0,1}\.[0-9]{2}

255

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 (4) (3) (4) (5) (6) (7) Tipo (5) Ocorrncia Descrio (6) (7)

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 43 Reviso 1.002.01

tcCpfCnpj
Nmero de CPF ou CNPJ Nome Cpf Choice Cnpj tsCnpj 1-1 Nmero do Cnpj Tipo tsCpf Ocorrncia Descrio 1-1 Nmero do Cpf

tcEndereco
Representao completa do endereo Nome Endereco Numero Complemento Bairro CodigoMunicipio Uf CodigoPais Cep Tipo tsEndereco tsNumeroEndereco tsComplementoEndereco tsBairro tsCodigoMunicipioIbge tsUf tsCodigoPaisBacen tsCep Ocorrncia Descrio 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 Tipo e nome do logradouro Nmero do imvel Complemento do Endereo Nome do bairro Cdigo da cidade Sigla do estado Cdigo do pas CEP da localidade

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

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

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

27

Pgina 28 de 43 Reviso 1.002.01

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

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

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

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

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

tcDadosIntermediario
Representa dados para identificao de intermedirio do servio Nome IdentificacaoIntermediario RazaoSocial Tipo tcIdentificacaoIntermediario tsRazaoSocial Ocorrncia Descrio 1-1 1-1

28

Pgina 29 de 43 Reviso 1.002.01

tcValoresDeclaracaoServico
Representa um conjunto de valores que compe a declarao do servio Nome ValorServicos ValorDeducoes ValorPis ValorCofins ValorInss ValorIr ValorCsll OutrasRetencoes ValorIss Aliquota DescontoIncondicionado DescontoCondicionado Tipo tsValor tsValor tsValor tsValor tsValor tsValor tsValor tsValor tsValor tsAliquota tsValor tsValor Ocorrncia Descrio 1-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1 0-1

tcValoresNfse
Representa um conjunto de valores que compe o documento fiscal Nome BaseCalculo Tipo tsValor Ocorrncia Descrio 0-1 (Valor dos servios - Valor das dedues - descontos incondicionados)

Aliquota ValorIss ValorLiquidoNfse

tsAliquota tsValor tsValor

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

29

Pgina 30 de 43 Reviso 1.002.01

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

tcDadosConstrucaoCivil
Representa dados para identificao de construo civil Nome CodigoObra Art Tipo tsCodigoObra tsArt Ocorrncia Descrio 0-1 1-1

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

30

Pgina 31 de 43 Reviso 1.002.01

tcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS) Nome IdentificacaoRps DataEmissao Status RpsSubstituido Id Tipo tcIdentificacaoRps Datetime tsStatusRps tcIdentificacaoRps tsIdTag Ocorrncia Descrio 1-1 1-1 1-1 0-1 Identificador da TAG a ser assinada

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

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

Signature

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

31

Pgina 32 de 43 Reviso 1.002.01

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

Id

tsIdTag

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

Signature versao

tcInfPedidoCancelamento
Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota Fiscal de Servios Eletrnica. Nome IdentificacaoNfse CodigoCancelamento Id Tipo tcIdentificacaoNfse tsCodigoCancelamentoNfse tsIdTag Ocorrncia Descrio 1-1 0-1 Identificador da TAG a ser assinada

tcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome InfPedidoCancelamento Tipo tcInfPedidoCancelamento Dsig:Signature Ocorrncia Descrio 1-1 0-1

Signature

32

Pgina 33 de 43 Reviso 1.002.01

tcConfirmacaoCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome Pedido DataHora Id Tipo tcPedidoCancelamento datetime tsIdTag Ocorrncia Descrio 1-1 1-1 Identificador da TAG a ser assinada

tcRetCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome NfseCancelamento Tipo tcNfseCancelamento Ocorrncia Descrio 1-1

tcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e Nome Confirmacao Tipo tcConfirmacaoCancelamento Dsig:Signature tsVersao Ocorrncia Descrio 1-1 0-1 1-1

Signature versao

tcRetCancelamento
Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada Nome NfseCancelamento Tipo tcCancelamentoNfse Ocorrncia Descrio 1-1

tcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFS-e. Nome NfseSubstituidora Id Tipo tsNumeroNfse tsIdTag Ocorrncia Descrio 1-1 Identificador da TAG a ser assinada

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

Signature versao

Signature versao

33

Pgina 34 de 43 Reviso 1.002.01

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

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

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

tcLoteRps
Representa a estrutura do lote de RPS para fila de processamento Nome NumeroLote CpfCnpj InscricaoMunicipal QuantidadeRps ListaRps Rps Id versao tcDeclaracaoPrestacaoServico tsIdTag tsVersao 1-1 Tipo tsNumeroLote tcCpfCnpj tsInscricaoMunicipal tsQuantidadeRps Ocorrncia Descrio 1-1 1-1 0-1 1-1 1-1 1-N Identificador da TAG a ser assinada

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

34

Pgina 35 de 43 Reviso 1.002.01

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

35

Pgina 36 de 43 Reviso 1.002.01

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

cabecalho
Representa a estrutura do cabealho Nome versaoDados versao Tipo tsVersao tsVersao Ocorrncia Descrio 1-1

CompNfse
Representa a estrutura da NFS-e. Nome CompNfse Tipo tcCompNfse Ocorrncia Descrio 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)
# (2) Nome (3) Tipo (4) Pai (5) Ocorrncia (6) (8) Observao (7) (9)

Legenda da tabela: (1) (2) (3) (4) (5) (6) Elemento Nmero identificador do campo, quando este contiver subitens; Nome do campo; 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; Descreve alguma observao pertinente; Formato de grupo, utilizado para definio de uma escolha (ver prximo item);

(7) (8)

36

Pgina 37 de 43 Reviso 1.002.01

(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 Nome EnviarLoteRpsEnvio LoteRps tcLoteRps dsig:Signature 1 1 1-1 0-1 Tipo Pai Ocorrncia Observao

Signature

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


EnviarLoteRpsResposta
# 1 Nome EnviarLoteRpsResposta NumeroLote DataRecebimento Protocolo 2 ListaMensagemRetorno tsNumeroLote Datetime tsNumeroProtocolo ListaMensagemRetorno 1 1 1 1 1-1 1-1 Tipo Pai Ocorrncia 1-1 Choice Observao

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 Nome EnviarLoteRpsSincronoEnvio LoteRps tcLoteRps dsig:Signature 1 1 Tipo Pai Ocorrncia 1-1 1-1 0-1 Observao

Signature

37

Pgina 38 de 43 Reviso 1.002.01

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


EnviarLoteRpsSincronoResposta
# 1 Nome EnviarLoteRpsSincronoResposta NumeroLote DataRecebimento Protocolo 2 ListaNfse CompNfse ListaMensagemAlertaRetorno 3 4 ListaMensagemRetorno ListaMensagemRetornoLote tsNumeroLote Datetime tsNumeroProtocolo ListaNfse CompNfse ListaMensagemAlertaRetorno ListaMensagemRetorno ListaMensagemRetornoLote 1 1 1 1 2 2 1 1 Tipo Pai Ocorrncia 1-1 0-1 0-1 0-1 1-1 1-N 0-1 1-1 1-1 Choice Observao

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
# 1 Nome GerarNfseEnvio RPS tcDeclaracaoPrestacaoServico 1 Tipo Pai Ocorrncia 1-1 1-1 Observao

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


GerarNfseResposta
# 1 2 Nome GerarNfseResposta ListaNfse CompNfse ListaMensagemAlertaRetorno 2 ListaMensagemRetorno ListaNfse CompNfse ListaMensagemAlertaRetorno ListaMensagemRetorno 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 1-N 0-1 1-1 Choice Observao

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.

38

Pgina 39 de 43 Reviso 1.002.01

CancelarNfseEnvio
# 1 Nome CancelarNfseEnvio Pedido tcPedidoCancelamento 1 Tipo Pai Ocorrncia 1-1 1-1 Observao

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


CancelarNfseResposta
# 1 Nome CancelarNfseResposta RetCancelamento ListaMensagemRetorno tcRetCancelamento ListaMensagemRetorno 1 1 1-1 Choice 1-1 Tipo Pai Ocorrncia Observao

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 2 Nome SubstituirNfseEnvio SubstituicaoNfse Pedido Rps Id Signature tcPedidoCancelamento tcDeclaracaoPrestacaoServico tsIdTag dsig:Signature 1 2 2 2 1 0-1 0-1 1-1 1-1 Tipo Pai Ocorrncia Observao

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


SubstituirNfseResposta
# 1 2 3 Nome SubstutuirNfseResposta RetSubstituicao NfseSubstituida CompNfse ListaMensagemAlertaRetorno 4 NfseSubstituidora CompNfse 5 ListaMensagemRetorno RetSubstituicao NfseSubstituida CompNfse ListaMensagemAlertaRetorno NfseSubstituidora CompNfse ListaMensagemRetorno 1 1-1 2 3 3 2 4 1 1-1 1-1 1-1 0-1 1-1 1-1 Choice Tipo Pai Ocorrncia Observao

39

Pgina 40 de 43 Reviso 1.002.01

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 Nome ConsultarLoteRpsEnvio Prestador Protocolo tcIdentificacaoPrestador tsNumeroProtocolo 1 1 Tipo Pai Ocorrncia 1-1 1-1 1-1 Observao

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


ConsultarLoteRpsResposta
# 1 2 3 Nome ConsultarLoteRpsResposta Situao ListaNfse CompNfse ListaMensagemAlertaRetorno 4 5 ListaMensagemRetorno ListaMensagemRetornoLote tsSituacaoLoteRps ListaNfse CompNfse ListaMensagemAlertaRetorno ListaMensagemRetorno ListaMensagemRetornoLote 1 1 3 3 1 1 Tipo Pai Ocorrncia 1-1 1-1 1-1 1-N 0-1 1-1 1-1 Choice Observao

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
# 1 Nome ConsultarNfseRpsEnvio IdentificacaoRps Prestador tcIdentificacaoRps tcIdentificacaoPrestador 1 1 1-1 1-1 Tipo Pai Ocorrncia Observao

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


ConsultarNfseRpsResposta
# 1 Nome ConsultarNfseRpsResposta CompNfse 2 ListaMensagemRetorno CompNfse ListaMensagemRetorno 1 1 1-1 Choice 1-1 Tipo Pai Ocorrncia Observao

40

Pgina 41 de 43 Reviso 1.002.01

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
# 1 Nome ConsultarNfseEnvio Prestador NumeroNfse 2 PeriodoEmissao DataInicial DataFinal 3 PeriodoCompetencia DataInicial DataFinal Tomador Intermediario 4 Pagina date date tcIdentificacaoTomador tcIdentificacaoIntermediario tsPagina date date tcIdentificacaoPrestador tsNumeroNfse 1 1 1 2 2 1 3 3 1 1 1 Tipo Pai Ocorrncia 1-1 1-1 0-1 0-1 1-1 1-1 Choice 0-1 1-1 1-1 0-1 0-1 1-1 Observao

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


ConsultarNfseServicoPrestadoResposta
# 1 2 Nome ConsultarNfseResposta ListaNfse CompNfse Pagina 3 ListaMensagemRetorno CompNfse tsPagina ListaMensagemRetorno 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 1-50 1-1 1-1 Choice Observao

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

41

Pgina 42 de 43 Reviso 1.002.01

ConsultarNfseServicoTomadoEnvio
# 1 Nome ConsultarNfseEnvio Consulente NumeroNfse 2 PeriodoEmissao DataInicial DataFinal 3 PeriodoCompetencia DataInicial DataFinal Prestador Tomador Intermediario 4 Pagina date date tcIdentificacaoPrestador tcIdentificacaoTomador tcIdentificacaoIntermediario tsPagina date date tcIdentificacaoConsulente tsNumeroNfse 1 1 1 2 2 1 3 3 1 1 1 1 Tipo Pai Ocorrncia 1-1 1-1 0-1 0-1 1-1 1-1 0-1 1-1 1-1 0-1 0-1 0-1 1-1 Choice Observao

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


ConsultarNfseServicoTomadoResposta
# 1 2 Nome ConsultarNfseResposta ListaNfse CompNfse Pagina 3 ListaMensagemRetorno CompNfse tsPagina ListaMensagemRetorno 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 1-50 1-1 1-1 Choice Observao

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
# 1 Nome ConsultarNfseFaixaEnvio Prestador 2 Faixa NumeroNfseInicial NumeroNfseFinal 3 Pagina tsNumeroNfse tsNumeroNfse tsPagina tcIdentificacaoPrestador 1 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 0-1 1-1 1-1 1-1 Observao

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

42

Pgina 43 de 43 Reviso 1.002.01

ConsultarNfseFaixaResposta
# 1 2 Nome ConsultarNfseFaixaResposta ListaNfse CompNfse Pagina 3 ListaMensagemRetorno CompNfse tsPagina ListaMensagemRetorno 1 2 2 1 Tipo Pai Ocorrncia 1-1 1-1 1-50 1-1 1-1 Choice Observao

43