Você está na página 1de 37

SECRETARIA MUNICIPAL DE FAZENDA

Manual de Integrao

Contagem / MG Maio/2011

Pgina |2
Verso 1.0

Elaborado em 13 de maio de 2011. Verso 1.0 Coordenadoria de Lanamento e Arrecadao Secretaria Municipal Adjunta da Receita

Pgina |3
Verso 1.0

Conteudo Introduo ........................................................................................................................................ 4 1 Consideraes Iniciais .............................................................................................................. 4 1.1 1.2 2 2.1 2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.2 2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.3 2.3.1 2.3.2 2.3.3 2.3.4 3 3.1 3.1.1 3.1.2 3.2 3.3 3.4 3.5 3.5.1 3.5.2 3.5.3 3.5.4 3.5.5 3.5.6 4 4.1 4.2 Nota Fiscal de Servios Eletrnica - NFS-E ..................................................................... 4 Recibo Provisrio de Servios - RPS ................................................................................ 4 Modelo Conceitual ............................................................................................................. 6 Recepo e Processamento de Lote de RPS................................................................... 6 Consulta de Situao de Lote de RPS .............................................................................. 6 Consulta de NFS-e por RPS ............................................................................................. 7 Consulta de Lote de RPS .................................................................................................. 7 Consulta de NFS-e ............................................................................................................ 8 Cancelamento de NFS-e ................................................................................................... 8 Padres Tcnicos .............................................................................................................. 9 Padro de Comunicao ................................................................................................... 9 Padro de Certificado Digital ........................................................................................... 10 Padro de Assinatura Digital ........................................................................................... 10 Validao de Assinatura Digital pelo Sistema NFS-e ..................................................... 11 Uso de Assinatura com Certificado Digital ...................................................................... 12 Padro das mensagens XML .......................................................................................... 12 rea do Cabealho .......................................................................................................... 12 Validao da estrutura das Mensagens XML ................................................................. 13 Schemas XML (arquivos XSD) ........................................................................................ 13 Verso dos Schemas XML .............................................................................................. 13 Modelo Operacional ......................................................................................................... 15 Servios Sncronos .......................................................................................................... 15 Servios Assncronos ...................................................................................................... 16 Formatos e Padres Utilizados ....................................................................................... 17 Tipos Simples .................................................................................................................. 18 Tipos Complexos ............................................................................................................. 19 Servios ........................................................................................................................... 25 Recepo de Lote de RPS .............................................................................................. 26 Consulta de Situao de Lote de RPS ............................................................................ 26 Consulta de NFS-e por RPS ........................................................................................... 26 Consulta de NFS-e .......................................................................................................... 27 Consulta de Lote de RPS ................................................................................................ 27 Cancelamento NFS-e ...................................................................................................... 27 TABELA DE ERROS ....................................................................................................... 29 TABELA DE ALERTAS .................................................................................................... 37

Arquitetura de Comunicao com o contribuinte ...................................................................... 6

Estrutura de Dados do Web Service ...................................................................................... 15

Anexos .................................................................................................................................... 29

Pgina |4
Verso 1.0

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

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

1.1 NotaFiscaldeServiosEletrnicaNFSE
A Nota Fiscal de Servios Eletrnica (NFS-e) um documento de existncia exclusivamente digital, gerado e armazenado eletronicamente pela prefeitura ou por outra entidade conveniada, para documentar as operaes de prestao de servios. A gerao da NFS-e ser feita, automaticamente, por meio de servios informatizados, disponibilizados aos contribuintes. Para que sua gerao seja efetuada, dados que a compem sero informados, analisados, processados, validados e, se corretos, geraro o documento. A responsabilidade pelo cumprimento da obrigao acessria de emisso da NFS-e e pelo correto fornecimento dos dados secretaria, para a gerao da mesma, do contribuinte.

1.2 ReciboProvisriodeServiosRPS
A NFS-e somente ser gerada atravs dos servios informatizados disponibilizados pelas Secretarias Municipais de Fazenda. Esse tipo de servio seguido de alguns riscos inerentes ininterrupta disponibilidade, podendo, portanto, em alguns momentos tornar-se indisponvel. Visando manter as atividades dos contribuintes ininterruptas, independente de os servios informatizados disponibilizados pelas Secretarias Municipais de Fazenda estarem disponveis, foi criado o Recibo Provisrio de Servios (RPS), que um documento de posse e responsabilidade do contribuinte, que

Pgina |5
Verso 1.0

dever ser gerado manualmente ou por alguma aplicao local, possuindo uma numerao seqencial crescente e devendo ser convertido em NFS-e no prazo estipulado pela legislao tributria municipal.

Pgina |6
Verso 1.0

ArquiteturadeComunicaocomocontribuinte

2.1 ModeloConceitual
Atravs do Web Service, o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda disponibilizar servios que podero ser acessados pelos sistemas dos contribuintes. A seguir, esto resumidos os servios disponveis e suas respectivas funcionalidades bsicas.

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

XML de Envio validado pelo arquivo: servico_enviar_lote_rps_envio.xsd XML de Resposta validado pelo arquivo: servico_enviar_lote_rps_resposta.xsd

Passos para execuo


1. A aplicao acessa o servio de Recepo e Processamento de Lote de RPS enviando o lote (fluxo b). 2. A requisio recebida pelo servidor do Web Service que grava as informaes recebidas e gera o nmero de protocolo de recebimento (fluxo c). 3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo d).

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

Pgina |7
Verso 1.0

XML de Envio validado pelo arquivo: servico_consultar_situacao_lote_rps_envio.xsd XML de Resposta validado pelo arquivo: servico_consultar_situacao_lote_rps_resposta.xsd

Passos para execuo


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

2.1.3 ConsultadeNFSeporRPS
Esse servio efetua a consulta de uma NFS-e a partir do nmero de RPS que a gerou.

XML de Envio validado pelo arquivo: servico_consultar_nfse_rps_envio.xsd XML de Resposta validado pelo arquivo: servico_consultar_nfse_rps_resposta.xsd

Passos para execuo


1. A aplicao acessa o servio de Consulta de NFS-e por RPS e submete os dados para processamento (fluxo 2.b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica a NFS-e correspondente (fluxos 2.c e 2.d). 3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.e).

2.1.4 ConsultadeLotedeRPS
Esse servio permite ao contribuinte obter as NFS-e que foram geradas a partir do Lote de RPS enviado, quando o processamento ocorrer sem problemas; ou obter a lista de erros e/ou inconsistncias encontradas nos RPS. Na validao do lote, devem ser retornados todos os erros verificados. Excepcionalmente, havendo uma excessiva quantidade de erros, poder ser definido um limitador para a quantidade de erros retornados.

Pgina |8
Verso 1.0

XML de Envio validado pelo arquivo: servico_consultar_lote_rps_envio.xsd XML de Resposta validado pelo arquivo: servico_consultar_lote_rps_resposta.xsd

Passos para execuo


1. A aplicao acessa o servio de Consulta de Lote de RPS e submete os dados para processamento (fluxo b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica as NFS-e correspondentes (fluxos c e d). 3. O Web Service retorna uma mensagem (a estrutura com a lista da NFSe geradas ou as mensagens de erro) com o resultado do processamento do servio (fluxo e).

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

XML de Envio validado pelo arquivo: servico_consultar_nfse_envio.xsd XML de Resposta validado pelo arquivo: servico_consultar_nfse_resposta.xsd

Passos para execuo


1. A aplicao acessa o servio de Consulta de NFS-e e submete os dados para processamento (). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos e identifica as NFS-e correspondentes. 3. O Web Service retorna uma mensagem com o resultado do processamento do servio.

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

XML de Envio validado pelo arquivo: servico_cancelar_nfse_envio.xsd XML de Resposta validado pelo arquivo: servico_cancelar_nfse_resposta.xsd

Passos para execuo

Pgina |9
Verso 1.0

1. A aplicao acessa o servio de Cancelamento de NFS-e e submete os dados para processamento (fluxo 2.b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos, identifica a NFS-e correspondente e efetua o seu cancelamento (fluxo 2.c). 3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.d).

2.2 PadresTcnicos 2.2.1 PadrodeComunicao

O meio fsico de comunicao utilizado entre os sistemas de informao dos contribuintes e o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda ser a Internet, com o uso do protocolo SSL, que alm de garantir um duto de comunicao seguro na Internet, permite a identificao do servidor e do cliente atravs de certificados digitais, eliminando a necessidade de identificao do usurio atravs de nome ou cdigo de usurio e senha. O modelo de comunicao segue o padro de Web Services definido pelo WS-IBasic Profile. A troca de mensagens entre o Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretaria Municipal de Fazenda e o sistema do contribuinte ser realizada no padro SOAP, com troca de mensagens XML no padro Style/Enconding: Document/Literal, wrapped. A opo wrapped representa a chamada aos mtodos disponveis com a passagem de mais de um parmetro. Para descrever os servios disponibilizados, ser utilizado um documento WSDL (Web Service Description Language). O WSDL o padro recomendado para descrio de servios SOAP.

P g i n a | 10
Verso 1.0

As chamadas aos servios sero feitas enviando como parmetro um documento XML a ser processado pelo sistema. Esse documento no far parte da descrio do servio (arquivo WSDL), e o formato do XML correspondente ao servio dever ser consultado nesse manual de integrao, seo 4.5.

2.2.2 PadrodeCertificadoDigital
Os certificados digitais utilizados no sistema de Notas Fiscais de Servio Eletrnicas, das Secretarias Municipais de Fazenda, sero emitidos por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil, de pessoa fsica ou jurdica, dos tipos A1, A3 ou certificado de servidor (hbrido). Para a assinatura digital dos documentos envolvidos aceitar-se- que o certificado digital seja de quaisquer dos estabelecimentos da empresa.

Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao entre o sistema do contribuinte e o Web Service das Secretarias Municipais de Fazenda: Assinatura de Mensagens: O certificado digital utilizado para essa funo dever conter o CNPJ do estabelecimento emissor da NFS-e ou o CNPJ do estabelecimento matriz. O certificado digital dever ter o uso da chave previsto para a funo de assinatura digital, respeitando a Poltica do Certificado.

Transmisso (durante a transmisso das mensagens entre os servidores do contribuinte e os servios disponibilizados pelas Secretarias Municipais de Fazenda): O certificado digital utilizado para identificao do aplicativo do contribuinte dever conter o CNPJ do responsvel pela transmisso das mensagens, mas no necessita ser o mesmo CNPJ do estabelecimento emissor da NFS-e, devendo ter a extenso extended Key Usage com permisso de "Autenticao Cliente".

2.2.3 PadrodeAssinaturaDigital
As mensagens enviadas aos servios disponibilizados pelas Secretarias Municipais de Fazenda so documentos eletrnicos elaborados no padro XML e devem ser assinados digitalmente com um certificado digital que contenha o CNPJ do estabelecimento matriz ou o CNPJ do estabelecimento emissor da NFS-e objeto do pedido. Para garantir minimamente a integridade das informaes prestadas e a correta formao dos arquivos XML, o contribuinte dever submeter as mensagens XML para validao pela linguagem de Schema do XML (XSD XML Schema Definition), disponibilizada pelas Secretarias Municipais de Fazenda antes de seu envio. Os elementos abaixo esto presentes dentro do Certificado do contribuinte tornando desnecessria a sua representao individualizada no arquivo XML. Portanto, o arquivo XML no deve conter os elementos:

<X509SubjectName> <X509IssuerSerial> <X509IssuerName> <X509SerialNumber> <X509SKI>


Deve-se evitar o uso das TAGs abaixo, pois as informaes sero obtidas a partir do Certificado do emitente:

<KeyValue> <RSAKeyValue> <Modulus>

P g i n a | 11
Verso 1.0

<Exponent>
O Projeto NFS-e utiliza um subconjunto do padro http://www.w3.org/TR/xmldsig-core/, que tem o seguinte leiaute:
# XS01 XS02 XS03 XS04 XS05 Campo Signature Id SignedInfo CanonicalizationMeth od Algorithm Elemento Raiz A G G A Pai XS01 XS01 XS03 XS04 C Tipo C

de

assinatura

XML

definido

pelo

Ocorrncia 11 11 11 11

Descrio

XS06 XS07

SignatureMethod Algorithm

G A

XS03 XS06 C

11 11

XS08 XS09 XS10 XS11

Reference URI Transforms Unique_Transf_Alg

G A G RC

XS03 XS08 XS08 XS10 C

11 11 11 11

XS12 XS13

Transform Algorithm

G A

XS10 XS12 C

22 11

Grupo da Informao da assinatura Grupo do Mtodo de Canonicalizao Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/ RECxmlc14n20010315 Grupo do Mtodo de Assinatura Atributo Algorithm de SignedInfo: http://www.w3.org/2000/09/x mldsig#rsasha1 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/ RECxmlc14n20010315 http://www.w3.org/2000/09/x mldsig#envelopedsignature Xpath Grupo do Mtodo de DigestMethod Atributo Algorithm de DigestMethod: http://www.w3.org/2000/09/x mldsig#sha1 Digest Value (Hash SHA1 Base64) Grupo do Signature Value Grupo do KeyInfo Grupo X509 Certificado Digital x509 em Base64b

XS14 XS15 XS16

Xpath DigestMethod Algorithm

E G A

XS12 XS08 XS15

0N 11 11

XS17 XS18 XS19 XS20 XS21

DigestValue SignatureValue KeyInfo X509Data X509Certificate

E G G G E

XS08 XS01 XS01 XS19 XS20

1 11 11 11

11

2.2.4 ValidaodeAssinaturaDigitalpeloSistemaNFSe
Para a validao da assinatura digital, seguem as regras que sero adotadas pelas Secretarias Municipais de Fazenda: Extrair a chave pblica do certificado; Verificar o prazo de validade do certificado utilizado;

P g i n a | 12
Verso 1.0

Montar e validar a cadeia de confiana dos certificados validando tambm a LCR (Lista de Certificados Revogados) de cada certificado da cadeia; 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); Garantir que o certificado utilizado de um usurio final e no de uma Autoridade Certificadora; Adotar as regras definidas pelo RFC 3280 para LCRs e cadeia de confiana; Validar a integridade de todas as LCR utilizadas pelo sistema; Prazo de validade de cada LCR utilizada (verificar data inicial e final). A forma de conferncia da LCR fica a critrio de cada Secretaria Municipal de Fazenda, podendo ser feita de 2 (duas) maneiras: On-line ou Download peridico. As assinaturas digitais das mensagens sero verificadas considerando o horrio fornecido pelo Observatrio Nacional.

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

O RPS, pelo contribuinte, antes do envio do mesmo atravs do Lote de RPS; O Lote de RPS, pelo contribuinte, antes do envio do mesmo; A NFS-e: o Pela prefeitura e pelo contribuinte, quando gerada pela Aplicao On Line;
o o Pela prefeitura nos demais casos; O Pedido de cancelamento da NFS-e, pelo contribuinte; A Confirmao de cancelamento da NFS-e, pela prefeitura;

2.3 PadrodasmensagensXML
A especificao adotada para as mensagens XML a recomendao W3C para XML 1.0, disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres ser em UTF-8. As chamadas dos Web Services disponibilizados pelas Secretarias Municipais de Fazenda e os respectivos resultados do processamento so realizadas atravs das mensagens com o seguinte padro: rea de Cabealho estrutura XML padro para todas as mensagens de chamada e retorno de resultado dos Web Services disponibilizados pelas Secretarias Municipais de Fazenda, que contm os dados de controle da mensagem. A rea de cabealho est sendo utilizada para armazenar a verso do leiaute da estrutura XML informado na rea de dados

rea de Dados estrutura XML varivel definida na documentao do Web Service acessado.

2.3.1 readoCabealho
Abaixo, o leiaute da rea de Cabealho padro:
# 1 Nome cabecalho Verso Elemento G A Pai Tipo Ocorrncia 11 11 Tamanho Descrio TAG raiz do cabealho da mensagem. Verso do leiaute.

P g i n a | 13
Verso 1.0
2 versaoDados E 1 N 11 4 O contedo deste campo indica a verso do leiaute XML da estrutura XML informada na rea de dados da mensagem.

O campo versaoDados deve conter a informao da verso do leiaute da estrutura XML armazenada na rea de dados da mensagem. A estrutura XML armazenada na rea de dados est definida na documentao do Web Service acessado.

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

2.3.3 SchemasXML(arquivosXSD)
O Schema XML (arquivo XSD) correspondente a cada uma das mensagens XML de pedido e de retorno utilizadas pelo Web Service pode ser obtido na internet acessando o Portal do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda.

2.3.4 VersodosSchemasXML
Toda mudana de layout das mensagens XML do Web Service implica na atualizao do seu respectivo Schema XML. A identificao da verso dos Schemas XML ser realizada com o acrscimo do nmero da verso com dois dgitos no nome do arquivo XSD precedida da literal _v, como segue: <Nome do Arquivo>_v<Nmero da Verso>.xsd Exemplo: tipos_nfse_v01.xsd A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda utilizam as definies de tipos simples ou tipos complexos que esto definidos em outros Schemas XML, nestes casos, a modificao de verso do Schema bsico ser repercutida no Schema principal. As modificaes de layout das mensagens XML do Web Service podem ser causadas por necessidades tcnicas ou em razo da modificao de alguma legislao. As modificaes decorrentes de alterao da

P g i n a | 14
Verso 1.0

legislao devero ser implementadas nos prazos previstos no ato normativo que introduziu a alterao. As modificaes de ordem tcnica sero divulgadas pelas Secretarias Municipais de Fazenda e podero ocorrer sempre que se fizerem necessrias.

P g i n a | 15
Verso 1.0

3 EstruturadeDadosdoWebService
Existir um nico Web Service com todos os servios apresentados no item 2.1. O fluxo de comunicao sempre iniciado pelo sistema do contribuinte atravs do envio de uma mensagem XML ao Web Service com o pedido do servio desejado.

3.1 ModeloOperacional
A forma de processamento das solicitaes de servios no projeto Nota Fiscal de Servios Eletrnica pode ser sncrona, caso o atendimento da solicitao de servio seja realizada na mesma conexo ou assncrona, quando o processamento do servio solicitado no atendido na mesma conexo, devido uma demanda de processamento de grande quantidade de informao. Nesta situao torna-se necessria a realizao de mais uma conexo para a obteno do resultado do processamento. As solicitaes de servios que exigem processamento intenso sero executadas de forma assncrona e as demais solicitaes de servios de forma sncrona. Assim, os servios da NFS-e sero implementados da seguinte forma: Servio Recepo e Processamento de Lote de RPS Consulta de Situao de Lote de RPS Consulta de NFS-e por RPS Consulta de Lote de RPS Consulta de NFS-e Cancelamento de NFS-e Implementao Assncrona Sncrona Sncrona Sncrona Sncrona Sncrona

3.1.1 ServiosSncronos
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: O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service; O Web Service recebe a mensagem de solicitao de servio e encaminha ao aplicativo da NFS-e que ir processar o servio solicitado;

P g i n a | 16
Verso 1.0

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; O Web Service recebe a mensagem de resultado do processamento e o encaminha ao aplicativo do contribuinte; O aplicativo do contribuinte recebe a mensagem de resultado do processamento e caso no exista outra mensagem, encerra a conexo.

3.1.2 ServiosAssncronos
As solicitaes de servios de implementao assncrona so processadas de forma distribuda por vrios processos e o resultado do processamento somente obtido na segunda conexo. Abaixo, o fluxo simplificado de funcionamento:

Etapas do processo ideal: Solicitao e processamento: O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service de recepo de solicitao de servios; O Web Service de recepo de solicitao de servios recebe a mensagem de solicitao de servio e a coloca na fila de servios solicitados, acrescentando o CNPJ do transmissor obtido do certificado digital do transmissor; 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; O aplicativo do contribuinte recebe o protocolo; 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; O servio solicitado processado pelo aplicativo da NFS-e e o resultado do processamento colocado na fila de servios processados; Obteno do resultado do servio: O aplicativo do contribuinte, atravs do protocolo recebido, envia uma consulta ao servio que retornar o resultado do processamento daquele protocolo, iniciando uma conexo com o Web Service; O Web Service recebe a mensagem de consulta e localiza o resultado de processamento da solicitao de servio; O Web Service devolve o resultado do processamento ao aplicativo contribuinte; O aplicativo do contribuinte recebe a mensagem de resultado do processamento e, caso no exista outra mensagem, encerra a conexo.

P g i n a | 17
Verso 1.0

3.2 FormatosePadresUtilizados
Abaixo segue 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 Formato 0.0000 O formato em percentual presume o valor percentual em sua forma fracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira da fracionria. Exemplo: 62% = 0.62 150% = 1.5 25,32 = 0.2532

Data/Hora (datetime)

Valores Decimais (decimal)

Valores Percentuais (decimal)

No deve ser inserido caractere no significativo para preencher o tamanho completo do campo, ou seja, zeros antes de nmero ou espao em branco aps cadeia de caracteres. A posio do campo definida na estrutura do documento XML atravs de TAGs (<tag>contedo</tag>). A regra constante do pargrafo anterior dever estender-se para os campos onde no h indicao de obrigatoriedade e que, no entanto, seu preenchimento torna-se obrigatrio por estar condicionado legislao especfica ou ao negcio do contribuinte. Neste caso, dever constar a TAG com o valor correspondente e, para os demais campos, devero ser eliminadas as TAGs. Para reduzir o tamanho final do arquivo XML da NFS-e alguns cuidados de programao devero ser assumidos: no incluir "zeros no significativos" para campos numricos; no incluir "espaos" no incio ou no final de campos numricos e alfanumricos; no incluir comentrios no arquivo XML; no incluir anotao e documentao no arquivo XML (TAG annotation e TAG documentation); no incluir caracteres de formatao no arquivo XML ("line-feed", "carriage return", "tab", caractere de "espao" entre as TAGs). As TAGs que permitirem valores nulos devem ser omitidas da estrutura XML a ser enviada.

P g i n a | 18
Verso 1.0

3.3 TiposSimples
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: C: Caractere; N: Nmero; D: Data ou Data/Hora; Descrio: descreve informaes sobre o campo; Tam.: tamanho do campo: Quando for 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 identificao da parte fracionria. A parte fracionria no obrigatria quando assim definido; Quando for data, no haver definio de tamanho. Campo
TsNumeroNfse

Tipo
N

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

Tam.
15

tsCodigoVerificacao TsStatusRps TsStatusNfse tsNaturezaOperacao

C N N N

9 1 1 2

tsRegimeEspecialTributacao

TsSimNao TsQuantidadeRps TsNumeroRps TsSerieRps TsTipoRps tsOutrasInformacoes TsValor

N N N C N C N

1 4 15 5 1 255 15,2

P g i n a | 19
Verso 1.0
tsItemListaServico TsCodigoCnae tsCodigoTributacao TsAliquota C N C N Cdigo de item da lista de servio Cdigo CNAE Cdigo de Tributao Alquota. Valor percentual. Formato: 0.0000 Ex: 1% = 0.01 25,5% = 0.255 100% = 1.0000 ou 1 Discriminao do contedo da NFSe Cdigo de identificao do municpio conforme tabela do IBGE Nmero de inscrio municipal Razo Social do contribuinte Nome fantasia Nmero CNPJ Endereo Nmero do endereo Complemento de endereo Bairro Sigla da unidade federativa Nmero do CEP Email Telefone Nmero de CPF Indicador de uso de CPF ou CNPJ 1 CPF 2 CNPJ 3 No Informado Cdigo de Obra Cdigo ART Nmero do Lote de RPS Nmero do protocolo de recebimento do RPS Cdigo de situao de lote de RPS 1 No tsSituacaoLoteRps tsCodigoMensagemAlerta TsDescricaoMensagemAlerta TsCodigoCancelamentoNfse tsIdTag N C C C C Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso Cdigo de mensagem de retorno de servio. Descrio da mensagem de retorno de servio. Cdigo de cancelamento com base na tabela de Erros e alertas. Atributo de identificao da tag a ser assinada no documento XML 4 200 4 255 1 7 15 115 60 14 125 10 60 60 2 8 80 11 11 1 15 15 15 50 5 7 20 5,4

tsDiscriminacao tsCodigoMunicipioIbge tsIncricaoMunicipal tsRazaoSocial tsNomeFantasia TsCnpj tsEndereco tsNumeroEndereco tsComplementoEndereco tsBairro tsUf tsCep tsEmail tsTelefone TsCpf tsIndicacaoCpfCnpj tsCodigoObra tsArt tsNumeroLote TsNumeroProtocolo N C C C C C C C C C N C C C N C C N C

2000

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

P g i n a | 20
Verso 1.0

Nome do tipo complexo; Descrio do tipo complexo; Identifica se a seqncia de campos far parte de uma escolha (Choice); Nome do campo que faz parte do tipo complexo; Tipo do campo, que pode ser de um tipo simples ou complexo; Quantas vezes o campo se repete na estrutura de dados: Formato: 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. TcCpfCnpj
Nmero de CPF ou CNPJ Nome Cpf Choice Cnpj Tipo tsCpf tsCnpj Ocorrncia 11 11 Descrio Nmero do Cpf Nmero do Cnpj

TcEndereco
Representao completa do endereo Nome Tipo Endereco tsEndereco Numero tsNumeroEndereco tsComplementoEnderec Complemento o Bairro tsBairro CodigoMunicipio tsCodigoMunicipioIbge Uf tsUf Cep tsCep Ocorrncia 01 01 01 01 01 01 01 Descrio Endereo Nmero do endereo Complemento do Endereo Nome do bairro Cdigo da cidade Sigla do estado CEP da localidade

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

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

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

tcIdentificacaoPrestador
Representa dados para identificao do prestador de servio Nome Tipo Ocorrncia Descrio

P g i n a | 21
Verso 1.0
Cnpj InscricaoMunicipal tsCnpj tsInscricaoMunicipal 11 01

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

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

TcIdentificacaoIntermediarioServico
Representa dados para identificao de intermedirio do servio Nome Tipo RazaoSocial CpfCnpj InscricaoMunicipal tsRazaoSocial tcCpfCnpj tsInscricaoMunicipal Ocorrncia 11 11 01 Descrio

TcValores
Representa um conjunto de valores que compe o documento fiscal Nome Tipo Ocorrncia ValorServicos ValorDeducoes ValorPis ValorCofins ValorInss ValorIr ValorCsll IssRetido ValorIss OutrasRetencoes BaseCalculo tsValor tsValor tsValor tsValor tsValor tsValor tsValor tsSimNao tsValor tsValor tsValor 11 01 01 01 01 01 01 11 01 01 01 (Valor dos servios Valor das dedues descontos incondicionados) Descrio

Aliquota ValorLiquidoNfse

tsAliquota tsValor

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

ValorIssRetido DescontoCondicionado DescontoIncondicionado

tsValor tsValor tsValor

01 01 01

TcDadosServico

P g i n a | 22
Verso 1.0
Representa dados que compe o servio prestado Nome Tipo Valores ItemListaServico CodigoCnae CodigoTributacaoMunicipio Discriminacao CodigoMunicipio tcValores tsItemListaServico tsCodigoCnae tsCodigoTributacao tsDiscriminacao tsCodigoMunicipioIbge

Ocorrncia 11 11 01 01 11 11

Descrio

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

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

TcInfRps
Representa dados informativos do Recibo Provisrio de Servio (RPS) Nome Tipo Ocorrncia Id tsIdTag IdentificacaoRps DataEmissao NaturezaOperacao RegimeEspecialTributacao OptanteSimplesNacional IncentivadorCultural Status RpsSubstituido Servico Prestador Tomador IntermediarioServico ConstrucaoCivil TcIdentificacaoRps Datetime TsNaturezaOperacao TsRegimeEspecialTributacao TsSimNao TsSimNao TsStatusRps TcIdentificacaoRps TcDadosServico TcIdentificacaoPrestador TcDadosTomador tcIdentificacaoIntermediarioServic o TcDadosContrucaoCivil 11 11 11 01 11 11 11 01 11 11 11 01 01 Descrio Identificador da TAG a ser assinada

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

Signature

tcIdentificacaoNfse

P g i n a | 23
Verso 1.0
Representa dados que identificam uma Nota Fiscal de Servios Eletrnica Nome Tipo Ocorrncia Numero Cnpj InscricaoMunicipal CodigoMunicipio tsNumeroNfse tsCnpj tsInscricaoMunicipal tsCodigoMunicipioIbge 11 11 01

Descrio

TcInfNfse
Representa os dados informativos da Nota Fiscal de Servios Eletrnica Nome Tipo Ocorrncia Id tsIdTag Numero CodigoVerificacao DataEmissao IdentificacaoRps DataEmissaoRps NaturezaOperacao RegimeEspecialTributacao OptanteSimplesNacional IncetivadorCultural Competencia NfseSubstituida OutrasInformacoes Servico ValorCredito PrestadorServico TomadorServico IntermediarioServico OrgaoGerador ConstrucaoCivil tsNumeroNfse tsCodigoVerificacao Datetime tcIdentificacaoRps Date tsNaturezaOperacao tsRegimeEspecialTributacao TsSimNao TsSimNao Date tsNumeroNfse tsOutrasInformacoes tcDadosServico TsValor tcDadosPrestador tcDadosTomador tcIdentificacaoIntermediarioSe rvico tcIdentificacaoOrgaoGerador tcDadosContrucaoCivil 11 11 11 01 01 11 01 11 11 11 01 01 11 01 11 11 01 11 01 Descrio Identificador da TAG a ser assinada

TcNfse
Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada Nome Tipo Ocorrncia InfNfse Signature tcInfNfse Dsig:Signature 11 12 Descrio

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

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

P g i n a | 24
Verso 1.0
InfPedidoCancelamento tcInfPedidoCancelamento Dsig:Signature 11 01

Signature

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

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

TcCancelamentoNfse
Representa a estrutura completa (pedido + confirmao) de cancelamento de NFSe. Nome Tipo Ocorrncia Descrio Confirmacao TcConfirmacaoCancelamento Dsig:Signature 11 11

Signature

TcInfSubstituicaoNfse
Representa os dados de registro de substituio de NFSe. Nome Id NfseSubstituidora Tipo tsIdTag tsNumeroNfse Ocorrncia Descrio Identificador da TAG a ser assinada

11

TcSubstituicaoNfse
Representa a estrutura de substituio de NFSe. Nome SubstituicaoNfse Tipo tcInfSubstituicaoNfse dsig:Signature Ocorrncia 11 12 Descrio

Signature

TcCompNfse
Representa a estrutura de compartilhamento de dados de uma NFSe. Nome Nfse NfseCancelamento NfseSubstituicao Tipo tcNfse tcCancelamentoNfse tcSubstituicaoNfse Ocorrncia 11 01 01 Descrio

tcMensagemRetorno
Representa a estrutura de mensagem de retorno de servio. Nome Tipo Ocorrncia Codigo Mensagem Correcao TsCodigoMensagemAlerta tsDescricaoMensagemAlert a tsDescricaoMensagemAlert a 11 11 01 Descrio

P g i n a | 25
Verso 1.0

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

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

tcLoteRps
Nome Id NumeroLote Cnpj InscricaoMunicipal QuantidadeRps ListaRps Rps TcRps Tipo tsIdTag TsNumeroLote TsCnpj TsInscricaoMunicipal TsQuantidadeRps Ocorrncia Observao Identificador da TAG a ser assinada

11 11 11 11 11 1N

3.5 Servios
A seguir esto os servios disponveis, conforme descritos no item 2.1, no WebService e seus XML Schema. O XML Schema define a estrutura e formatao do arquivo XML que conter os dados a serem trafegados. Esses documentos sero enviados de forma textual (como uma string) como parmetros do servio oferecido pelo Web Service, como descrito em 2.2.1. As tabelas que detalham cada XML Schema esto divididas da seguinte forma:
# (2) Nome (3) Tipo (4) Pai (5) Ocorrncia (6) (8) Observao (7) (9)

Nmero identificador do campo, quando este contiver subitens; Nome do campo; Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo; Indica quem o campo pai, para definio da hierarquia; Quantas vezes o campo se repete na estrutura de dados:

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); Identifica os campos ou grupos que faro parte de uma escolha (Choice).

P g i n a | 26
Verso 1.0

3.5.1 RecepodeLotedeRPS
Esse servio ser executado, inicialmente, atravs da chamada ao mtodo RecepcionarLoteRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue
# 1 Nome EnviarLoteRpsEnvio LoteRps TcLoteRps dsig:Signature 1 1 Tipo Pai Ocorrnc ia 11 11 01 Observao

Signature

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


# 1 Nome EnviarLoteRpsResposta NumeroLote DataRecebimento Protocolo 2 ListaMensagemRetorno tsNumeroLote Datetime tsNumeroProtocolo ListaMensagemRetorno 1 1 1 1 11 11 Choice Tipo Pai Ocorrnc ia 11 Observao

O lote ser processado posteriormente, sendo o seu resultado disponibilizado para consulta.

3.5.2 ConsultadeSituaodeLotedeRPS
Esse servio ser executado atravs da chamada ao mtodo ConsultarSituacaoLoteRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 Nome ConsultarSituacaoLoteRpsEn vio Prestador Protocolo TcIdentificacaoPrestador TsNumeroProtocolo 1 1 Tipo Pai Ocorrnc ia 11 11 11 Observao

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


# 1 Nome ConsultarSituacaoLoteRpsRe sposta Tipo Pai Ocorrncia 11 Observao

3.5.3 ConsultadeNFSeporRPS
Esse servio ser executado atravs da chamada ao mtodo ConsultarNfsePorRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 Nome ConsultarNfseRpsEnvio IdentificacaoRps Prestador tcIdentificacaoRps tcIdentificacaoPrestador 1 1 11 11 Tipo Pai Ocorr ncia Observao

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

P g i n a | 27
Verso 1.0
# 1 2 Nome ConsultarNfseRpsResposta CompNfse ListaMensagemRetorno tcCompNfse ListaMensagemRetorno 1 1 11 11 Choice Tipo P ai Ocorrncia Observao

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

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


# 1 2 3 Nome ConsultarNfseResposta ListaNfse CompNfse ListaMensagemRetorno Tipo Pai Ocorrnci a 1-1 1-1 0-N 1-1 Observao

tcCompNfse ListaMensagemRetorno

1 2 1

Choice

3.5.5 ConsultadeLotedeRPS
Esse servio ser executado atravs da chamada ao mtodo ConsultarLoteRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 Nome ConsultarLoteRpsEnvio Prestador Protocolo Tipo TcIdentificacaoPrestador TsNumeroProtocolo Pai 1 1 Ocorrncia 1-1 1-1 1-1 Observao

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


# 1 2 3 Nome ConsultarLoteRpsResposta ListaNfse CompNfse ListaMensagemRetorno Tipo Pai 1 2 1 Ocorrncia 1-1 1-1 1-N 1-1 Observao

tcCompNfse ListaMensagemRetorno

Choice

3.5.6 CancelamentoNFSe
Esse servio ser executado atravs da chamada ao mtodo CancelarNfse, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 Nome CancelarNfseEnvio Pedido Tipo TcPedidoCancelamento Pai 1 Ocorrncia 1-1 1-1 Observao

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


# 1 Nome CancelarNfseResposta Cancelamento Tipo TcCancelamentoNfse Pai 1 Ocorrncia 1-1 Observao Choice

P g i n a | 28
Verso 1.0
2 ListaMensagemRetorno ListaMensagemRetorno 1 1-1

P g i n a | 29
Verso 1.0

4 Anexos
4.1 TABELADEERROS
CD. E1 MENSAGEM Assinatura do Hash no confere SOLUO Reenvie asssinatura do Hash conforme algoritmo estabelecido no Manual de Instruo da NFSe Informe um ms de competncia inferior ou igual ao de emisso do RPS ou da Nota. Utilize um dos tipos: 01 Tributao no municipio; 02 Tributao fora do municipio; 03 Iseno; 04 Imune; 05 Exigibilidade suspensa por deciso judicial; 06 Exigibilidade suspensa por procedimento administrativo. Envie o RPS para emisso da NFSe. Informe um nmero de NFSE substituda que j tenha sido emitida. O cancelamento de uma NFSe com crdito deve ser feito atravs de processo administrativo aberto em uma repartio fazendria. Confira e informe novamente os dados da NFSe que deseja substituir. Utilize um dos tipos: 1 Sim; 2 No. Utilize um dos tipos: 1 Sim; 2 No. Para essa Inscrio Municipal/CNPJ j existe um RPS informado com o mesmo nmero, srie e tipo. Informe o nmero do RPS Informe o tipo do RPS Utilize um dos tipos especificados: "RPS", "RPSC" ou "RPSM". Informe a Data da emisso do RPS no formato Date Informe a Data da emisso do RPS no formato Date Informe uma data de emisso de RPS vlida Informe uma data de emisso de RPS vlida

E2 E3

Ms de competncia superior ao de emisso do RPS ou da Nota Natureza da operao no informada.

E4 E5 E6

Esse RPS no foi enviado para a nossa base de dados O nmero da NFSE substituda informado no existe na base de dados do municpio. Essa NFSe no pode ser cancelada atravs desse servio, pois h crdito informado

E7 E8 E9 E10

Essa NFSe j foi substituda Campo de optante pelo simples nacional no informado Campo de incentivador cultural no informado RPS j informado.

E11 E12 E13 E14 E15 E16 E17

Nmero do RPS no informado Tipo do RPS no informado Campo tipo do RPS invlido. Data da emisso do RPS no informada Data da emisso do RPS invlida A data da emisso do RPS no poder ser superior a data de hoje A data da emisso do RPS no poder ser inferior data de habilitao do prestador para emisso da NFSe. O valor dos servios dever ser superior a R$ 0,00 (zero) O valor das dedues dever ser inferior ou igual ao valor dos servios O valor das dedues dever ser superior ou igual a R$ 0,00 (zero) O valor dos descontos dever ser inferior ou igual ao valor dos servios O valor dos descontos dever ser superior ou igual a R$ 0,00 (zero) O valor do PIS dever ser superior ou igual a R$ 0,00 (zero)

E18 E19 E20 E21 E22 E23

No permitido envio de valor de servios igual a zero. No permitido valor de deduo superior ao valor de servios. No permitido valor de deduo inferior a zero (negativo). No permitido valor de desconto superior ao valor de servios. No permitido valor de desconto inferior a zero (negativo). No permitido valor de reteno inferior a zero (negativo).

P g i n a | 30
Verso 1.0
E24 E25 E26 O valor da Cofins dever ser superior ou igual a R$ 0,00 (zero) O valor do INSS dever ser superior ou igual a R$ 0,00 (zero) O valor do IR dever ser superior ou igual a R$ 0,00 (zero) E27 E28 O valor da CSLL dever ser superior ou igual a R$ 0,00 (zero) Item da lista de servio informado incompatvel com a informao de optante pelo simples nacional E29 E30 O cdigo de servio prestado no permite reteno de ISS. Item da lista de servio inexistente No permitido valor de reteno inferior a zero (negativo). No permitido valor de reteno inferior a zero (negativo). No permitido valor de reteno inferior a zero (negativo). No permitido valor de reteno inferior a zero (negativo). Consulte a legislao vigente para saber se o item informado permite a opo pelo simples nacional Altere o campo "ISS Retido" para: 2 (Nota Fiscal sem ISS Retido). Consulte a legislao vigente para saber o item da lista de servio que dever ser informado neste campo. E31 E32 Item da lista de servio no informado para a operao Cdigo CNAE informado incompatvel com a informao de optante pelo simples nacional E33 Cdigo CNAE inexistente Informe o item relativo ao servio prestado nessa operao. Consulte a legislao vigente para saber se o cdigo informado permite a opo pelo simples nacional. Consulte a legislao vigente para saber o cdigo CNAE que dever ser informado neste campo. E34 Cdigo de tributao informado incompatvel com a informao de optante pelo simples nacional E35 Cdigo de tributao inexistente Consulte a legislao vigente para saber se o cdigo informado permite a opo pelo simples nacional. Consulte a legislao vigente para saber o Cdigo de tributao que dever ser informado neste campo. E36 E37 Campo ISSRetido invlido. Apenas servios tributados, no municpio ou fora, podem sofrer reteno de ISS Utilize um dos tipos: 1 para ISS Retido ou 2 para ISS no Retido. Operaes isentas, imunes ou com exigibilidade suspensa por deciso judicial ou procedimento administrativo no podem sofrer reteno de ISS. E38 Contribuintes enquadrados como Microempresa Municipal, Estimativa, Sociedade de Profissionais ou Incentivador Cultural no podem sofrer reteno de ISS. E39 Apenas empresas tomadoras de servios inscritas neste municipio podem efetuar reteno de ISS. No faa a reteno do ISS nos casos de empresas enquadradas como Microempresa Municipal, Estimativa, Sociedade de Profissionais ou Incentivador Cultural. O CNPJ e/ou a Inscrio Municipal informada do tomador no foi encontrada na base de dados do municpio, no sendo permitida a reteno. Acerte o CNPJ e/ou Inscrio Municipal ou altere o campo ISS Retido para 2 (Sem reteno de ISS). E40 Valor do ISS retido no informado. O valor do ISS retido deve ser informado

P g i n a | 31
Verso 1.0
quando o campo "IssRetido" for marcado com 1Sim. E41 O campo discriminao dos servios no foi preenchido. E42 E43 E44 E45 Cdigo do municpio da prestao do servio invlido Inscrio Municipal do prestador no encontrada na base de dados do municpio. CNPJ do prestador invlido CNPJ no encontrado na base de dados O preenchimento da discriminao dos servios obrigatrio por lei, devendo ser preenchido adequadamente. Consulte a tabela do IBGE e utilize um dos tipos listados na tabela Informe a inscrio municipal correta do prestador. Informe o nmero do CNPJ correto do prestador. Confira o numero do CNPJ informado. Caso esteja correto, o prestador no est inscrito no municpio. E46 E47 E48 CNPJ do prestador no informado CPF/CNPJ do tomador invlido O campo CPF/CNPJ do tomador dever ser preenchido com zeros quando for de CPF noinformado. E49 Lote de RPS com excesso de inconsistncias. Informe o CNPJ do prestador. Informe o CPF/CNPJ correto do tomador. Preencher o campo CPF/CNPJ do Tomador com zeros quando se tratar de tomador com CPF no informado. O servio de validao de RPS abortado quando atinge o nmero de 50 inconsistncias. Corrija os erros e reenvie o lote de RPS. E50 E51 E52 E53 Inscricao Municipal do pretador invlida Inscricao Municipal do tomador invlida O tomador de servios informado o prprio prestador. O campo Inscrio Municipal do tomador s dever ser preenchido para tomadores estabelecidos neste municpio E54 CNPJ do tomador (<CNPJ enviado>) est vinculado a mais de uma inscrio municipal. E55 E56 Endereo do tomador (logradouro) no corresponde ao CEP informado Campo endereo do tomador no informado (obrigatrio para tomador com CNPJ) E57 E58 E59 Bairro no corresponde ao CEP informado Cdigo do municipio do tomador no corresponde ao CEP informado Campo cidade do tomador no informado (obrigatrio para tomador com CNPJ) Corrija o endereo (logradouro) ou o CEP do tomador do servio O preenchimento do endereo (logradouro) obrigatrio para tomadores Pessoas Jurdicas (com CNPJ). Corrija o Bairro ou o CEP do tomador do servio Corrija o codigo do municipio ou o CEP do tomador do servio O preenchimento da Cidade do Tomador obrigatrio para tomadores Pessoas Jurdicas Informe a Inscrio Municipal do tomador vinculada ao CNPJ informado. Informe a inscricao municipal correta do prestador. Informe a inscricao municipal correta do tomador. Na emisso da NFSe no permitido que o prestador seja igual ao tomador. Para tomadores estabelecidos fora deste municpio no preencher inscrio municipal.

P g i n a | 32
Verso 1.0
(com CNPJ). E60 A cidade do tomador informada no foi encontrada na base de dados da prefeitura. E61 E62 E63 Sigla da UF do tomador no corresponde ao CEP informado Cep no existe na tabela DNE dos Correios. Razao social do intermedirio do servio no informada com CNPJ/CPF ou Inscrio Municipal do intermedirio informada. E64 E65 Inscrio Municipal do intermedirio do servio invlida Inscrio Municipal do intermedirio do servio no esta vinculada ao CNPJ/CPF informado. E66 E67 E68 E69 E70 CNPJ/CPF do Intermediario do Servio invalido Cdigo da obra invlido Status do RPS invlido Quantidade de RPS incorreta Inscrio Municipal do prestador especificada no lote no confere com o prestador informado no RPS. E71 E72 E73 E74 RPS em duplicidade no arquivo enviado. Campo Quantidade de RPS informado incorretamente. Campo tipo do RPS invlido para o tipo de registro='3' (Cupons). Data de emisso da Nota Fiscal no est compreendida entre <data inicio de emisso do lote> e <data fim de emisso do lote> conforme especificado no cabealho do arquivo. E75 E76 E77 E78 Nmero do RPS substitudo no informado para status do RPS igual a "S" O nmero do RPS substitudo informado no existe na base de dados Nmero da NFSe no informado Nmero da NFSe inexistente na base de dados para o prestador de servio pesquisado E79 E80 Essa NFSe j est cancelada Cdigo de verificao no informado Confira e informe novamente os dados da NFSe que deseja cancelar. Informe o cdigo de verificao da NFSe. Informe o nmero da NFSe. Informe o nmero correto da NFSe. Informe o nmero do RPS substitudo correto Informe o nmero do RPS substitudo. Utilize no cabealho do arquivo datas de emisso da Nota Fiscal compreendidas entre a data incio de emisso do lote e a data fim de emisso do lote. Remova do arquivo o registro de RPS excedente. O campo quantidade de RPS numrico e dever ter tamanho mximo de 4 dgitos. Utilize o tipo RPSC" Informe o CNPJ/CPF correto do intermediario do servio. Informe o cdigo da obra correto Utilize um dos tipos:1 Normal; 2 Cancelado; Informe a quantidade de RPS correta Informe corretamente a Inscrio Municipal do prestador no lote e no RPS. Informe a Inscrio Municipal correta do intermedirio do servio. Acerte a Inscrio Municipal ou o CNPJ/CPF do intermedirio do servio. Informe a cidade correta do tomador. No caso de cidade do exterior (fora do pas), informe o campo com 99999. Corrija a sigla da UF ou o CEP do tomador do servio Informar o Cep correto Informe a razao social do intermedirio do servio

P g i n a | 33
Verso 1.0
E81 E82 E83 Cdigo de verificao no corresponde NFSe consultada Pesquisa pela atividade s pode ser feita com a indicao de um cep ou bairro Campo Inscrio Municipal do tomador informado incorretamente E84 E85 E86 E87 E88 E89 E90 E91 E92 E93 E94 E95 E96 E97 E98 E99 E100 Pesquisa pelo cep s pode ser feita com a indicao de uma atividade Pesquisa pelo bairro s pode ser feita com a indicao de uma atividade Nmero do protocolo de recebimento do lote inexistente na base de dados Nmero de lote inexistente na base de dados Nmero de lote no informado No existe na base de dados uma NFSe emitida para o nmero de RPS informado Nmero do RPS invlido Esse RPS no foi enviado para a nossa base de dados Esse RPS foi enviado para a nossa base de dados, mas ainda no foi processado Srie informada invlida Ms de competncia no informado. Ms de competncia informado incorretamente. Campo nmero do RPS informado incorretamente Campo srie do RPS informado incorretamente Valor dos servios no informado. Valor da reteno dever ser inferior ou igual ao valor dos servios Campo valor dos servios informado incorretamente E101 Campo dedues informado incorretamente Informe a srie correta para o RPS pesquisado. Informe o ms de competncia no formato AAAAMM. Informe o ms de competncia no formato AAAAMM. O campo Nmero do RPS nmerico e dever ter tamanho mximo de 15 dgitos. O campo Srie do RPS alfanmerico e dever ter tamanho mximo de 5 caracteres. Informe o valor dos servios. No permitido valor de reteno superior ao valor de servios. O campo valor dos servios nmerico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. O campo valor das dedues nmerico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. E102 Campo descontos informado incorretamente O campo valor dos descontos nmerico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. Informe um nmero de RPS que corresponda seqncia utilizada pelo prestdor de servio. Exija do prestador do servio a emisso da NFSe. Faa uma nova consulta mais tarde. Confira se o lote foi enviado e informe o nmero correto do protocolo de recebimento. Confira se o lote foi enviado e informe o nmero correto. Informe o nmero do lote. Informe o nmero correto do RPS. Informe uma atividade. O campo Inscrio Municipal do tomador numrico e dever ter tamanho mximo de 15 dgitos. Informe uma atividade. Informe um cep ou um bairro. Informe o cdigo de verificao correto.

P g i n a | 34
Verso 1.0
E103 Retenao de tributo federal informada incorretamente O campo referente a reteno de tributo federal nmerico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. E104 E105 E106 E107 E108 E109 Campo item da lista de servio informado incorretamente Campo cdigo CNAE informado incorretamente Campo cdigo de tributao do municpio informado incorretamente Campo discriminao do servio informado incorretamente. Campo municpio da prestao do servio informado incorretamente. Campo cidade do tomador informado incorretamente. E110 Quando a natureza da operao for tributao fora do municpio, o campo municpio da prestao do servio dever ser diferente do municpio do prestador E111 E112 Municpio da prestao do servio no informado. Campo Inscrio Municipal do intermediario informado incorretamente E113 Campo nmero do endereo do tomador no informado (obrigatrio para tomador com CNPJ) E114 Campo bairro do tomador no informado (obrigatrio para tomador com CNPJ) E115 Campo UF do tomador no informado (obrigatrio para tomador com CNPJ) E116 A UF do tomador informada no foi encontrada na base de dados. Informe o municpio da prestao do servio, de acordo com a tabela do IBGE. O campo Inscrio Municipal do intermediario numrico e dever ter tamanho mximo de 15 dgitos. A informao do nmero do endereo do tomador obrigatria para tomadores pessoas jurdicas (com CNPJ). A informao do bairro do tomador obrigatria para tomadores Pessoas Jurdicas (com CNPJ). O preenchimento da UF do tomador obrigatrio para tomadores pessoas jurdicas (com CNPJ). Informe a UF correta do tomador. Em caso de cidades do exterior (fora do pas), preencher a UF com "EX" e a cidade do tomador com 99999. E117 E118 Campo razo social do tomador informado incorretamente. Campo razo social do tomador no informado O campo razo social do tomador dever ter tamanho mximo de 115 caracteres. O campo razo social do tomador dever ser informado quando o campo Indicador de CPF/CNPJ do tomador for preenchido com 1 CPF ou 2 CNPJ. E119 Campo endereo do tomador informado incorretamente. O campo endereo do tomador dever ter tamanho mximo de 125 caracteres. O campo item da lista de servio dever ter tamanho mximo de 4 caracteres. O campo cdigo CNAE dever ter tamanho mximo de 7 caracteres. O campo cdigo de tributao do municpio dever ter tamanho mximo de 20 caracteres. O campo discriminao do servio dever ter tamanho mximo de 2000 caracteres. O campo municpio da prestao do servio dever ter tamanho mximo de 7 dgitos. O campo cidade do tomador dever ter tamanho mximo de 7 dgitos, consulte tabela do IBGE.. Informar o municpio da prestao do servio corretamente.

P g i n a | 35
Verso 1.0
E120 E121 Campo nmero do endereo do tomador informado incorretamente. Campo complemento do endereo do tomador informado incorretamente. E122 E123 E124 E125 E126 E127 E128 Campo bairro do tomador informado incorretamente. Campo AliquotaServicos no informado para tributao fora do municpio. Campo UF do tomador informado incorretamente. Campo CEP do tomador informado incorretamente. Campo email do tomador informado incorretamente. Campo telefone do tomador informado incorretamente. Campo razo social do intermedirio do servio informado incorretamente. E129 E130 E131 Campo cdigo da obra informado incorretamente. Campo ART informado incorretamente. Campo data inicial preenchido incorretamente O campo nmero do endereo do tomador dever ter tamanho mximo de 10 caracteres. O campo complemento do endereo do tomador dever ter tamanho mximo de 60 caracteres. O campo bairro do tomador dever ter tamanho mximo de 60 caracteres. Informe a aliquota do ISS quando a tributao for fora do municpio O campo UF do tomador dever ter tamanho mximo de 2 caracteres. O campo CEP do tomador dever ter tamanho mximo de 8 dgitos. O campo email do tomador dever ter tamanho mximo de 80 caracteres. O campo telefone do tomador dever ter tamanho mximo de 11 caracteres. O campo razo social do intermedirio do servio dever ter tamanho mximo de 115 caracteres. O campo cdigo da obra dever ter tamanho mximo de 15 caracteres. O campo ART dever ter tamanho mximo de 15 caracteres. A data informada dever estar no formato DD/MM/AAAA, ou seja, dia (2 dgitos), seguido de ms (2 dgitos) e ano (4 dgitos) e deve ser uma data vlida. E132 Campo data final preenchido incorretamente A data informada dever estar no formato DD/MM/AAAA, ou seja, dia (2 dgitos), seguido de ms (2 dgitos) e ano (4 dgitos) e deve ser uma data vlida. E133 E134 E135 E136 Data final da pesquisa no poder ser supeiror a data de hoje. A data final no poder ser anterior data inicial O perodo de pesquisa no poder ser superior a um ano. Campo nmero da NFSe informado incorretamente E137 E138 E139 Data de emisso da NFSe informada incorretamente CNPJ no autorizado a realizar o servio Campo nmero da NFSe substituda Informe uma data final igual ou anterior a data de hoje Informe uma data final igual ou superior a data inicial da pesquisa Limitar as datas de incio e final a um perodo de um ano O campo nmero da NFSe nmerico e dever ter tamanho mximo de 15 dgitos. Informe a data correta da emisso da NFSe a ser consultada. Informe o CNPJ autorizado a executar o servio. O campo nmero da NFSe substituda

P g i n a | 36
Verso 1.0
informado incorretamente E140 E141 E142 E143 E144 Bairro do prestador inexistente Inscrio Municipal do prestador no informada Inscrio Municipal do prestador no est vinculada ao CNPJ informado. Inscrio Municipal do tomador no est vinculada ao CNPJ informado. Natureza da operao invlida. Acerte a Inscrio Municipal ou o CNPJ do prestador. Acerte a Inscrio Municipal ou o CNPJ do tomador. Utilize um dos tipos: 01 Tributao no municipio; 02 Tributao fora do municipio; 03 Iseno; 04 Imune; 05 Exigibilidade suspensa por deciso judicial; 06 Exigibilidade suspensa por procedimento administrativo. E145 Regime Especial de Tributao invlido. Utilize um dos tipos: 01 Microempresa Municipal; 02 Estimativa; 03 Sociedade de Profissionais; 4 Cooperativa; 5 Microempresrio Individual (MEI) 6 Microempresrio e Empresa de Pequeno Porte (ME EPP). E146 E147 E148 E149 E150 Informao de optante pelo simples nacional invlida. informao de incentivador cultural invlida. Status do RPS no informado Campo CNPJPrestador informado incorretamente Srie do RPS no informada Informe o status do RPS. O campo CNPJPrestador nmerico e dever ter tamanho mximo de 14 dgitos. Campo de preenchimento obrigatrio, caso no utilize srie, preencha o campo com 00000. E151 E152 E153 Quantidade de RPS no informada Campo ISSRetido no informado. Campo ValorISSRetido informado incorretamente E154 Campo CNPJ/CPF do Intermediario do Servio informado incorretamente E155 E156 E157 Campo CPFCNPJTomador informado incorretamente CNPJ do prestador no autorizado a emitir NFSe Usurio no est autorizado a utilizar esse servio para esse contribuinte. Informe a quantidade de RPS. Informe um dos tipos: 1 para ISS Retido ou 2 para ISS no Retido. O campo ValorISSRetido nmerico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. O campo CNPJ/CPF do Intermediario do Servio nmerico e dever ter tamanho mximo de 14 dgitos. O campo CPFCNPJTomador nmerico e dever ter tamanho mximo de 14 dgitos. Solicite autorizao para emitir NFSe para o CNPJ informado. Solicite ao contribuinte autorizao para utilizar o servio em seu nome. Utilize um dos tipos: 1 Sim; 2 No. Utilize um dos tipos: 1 Sim; 2 No. informe a Inscrio Municipal do prestador. nmerico e dever ter tamanho mximo de 15 dgitos.

P g i n a | 37
Verso 1.0
E158 Campo Inscrio Municipal do prestador informado incorretamente E159 E160 E161 CNPJ do prestador especificado no lote no confere com o prestador informado no RPS. Arquivo enviado fora da estrutura do arquivo XML de entrada. Campo ValorISS no informado para tributao fora do municpio. O campo Inscrio Municipal do prestador numrico e dever ter tamanho mximo de 15 dgitos. Informe corretamente o CNPJ do prestador no lote e no RPS. Envie um arquivo dentro do schema do arquivo XML de entrada. Informe o valor do ISS quando a tributao for fora do municpio

4.2 TABELADEALERTAS
CD. A1 MENSAGEM Item da lista de servio, cdigo CNAE ou cdigo de tributao informado para a operao no est cadastrado para o prestador de servio INTERPRETAO Verifique se o item ou cdigo informado est correto. Se estiver, proceda a atualizao cadastral junto Prefeitura assim que possvel, pois o item ou cdigo informado no est cadastrado para a sua inscrio municipalItem da Lista de Servio, Cdigo CNAE ou Cdigo de Tributao. Consulte a legislao vigente para saber se o item ou cdigo informado permite deduo da base de clculo Consulte a legislao vigente para saber se o item informado permite a tributao fora do municpio (Foi informada a Natureza da Operao "2") Verifique se os valores esto corretos O sistema ir considerar o tomador conforme todos os dados informados no arquivo (endereo de fora do municpio). O sistema ir interpretar como se o tomador no tivesse inscrio no CCM. A inscrio municipal do tomador fornecida consta como cancelada na base de dados do municipio. O email do tomador de servios no vlido. Este campo ser ignorado e no haver envio de email.

A2

A3

Item da lista de servio, cdigo CNAE ou cdigo de tributao informado para a operao no permite deduo na base de clculo Item da lista de servio informado para a operao no permite tributao fora do municpio Valor do ISS retido diferente do ISS devido O CNPJ informado possui inscrio no municpio, porm foi informado endereo de fora do municpio. A inscrio municipal do tomador no foi encontrada na base de dados de CCM. Inscrio Municipal do tomador de servios consta como cancelada. Email do tomador de servios invlido. Email no ser enviado.

A4 A5

A6 A7

A8