Вы находитесь на странице: 1из 62

Manual de Utilizao do Web Service

Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

NOTA FISCAL DE SERVIOS ELETRNICA NFSE


Manual de Utilizao do Web Service

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 1 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Sumrio
1. INTRODUO ............................................................................................................ 4 1.1. 1.2. 2. NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E....................................... 4 RECIBO PROVISRIO DE SERVIO RPS ..................................................... 4

ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE ............................... 6 2.1. MODELO CONCEITUAL...................................................................................... 6

2.1.1. Recepo e Processamento de Lote de RPS................................................... 6 2.1.2. Consulta de Situao de Lote de RPS.............................................................. 7 2.1.3. Consulta de NFS-e por RPS ............................................................................. 7 2.1.4. Consulta de Lote de RPS ................................................................................. 8 2.1.5. Consulta de NFS-e ........................................................................................... 9 2.1.6. Cancelamento de NFS-e .................................................................................. 9 2.2. PADRES TCNICOS ...................................................................................... 10

2.2.1. Padro de Comunicao ................................................................................ 10 2.2.2. Padro de Certificado Digital .......................................................................... 11 2.2.3. Padro de Assinatura Digital .......................................................................... 12 2.2.4. Validao de Assinatura Digital pelo Sistema NFS-e ..................................... 14 2.2.5. Uso de Assinatura com Certificado Digital ...................................................... 15 2.3. PADRO DAS MENSAGENS XML ................................................................... 15

2.3.1. rea do Cabealho ......................................................................................... 15 2.3.2. Validao da estrutura das Mensagens XML ................................................. 16 2.3.3. Schemas XML (arquivos XSD) ....................................................................... 17 2.3.4. Verso dos Schemas XML ............................................................................. 17 2.4. 3. AMBIENTE DE HOMOLOGAO ..................................................................... 17

ESTRUTURA DE DADOS DO WEB SERVICE ........................................................ 19 3.1. MODELO OPERACIONAL ................................................................................. 19

3.1.1. Servios Sncronos ......................................................................................... 19 3.1.2. Servios Assncronos ..................................................................................... 20 3.2. 3.3. 3.4. FORMATOS E PADRES UTILIZADOS ........................................................... 21 TIPOS SIMPLES ................................................................................................ 23 TIPOS COMPLEXOS ......................................................................................... 25
Pgina 2 de 62

Nota Fiscal de Servios Eletrnica - NFSE

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

3.5.

SERVIOS ......................................................................................................... 34

3.5.1. Verso do Sistema.......................................................................................... 35 3.5.2. Recepo de Lote RPS .................................................................................. 35 3.5.3. Consulta de Situao de Lote de RPS............................................................ 37 3.5.4. Consulta de NFS-e por RPS ........................................................................... 38 3.5.5. Consulta de NFS-e ......................................................................................... 40 3.5.6. Consulta de Lote de RPS ............................................................................... 42 3.5.7. Cancelamento NFS-e ..................................................................................... 44 3.5.8. Gerar NFS-e ................................................................................................... 45 Mtodo: GeraNfse ............................................................................................................ 45 4. ANEXOS ................................................................................................................... 48 4.1. 4.2. 4.3. 5. TABELA DE ERROS .......................................................................................... 48 TABELA DE ALERTAS ...................................................................................... 54 TABELA DE MENSAGENS PERSONALIZADAS .............................................. 55

VERSES DO MANUAL .......................................................................................... 60 5.1. ATUALIZAES ................................................................................................ 60

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 3 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

1. 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. O Web Service e todos os seus servios, referenciados nesse documento, so baseados no modelo nacional de NFS-e, definido pela Associao Brasileira de Secretrios e Dirigentes das Finanas dos Municpios das Capitais (ABRASF) e pela Receita Federal do Brasil (RFB). 1.1. NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E

A Nota Fiscal de Servios Eletrnica (NFS-e) um documento de existncia exclusivamente digital, gerado e armazenado eletronicamente pela prefeitura ou por outra entidade conveniada, para documentar as operaes de prestao de servios. A gerao da NFS-e ser feita, automaticamente, por meio de servios informatizados, disponibilizados aos contribuintes. Para que sua gerao seja efetuada, dados que a compem sero informados, analisados, processados, validados e, se corretos, geraro o documento. A responsabilidade pelo cumprimento da obrigao acessria de emisso da NFSe e pelo correto fornecimento dos dados secretaria, para a gerao da mesma, do contribuinte. 1.2. RECIBO PROVISRIO DE SERVIO RPS A NFS-e somente ser gerada atravs dos servios informatizados disponibilizados pelas Secretarias Municipais de Fazenda. Esse tipo de servio seguido de alguns riscos inerentes ininterrupta disponibilidade, podendo, portanto, em alguns momentos tornarse indisponvel.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 4 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 5 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

2. ARQUITETURA DE COMUNICAO COM O CONTRIBUINTE 2.1. MODELO CONCEITUAL Atravs do Web Service, o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda disponibilizar servios que podero ser acessados pelos sistemas dos contribuintes. A seguir, esto resumidos os servios disponveis e suas respectivas funcionalidades bsicas. 2.1.1. Recepo e Processamento de Lote de RPS Esse servio compreende a recepo do Lote de RPS, a resposta com o nmero do protocolo gerado para esta transao e o processamento do lote. Quando efetuada a recepo, o Lote entrar na fila para processamento posterior onde sero feitas as validaes necessrias e gerao das NFS-e.

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).
Nota Fiscal de Servios Eletrnica - NFSE Pgina 6 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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

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 (fluxos 2.c e 2.d). O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.e). 2.1.3. Consulta de NFS-e por RPS Esse servio efetua a consulta de uma NFS-e a partir do nmero de RPS que a gerou.

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

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 7 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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

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).
Nota Fiscal de Servios Eletrnica - NFSE Pgina 8 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 9 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

XML de Envio validado pelo arquivo: servico_cancelar_nfse_envio.xsd XML de Resposta validado pelo arquivo: servico_cancelar_nfse_resposta.xsd Passos para execuo 1. A aplicao acessa o servio de Cancelamento de NFS-e e submete os dados para processamento (fluxo 2.b). 2. A requisio recebida pelo servidor do Web Service, que verifica os dados preenchidos, identifica a NFS-e correspondente e efetua o seu cancelamento (fluxo 2.c). 3. O Web Service retorna uma mensagem com o resultado do processamento do servio (fluxo 2.d). 2.2. PADRES TCNICOS

2.2.1. Padro de Comunicao O meio fsico de comunicao utilizado entre os sistemas de informao dos contribuintes e o Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda ser a Internet, com o uso do protocolo SSL, que alm de garantir um duto de comunicao seguro na Internet, permite a identificao do servidor e do
Nota Fiscal de Servios Eletrnica - NFSE Pgina 10 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

cliente atravs de certificados digitais, eliminando a necessidade de identificao do usurio atravs de nome ou cdigo de usurio e senha. O modelo de comunicao segue o padro de Web Services definido pelo WS-I Basic Profile. A troca de mensagens entre o Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda e o sistema do contribuinte ser realizada no padro SOAP, com troca de mensagens XML no padro Style/Enconding: Document/Literal, wrapped. A opo wrapped representa a chamada aos mtodos disponveis com a passagem de mais de um parmetro. Para descrever os servios disponibilizados, ser utilizado um documento WSDL (Web Service Description Language). O WSDL o padro recomendado para descrio de servios SOAP.

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 3.5. 2.2.2. Padro de Certificado Digital Os certificados digitais utilizados no sistema de Notas Fiscais de Servio Eletrnicas, das Secretarias Municipais de Fazenda, sero emitidos por Autoridade Certificadora credenciada pela Infraestrutura de Chaves Pblicas Brasileira ICP-Brasil, de pessoa fsica ou jurdica, dos tipos A1, A3 ou certificado de servidor (hbrido). Para a assinatura digital dos documentos envolvidos aceitar-se- que o certificado digital seja de quaisquer dos estabelecimentos da empresa.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 11 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Os certificados digitais sero exigidos em 2 (dois) momentos distintos para a integrao entre o sistema do contribuinte e o Web Service das Secretarias Municipais de Fazenda: Assinatura de Mensagens: O certificado digital utilizado para essa funo dever conter o CNPJ do estabelecimento emissor da NFS-e ou o CNPJ do estabelecimento matriz. O certificado digital dever ter o uso da chave previsto para a funo de assinatura digital, respeitando a Poltica do Certificado. Transmisso (durante a transmisso das mensagens entre os servidores do contribuinte e os servios disponibilizados pelas Secretarias Municipais de Fazenda): O certificado digital utilizado para identificao do aplicativo do contribuinte dever conter o CNPJ do responsvel pela transmisso das mensagens, mas no necessita ser o mesmo CNPJ do estabelecimento emissor da NFS-e, devendo ter a extenso extended Key Usage com permisso de "Autenticao Cliente". 2.2.3. Padro de Assinatura Digital As mensagens enviadas aos servios disponibilizados pelas Secretarias Municipais de Fazenda so documentos eletrnicos elaborados no padro XML e devem ser assinados digitalmente com um certificado digital que contenha o CNPJ do

estabelecimento matriz ou o CNPJ do estabelecimento emissor da NFS-e objeto do pedido. Para garantir minimamente a integridade das informaes prestadas e a correta formao dos arquivos XML, o contribuinte dever submeter s 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>
Nota Fiscal de Servios Eletrnica - NFSE Pgina 12 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

<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:
# XS01 XS02 XS03 XS04 XS05 CAMPO Signature Id SignedInfo Canonicalization Method Algorithm ELEMENTO Raiz A G G A PAI XS01 XS01 XS03 XS04 C TIPO C Grupo da Informao da assinatura Grupo do Mtodo de Canonicalizao Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/ REC-xml-c14n20010315 Grupo do Mtodo de Assinatura Atributo Algorithm de SignedInfo: http://www.w3.org/2000/09/ xmldsig#rsa-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-xml-c14n-20010315 http://www.w3.org/2000/09/ xmldsig#envelopedsignature Xpath DESCRIO OC. 1-1 1-1 1-1 1-1

XS06 XS07

SignatureMethod Algorithm

G A

XS03 XS06 C

1-1 1-1

XS08 XS09 XS10 XS11

Reference URI Transforms Unique_Transf_A lg Transform Algorithm

G A G RC

XS03 XS08 XS08 XS10 C

1-1 1-1 1-1 1-1

XS12 XS13

G A

XS10 XS12 C

2-2 1-1

XS14

Xpath

XS12

0-N

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 13 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

XS15 XS16

DigestMethod Algorithm

G A

XS08 XS15 C

XS17 XS18 XS19 XS20 XS21

DigestValue SignatureValue KeyInfo X509Data X509Certificate

E G G G E

XS08 XS01 XS01 XS19 XS20

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

1-1 1-1

1-1 1-1 1-1 1-1 1-1

2.2.4. Validao de Assinatura Digital pelo Sistema NFS-e Para a validao da assinatura digital, seguem as regras que sero adotadas pelas Secretarias Municipais de Fazenda: 1. Extrair a chave pblica do certificado; 2. Verificar o prazo de validade do certificado utilizado; 3. Montar e validar a cadeia de confiana dos certificados validando tambm a LCR (Lista de Certificados Revogados) de cada certificado da cadeia; 4. Validar o uso da chave utilizada (Assinatura Digital) de tal forma a aceitar certificados somente do tipo A (no sero aceitos certificados do tipo S); 5. Garantir que o certificado utilizado de um usurio final e no de uma Autoridade Certificadora; 6. Adotar as regras definidas pelo RFC 3280 para LCRs e cadeia de confiana; 7. Validar a integridade de todas as LCR utilizadas pelo sistema; 8. Prazo de validade de cada LCR utilizada (verificar data inicial e final).

A forma de conferncia da LCR fica a critrio de cada Secretaria Municipal de Fazenda, podendo ser feita de 2 (duas) maneiras: On-line ou Download peridico. As assinaturas digitais das mensagens sero verificadas considerando o horrio fornecido pelo Observatrio Nacional.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 14 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

2.2.5. Uso de Assinatura com Certificado Digital Para garantir a autenticidade dos dados gerados, algumas informaes devero ser assinadas digitalmente. Abaixo segue as informaes que devero ser assinadas e quem dever faz-lo em cada momento: O RPS, pelo contribuinte, antes do envio do mesmo atravs do Lote de RPS; O Lote de RPS, pelo contribuinte, antes do envio do mesmo; A NFS-e: o Pela prefeitura e pelo contribuinte, quando gerada pela Aplicao On Line; o Pela prefeitura nos demais casos; O Pedido de cancelamento da NFS-e, pelo contribuinte; A Confirmao de cancelamento da NFS-e, pela prefeitura; PADRO DAS MENSAGENS XML

2.3.

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. rea do Cabealho Abaixo, o leiaute da rea de Cabealho padro:
# CAMPO ELEMENTO PAI TIPO TAM. DESCRIO OC.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 15 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

cabealho verso versaoDados

G A E 1 1 N N 4 4

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.

1-1 1-1 1-1

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

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 16 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

2.3.3. Schemas XML (arquivos XSD) O Schema XML (arquivo XSD) correspondente a cada uma das mensagens XML de pedido e de retorno utilizadas pelo Web Service pode ser obtido na internet acessando o Portal do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda. 2.3.4. Verso dos Schemas XML Toda mudana de layout das mensagens XML do Web Service implica na atualizao do seu respectivo Schema XML. A identificao da verso dos Schemas XML ser realizada com o acrscimo do nmero da verso com dois dgitos no nome do arquivo XSD precedida da literal _v, como segue: <Nome do Arquivo>_v<Nmero da Verso>.xsd Exemplo: tipos_nfse_v01.xsd A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de Notas Fiscais de Servio Eletrnicas das Secretarias Municipais de Fazenda utilizam as definies de tipos simples ou tipos complexos que esto definidos em outros Schemas XML, nestes casos, a modificao de verso do Schema bsico ser repercutida no Schema principal. As modificaes de layout das mensagens XML do Web Service podem ser causadas por necessidades tcnicas ou em razo da modificao de alguma legislao. As modificaes decorrentes de alterao da legislao devero ser implementadas nos prazos previstos no ato normativo que introduziu a alterao. As modificaes de ordem tcnica sero divulgadas pelas Secretarias Municipais de Fazenda e podero ocorrer sempre que se fizerem necessrias. 2.4. AMBIENTE DE HOMOLOGAO

Para testar os servios Web Services publicados, h um ambiente de homologao, onde o usurio poder utilizar por tempo indeterminado.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 17 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

O usurio realizar um cadastro e criar uma senha de acesso. A credencial do usurio, CNPJ e senha, sero solicitadas no momento de consumir um servio ou acessar o ambiente de homologao. As notas fiscais emitidas no ambiente de homologao no tm nenhuma validao fiscal. Seguem abaixo os links de cadastro e de homologao. Link de cadastro: http://187.45.245.217/nfse_homologacao/ Link de homologao: http://187.45.245.217/ws_nfse/nfseservice.svc Observao: Caso as funcionalidades sejam implementadas por empresas de desenvolvimento de software, no necessrio o cadastro de todas as empresas que utilizaro as funcionalidades publicadas, visto que as regras de negcios so idnticas.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 18 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

3.

ESTRUTURA DE DADOS DO WEB SERVICE


Existir um nico Web Service com todos os servios apresentados no item 2.1. O

fluxo de comunicao sempre iniciado pelo sistema do contribuinte atravs do envio de uma mensagem XML ao Web Service com o pedido do servio desejado. 3.1. MODELO OPERACIONAL

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

3.1.1. Servios Sncronos As solicitaes de servios de implementao sncrona so processadas imediatamente e o resultado do processamento obtido em uma nica conexo. Abaixo, o fluxo simplificado de funcionamento:

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 19 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Etapas do processo ideal: 1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service; 2. O Web Service recebe a mensagem de solicitao de servio e encaminha ao aplicativo da NFS-e que ir processar o servio solicitado; 3. O aplicativo da NFS-e recebe a mensagem de solicitao de servios e realiza o processamento, devolvendo uma mensagem de resultado do processamento ao Web Service; 4. O Web Service recebe a mensagem de resultado do processamento e o encaminha ao aplicativo do contribuinte; 5. O aplicativo do contribuinte recebe a mensagem de resultado do processamento e caso no exista outra mensagem, encerra a conexo. 3.1.2. Servios Assncronos As solicitaes de servios de implementao assncrona so processadas de forma distribuda por vrios processos e o resultado do processamento somente obtido na segunda conexo. Abaixo, o fluxo simplificado de funcionamento:

Etapas do processo ideal: Solicitao e processamento: 1. O aplicativo do contribuinte inicia a conexo enviando uma mensagem de solicitao de servio para o Web Service de recepo de solicitao de servios; 2. O Web Service de recepo de solicitao de servios recebe a mensagem de solicitao de servio e a coloca na fila de servios solicitados, acrescentando o CNPJ do transmissor obtido do certificado digital do transmissor;
Nota Fiscal de Servios Eletrnica - NFSE Pgina 20 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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; Obteno do resultado do servio: 7. O aplicativo do contribuinte, atravs do protocolo recebido, envia uma consulta ao servio que retornar o resultado do processamento daquele protocolo, iniciando uma conexo com o Web Service; 8. O Web Service recebe a mensagem de consulta e localiza o resultado de processamento da solicitao de servio; 9. O Web Service devolve o resultado do processamento ao aplicativo contribuinte; 10. O aplicativo do contribuinte recebe a mensagem de resultado do processamento e, caso no exista outra mensagem, encerra a conexo. 3.2. FORMATOS E PADRES UTILIZADOS

Abaixo segue algumas formataes de dados que devem ser seguidas para gerao correta na estrutura dos arquivos.
FORMATO 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

Data/Hora (datetime)

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 21 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Valores Decimais (decimal)

Valores Percentuais (decimal)

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 00.00 O formato em percentual presume o valor percentual em sua forma fracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira da fracionria. Exemplo: 62% = 62.00 15% = 15.00 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 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.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 22 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

3.3.

TIPOS SIMPLES

A seguir encontra-se a tabela com a lista dos tipos simples que sero utilizados como tipos de dados. A tabela est dividida em 4 colunas, a saber: Campo: nome do tipo simples; Tipo: tipo primitivo de dados utilizados pelo campo: o C: Caractere; o N: Nmero; o D: Data ou Data/Hora; Descrio: descreve informaes sobre o campo; Tam.: tamanho do campo: o Quando for caracteres o tamanho define a quantidade mxima de caracteres que o texto poder ter; o Quando for numrico o tamanho pode ser representado das seguintes formas: Nmero inteiro, que define o total de dgitos existente no nmero. Exemplo: 15 significa que o nmero poder ter, no mximo, 15 dgitos; Nmero fracionrio, que define o total de dgitos e quantos deles sero designados para a parte fracionria. Exemplo: 15,2 significa que o nmero poder ter, no mximo, 15 dgitos sendo 2 deles a identificao da parte fracionria. A parte fracionria no obrigatria quando assim definido; o Quando for data, no haver definio de tamanho.
CAMPO tsNumeroNfse TIPO N TAM. 15 DESCRIO Nmero da Nota Fiscal de Servio Eletrnica, formado pelo ano com 04 (quatro) dgitos e um nmero sequencial com 11 posies Formato AAAANNNNNNNNNNN Cdigo de verificao do nmero da nota Cdigo de status do RPS 1 Normal 2 Cancelado Cdigo de status da NFS-e 1 Normal 2 Cancelado

tsCodigoVerificacao tsStatusRps

C N

9 1

tsStatusNfse

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 23 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tsNaturezaOperacao

tsRegimeEspecialTributacao

tsSimNao

tsQuantidadeRps tsNumeroRps tsSerieRps tsTipoRps

N N C N

4 15 5 1

tsOutrasInformacoes tsValor

C N

255 15,2

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,000.00 (ponto separando casa decimal, vrgula separando casa do milhar) Cdigo de item da lista de servio Cdigo CNAE Cdigo de Tributao Valor percentual Discriminao do contedo da NFS-e Cdigo de identificao do municpio conforme tabela do IBGE. Caso seja de fora do pas, colocar 99999. Nmero de inscrio municipal Nmero de Inscrio Estadual Razo Social do contribuinte Nome fantasia do contribuinte CNPJ do contribuinte Endereo do contribuinte Nmero do endereo Complemento de endereo Bairro do contribuinte Sigla da unidade federativa. Caso seja de fora do pas, colocar EX. Nmero do CEP do contribuinte E-mail do contribuinte Telefone do contribuinte CPF do contribuinte Indicador de uso de CPF ou CNPJ

tsItemListaServico tsCodigoCnae tsCodigoTributacao tsAliquota tsDiscriminacao tsCodigoMunicipioIbge tsIncricaoMunicipal tsInscricaoEstadual tsRazaoSocial tsNomeFantasia tsCnpj tsEndereco tsNumeroEndereco tsComplementoEndereco tsBairro tsUf tsCep tsEmail tsTelefone tsCpf tsIndicacaoCpfCnpj

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

5 7 20 5,4 200 7 15 20 115 115 14 125 10 60 60 2 8 80 15 11 1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 24 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tsCodigoObra tsArt tsNumeroLote tsNumeroProtocolo tsSituacaoLoteRps

C C N C N

15 15 15 50 1

tsCodigoMensagemAlerta tsDescricaoMensagemAlerta tsCodigoCancelamentoNfse

C C C

4 200 4

tsIdTag P1 P2 tsLink

C C C C

255 14 20 200

1 CPF 2 CNPJ 3 No Informado Cdigo de Obra Cdigo ART Nmero do Lote de RPS Nmero do protocolo de recebimento do RPS Cdigo de situao de lote de RPS 1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso Cdigo de mensagem de retorno de servio Descrio da mensagem de retorno de servio Motivo do Cancelamento da NFS-e 1 Lanamento Indevido 2 Erro de digitao Atributo de identificao da tag a ser assinada no documento XML CNPJ do contribuinte, apenas nmero. Senha do contribuinte Disponibilizado para a impresso da NFS-e. Em breve

3.4.

TIPOS COMPLEXOS

A seguir sero detalhadas as tabelas de cada tipo composto e seus campos. A tabela est dividida da seguinte forma:
CAMPO (3) TIPO (5) (5) TAM. (6) (6) (1) (2) DESCRIO (7) (7) OC. (8) (8)

(4) (4)

1. Nome do tipo complexo; 2. Descrio do tipo complexo; 3. Identifica se a sequncia de campos far parte de uma escolha (Choice); 4. Nome do campo que faz parte do tipo complexo; 5. Tipo do campo, que pode ser de um tipo simples ou complexo; 6. Tamanho do campo. Quantidade mxima de caracteres ou preciso numrica, dependendo do tipo de informao. 7. Descrio do campo. 8. Ocorrncia. Nmero de vezes que a informao pode ser apresentada. 0-1 No obrigatrio
Nota Fiscal de Servios Eletrnica - NFSE Pgina 25 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

0-N No obrigatrio, mas pode ser apresentada muitas vezes 1-1 Obrigatrio. 1-2 Obrigatrio, pode ser apresentada uma ou duas vezes. 1-N Obrigatrio, pode ser apresentada uma ou mais vezes.
TABELAS PARA TIPOS COMPLEXOS
CAMPO Choice tcCpfCnpj TIPO TAM. C 11 C 14 Representa CPF/CNPJ. DESCRIO Nmero do Cpf. Nmero do Cnpj. OC. 1-1 1-1

Cpf Cnpj

tcEndereco Conjunto de dados de identificao completa do endereo. CAMPO TIPO TAM. DESCRIO Endereco C 125 Endereo. Numero C 10 Nmero do endereo. Complemento C 60 Complemento do Endereo. Bairro C 60 Nome do bairro. CodigoMunicipio N 7 Cdigo de identificao do municpio conforme tabela do IBGE. Uf C 2 Sigla da unidade federativa. Cep C 8 Nmero do CEP. tcContato Representa forma de contato com a pessoa (fsica/jurdica). TIPO TAM. DESCRIO C 11 Telefone para contato. C 80 E-mail para contato.

OC. 0-1 0-1 0-1 0-1 0-1 0-1 0-1

CAMPO Telefone Email

OC. 0-1 0-1

tcIdentificacaoOrgaoGerador Conjunto de dados de identificao de rgo gerador. CAMPO TIPO TAM. DESCRIO CodigoMunicipio N 7 Cdigo de identificao do municpio conforme tabela do IBGE. Uf C 2 Sigla da unidade federativa. tcIdentificacaoRps Conjunto de dados de identificao do RPS. TIPO TAM. DESCRIO N 15 Nmero do RPS. C 5 Nmero de srie do RPS. N 1 Cdigo de tipo de RPS. 1 RPS 2 Nota Fiscal Conjugada (Mista) 3 Cupom

OC. 1-1 1-1

CAMPO Numero Serie Tipo

OC. 1-1 1-1 1-1

tcIdentificacaoPrestador Conjunto de dados de identificao do prestador de servio. CAMPO TIPO TAM. DESCRIO OC. Cnpj C 14 Nmero do CNPJ do prestador. 1-1 InscricaoMunicipal C 15 Nmero de Inscrio Municipal do prestador. 0-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 26 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tcIdentificacaoTomador Conjunto de dados de identificao do tomador de servio. CAMPO TIPO TAM. DESCRIO CpfCnpj tcCpfCnpj Caso Tomador no identificado, preencher com 11 zeros. InscricaoMunicipal C 15 Nmero de Inscrio Municipal do tomador. InscricaoEstadual C 20 Nmero de Inscrio Estadual do tomador. tcDadosTomador Conjunto de dados do tomador de servio. CAMPO TIPO TAM. DESCRIO IdentificacaoTomador tcIdentificacaoTomador Conjunto de dados de identificao do tomador de servio. RazaoSocial C 115 Razo Social do tomador. Endereco tcEndereco Conjunto de dados de identificao completa do endereo. Se tomador for jurdico, preencher todos os campos do endereo. Caso contrrio, preencher apenas o campo Razo Social. Contato tcContato Representa forma de contato com a pessoa (fsica/jurdica).

OC. 1-1 0-1 0-1

OC. 1-1 0-1 0-1

0-1

tcIdentificacaoIntermediarioServico Conjunto de dados de identificao do intermedirio do servio. CAMPO TIPO TAM. DESCRIO OC. RazaoSocial C 115 Razo Social do intermedirio. 1-1 CpfCnpj tcCpfCnpj Representa CPF/CNPJ do intermedirio. 1-1 InscricaoMunicipal C 15 Nmero de Inscrio Municipal do intermedirio. 0-1 tcValores Conjunto de valores que compe o documento fiscal. TIPO TAM. DESCRIO N 15,2 Valor dos servios em R$. N 15,2 Valor das dedues para Reduo da Base de Clculo em R$. ValorPis N 15,2 Valor da reteno do PIS em R$. Informao declaratria. ValorCofins N 15,2 Valor da reteno do COFINS em R$. Informao declaratria. ValorInss N 15,2 Valor da reteno do INSS em R$. Informao declaratria. ValorIr N 15,2 Valor da reteno do IR em R$. Informao declaratria. ValorCsll N 15,2 Valor da reteno do CSLL em R$. Informao declaratria. IssRetido N 1 1 Sim; 2 No Caso Sim, o valor do IssRetido dever ser igual ao ValorIss e exibir o ValorIssRetido. Caso No, no exibir ValorIssRetido. ValorIss N 15,2 Valor do ISS. OutrasRetencoes N 15,2 Valor de outras retenes. BaseCalculo N 15,2 (Valor dos servios Valor das dedues descontos incondicionados). Aliquota N 15,2 Valor percentual. CAMPO ValorServicos ValorDeducoes

OC. 1-1 0-1 0-1 0-1 0-1 0-1 0-1 1-1

0-1 0-1 0-1 0-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 27 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

ValorLiquidoNfse

15,2

ValorIssRetido DescontoCondicionado DescontoIncondicionado

N N N

15,2 15,2 15,2

(ValorServicos ValorPIS ValorCOFINS ValorINSS ValorIR ValorCSLL utrasRetenoes ValorISSRetido - DescontoIncondicionado DescontoCondicionado). Valor do ISS Retido. Valor do Desconto Condicionado. Valor do Desconto Incondicionado.

0-1

0-1 0-1 0-1

tcDadosServico Conjunto de dados que compe o servio prestado. TIPO TAM. DESCRIO tcValores Conjunto de valores que compe o documento fiscal. ItemListaServico C 5 Cdigo de item da lista de servio. CodigoCnae N 7 Cdigo CNAE. CodigoTributacaoMunicipio C 20 Cdigo de Tributao. Discriminacao C 200 Discriminao do contedo da NFS-e. CodigoMunicipio N 7 Cdigo de identificao do municpio conforme tabela do IBGE. Preencher com 5 noves para servio prestado no exterior. ItensServico tcItemServico CAMPO Valores tcDadosConstrucaoCivil Conjunto de dados para identificao de construo civil. CAMPO TIPO TAM. DESCRIO CodigoObra C 15 Cdigo de Obra. Art C 15 Cdigo ART. tcDadosPrestador Conjunto de dados do prestador do servio. CAMPO TIPO TAM. DESCRIO IdentificacaoPrestador tcIdentificacao Conjunto de dados de identificao do prestador Prestador de servio. RazaoSocial C 115 Razo Social do prestador. NomeFantasia C 115 Nome Fantasia do prestador. Endereco tcEndereco Conjunto de dados de identificao completa do endereo. Contato tcContato Representa forma de contato com a pessoa (fsica/jurdica). tcInfRps Conjunto de dados informativos do Recibo Provisrio de Servio (RPS). TIPO TAM. DESCRIO C 255 Atributo de identificao da tag a ser assinada no documento XML. IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificao do RPS. DataEmissao D Data da Emisso. Formato AAAA-MM-DDTHH:mm:ss NaturezaOperacao N 2 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 CAMPO Id

OC. 1-1 1-1 0-1 1-1 1-1 1-1

1-N

OC. 1-1 1-1

OC. 1-1 1-1 0-1 1-1 0-1

OC.

1-1 1-1 1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 28 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

RegimeEspecialTributacao

OptanteSimplesNacional IncentivadorCultural Status RpsSubstituido OutrasInformacoes Servico Prestador Tomador IntermediarioServico ConstrucaoCivil

N N N tcIdentificacaoRps C tcDadosServico tcIdentificacaoPrest ador tcDadosTomador tcIdentificacaoInter mediarioServico tcDadosContrucao Civil

1 1 1

255

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 Identificao de Sim/No 1 Sim; 2 No Cdigo de status do RPS 1 Normal; 2 Cancelado Conjunto de dados de identificao do RPS. Informaes Adicionais ao Documento. Conjunto de dados que compe o servio prestado. Conjunto de dados de identificao do prestador de servio. Conjunto de dados do tomador de servio. Conjunto de dados de identificao do intermedirio do servio. Conjunto de dados para identificao de construo civil.

0-1

1-1 1-1 1-1 0-1 0-1 1-1 1-1 1-1 0-1 0-1

tcRps Representa a estrutura do Recibo Provisrio de Servio (RPS) assinada. TIPO TAM. DESCRIO tcInfRps Conjunto de dados informativos do Recibo Provisrio de Servio (RPS). Signature dsig:Signature CAMPO InfRps

OC. 1-1 0-1

tcIdentificacaoNfse Representa dados que identificam uma Nota Fiscal de Servios Eletrnica. CAMPO TIPO TAM. DESCRIO OC. Numero N 15 Nmero da Nota Fiscal de Servio Eletrnica 1-1 Formato AAAANNNNNNNNNNN. Cnpj C 14 CNPJ. 1-1 InscricaoMunicipal C 15 Nmero de inscrio municipal. 0-1 CodigoMunicipio N 7 Cdigo de identificao do municpio conforme 1-1 tabela do IBGE. tcInfNfse Representa os dados informativos da Nota Fiscal de Servios Eletrnica. TIPO TAM. DESCRIO C 255 Atributo de identificao da tag a ser assinada no documento XML. Numero N 15 Nmero da Nota Fiscal de Servio Eletrnica Formato AAAANNNNNNNNNNN. CAMPO Id

OC. 1-1 1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 29 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

CodigoVerificacao DataEmissao IdentificacaoRps DataEmissaoRps NaturezaOperacao

C D tcIdentificacaoRps D N

RegimeEspecialTributacao

OptanteSimplesNacional

IncetivadorCultural

Competencia NfseSubstituida

D N

15

Servico ValorCredito

tcDadosServico N 15,2

PrestadorServico TomadorServico IntermediarioServico OrgaoGerador ConstrucaoCivil

tcDadosPrestador tcDadosTomador tcIdentificacaoInter mediarioServico tcIdentificacaoOrga oGerador tcDadosContrucao Civil

Cdigo de verificao do nmero da nota. Data e Hora da Emisso. Formato AAAA-MM-DDTHH:mm:ss Conjunto de dados de identificao do RPS. Data da Emisso do RPS. Formato: AAAA-MM-DD 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 Identificao de Sim/No 1 Sim 2 No Formato: AAAA-MM-DD Nmero da Nota Fiscal de Servio Eletrnica Formato AAAANNNNNNNNNNN. Conjunto de dados que compe o servio prestado. Valor monetrio. Formato: 0,000.00 (ponto separando casa decimal, vrgula separando casa do milhar) Conjunto de dados do prestador do servio. Conjunto de dados do tomador de servio. Conjunto de dados de identificao do intermedirio do servio. Conjunto de dados de identificao de rgo gerador. Conjunto de dados para identificao de construo civil.

1-1 0-1 0-1 1-1 0-1

1-1

1-1

1-1

0-1 1-1

0-1 1-1

1-1 0-1 1-1 0-1 1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 30 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tcNfse Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada. TIPO TAM. DESCRIO tcInfNfse Representa os dados informativos da Nota Fiscal de Servios Eletrnica. Signature Dsig:Signature CAMPO InfNfse

OC. 1-1 1-2

tcInfPedidoCancelamento Representa a estrutura de dados do pedido de cancelamento enviado pelo prestador ao cancelar uma Nota Fiscal de Servios Eletrnica. CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser assinada no documento XML. IdentificacaoNfse tcIdentificacaoNfse Representa dados que identificam uma 1-1 Nota Fiscal de Servios Eletrnica. CodigoCancelamento C 4 Cdigo de cancelamento com base na 0-1 tabela de Erros e alertas. tcPedidoCancelamento Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada. CAMPO TIPO TAM. DESCRIO OC. InfPedidoCancelamento tcIdentificacaoNfse Representa dados que identificam uma 1-1 Nota Fiscal de Servios Eletrnica. Signature Dsign:Signature 1-1 tcInfConfirmacaoCancelamento Representa a estrutura de dados da confirmao de cancelamento da Nota Fiscal de Servios Eletrnica feito pelo Fisco Municipal. CAMPO TIPO TAM. DESCRIO Sucesso boolean Sucesso da operao. DataHora D Data e hora. Formato AAAA-MM-DDTHH:mm:ss

OC. 1-1 1-1

tcConfirmacaoCancelamento Representa a estrutura de Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada. CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser assinada no documento XML. Pedido tcPedidoCancelamen Representa a estrutura de Pedido 1-1 to de Cancelamento da Nota Fiscal de Servios Eletrnica assinada. InfConfirmacaoCancelamento tcInfConfirmacaoCan Representa a estrutura de dados 1-1 celamento da confirmao de cancelamento da Nota Fiscal de Servios Eletrnica feito pelo Fisco Municipal. tcCancelamentoNfse Representa os dados de registro de substituio de NFS-e. CAMPO TIPO TAM. DESCRIO Confirmacao tcConfirmacaoCance Representa a estrutura de lamento Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada. Signature Dsig:Signature

OC.

1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 31 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tcInfSubstituicaoNfse Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e. CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser assinada no documento XML. NfseSubstituidora N 15 Nmero da Nota Fiscal de Servio Eletrnica 1-1 Formato AAAANNNNNNNNNNN. tcSubstituicaoNfse Representa a estrutura de substituio de NFS-e. CAMPO TIPO TAM. DESCRIO SubstituicaoNfse tcInfSubstituicaoNfse Representa a estrutura completa (pedido + confirmao) de cancelamento de NFS-e. Signature dsig:Signature tcCompNfse Representa a estrutura de compartilhamento de dados de uma NFS-e. TIPO TAM. DESCRIO tcNfse Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada. NfseCancelamento tcCancelamentoNfse Representa os dados de registro de substituio de NFS-e. NfseSubstituicao tcSubstituicaoNfse Representa a estrutura de substituio de NFS-e. CAMPO Nfse ListaMensagemRetorno Representa a estrutura de mensagem de retorno de servio. CAMPO TIPO TAM. DESCRIO MensagemRetorno tcMensagemRetorno Representa a estrutura de mensagem de retorno de servio.

OC. 1-1

1-2

OC. 1-1 0-1 0-1

OC. 1-N

tcMensagemRetornoLote Representa a estrutura de mensagem de retorno de servio. CAMPO TIPO TAM. DESCRIO OC. IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificao 1-1 do RPS. Codigo C 4 Cdigo de mensagem de retorno 1-1 de servio. Mensagem C 200 Descrio da mensagem de retorno 1-1 de servio. tcLoteRps Conjunto de dados para a identificao do Lote RPS. TIPO TAM. DESCRIO C 255 Atributo de identificao da tag a ser assinada no documento XML. NumeroLote N 15 Nmero do Lote de RPS. Cnpj C 14 CNPJ do contribuinte. InscricaoMunicipal C 15 Nmero de Inscrio Municipal. QuantidadeRps N 4 Quantidade de RPS do Lote. ListaRps tcRps Representa a estrutura do Recibo Provisrio de Servio (RPS) assinada. CAMPO Id

OC.

1-1 1-1 1-1 1-1 1-N

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 32 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

CAMPO Descricao Quantidade ValorUnitario

TIPO C N N

TAM. 200 7 15,2

tcItemServico DESCRIO Descrio do servio. Quantidade de itens. Valor unitrio de cada servio. ddDuasStrings DESCRIO CNPJ do contribuinte, apenas nmeros. Senha do contribuinte.

OC. 1-1 1-1 1-1

CAMPO P1 P2

TIPO P1 P2

TAM. 14 20

OC. 1-1 1-1

tcInfNovaNfse Conjunto de dados de descrio da NFS-e TIPO TAM. DESCRIO C 255 Atributo de identificao da tag a ser assinada no documento XML. NaturezaOperacao N 2 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 RegimeEspecialTributacao N 2 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) OptanteSimplesNacional N 1 Identificao de Sim/No 1 Sim 2 No IncetivadorCultural N 1 Identificao de Sim/No 1 Sim 2 No Status N 1 Cdigo de status da NFS-e 1 Normal 2 Cancelado Competencia D Formato: AAAA-MM-DD NfseSubstituida N 15 Nmero da Nota Fiscal de Servio Eletrnica - Formato AAAANNNNNNNNNNN. OutrasInformacoes C 255 Informaes adicionais ao documento. Servico tcDadosServico Conjunto de dados que compe o servio prestado. Tomador tcDadosTomador Conjunto de dados do tomador de servio. IntermediarioServico tcIdentificacaoIntermedi Conjunto de dados de CAMPO Id

OC.

1-1

0-1

1-1

1-1

1-1

1-1 0-1

0-1 1-1 1-1 0-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 33 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

arioServico ConstrucaoCivil tcDadosConstrucaoCivil

identificao do intermedirio do servio. Conjunto de dados para identificao de construo civil.

0-1

CAMPO IdentificacaoPrestador Numero Serie CodigoVerificacao DataEmissao Link

tcIdentNovaNfse Identificao da NFS-e TIPO TAM. DESCRIO tcIdentificacaoPrestador Conjunto de dados de identificao do prestador de servio. N 15 Nmero da NFS-e. C 5 Nmero de srie da nota. C 9 Cdigo de verificao do nmero da nota. D Data da Emisso. Formato AAAA-MM-DDTHH:mm:ss C 200 Disponibilizado para a impresso da NFS-e.

OC. 1-1 1-1 1-1 1-1 1-1 0-1

tcRespostaIdentNovaNfse - Representa a estrutura de mensagem de retorno da NFS-e CAMPO TIPO TAM. DESCRIO IdentificacaoNfse tcIdentNovaNfse Identificao da NFS-e Signature dsig:Signature

OC. 1-1 0-1

3.5.

SERVIOS

A seguir esto os servios disponveis, conforme descritos no item 2.1, no Web Service 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:
# (1) NOME (2) TIPO (3) PAI (4) DESCRIO (5) (7) OC. (6) (8)

1. Nmero identificador do campo, quando este contiver subitens; 2. Nome do campo; 3. Nome do tipo do campo que pode ser tipo primitivo, simples ou complexo; 4. Indica quem o campo pai, para definio da hierarquia; 5. Descreve alguma observao pertinente; 6. Quantas vezes o campo se repete na estrutura de dados:
Nota Fiscal de Servios Eletrnica - NFSE Pgina 34 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

a. Formato: z-y onde x a quantidade mnima e y a quantidade mxima. Se a quantidade mxima for indefinida, ser utilizado N no lugar do y; 7. Formato de grupo, utilizado para definio de uma escolha (ver prximo item); 8. Identifica os campos ou grupos que faro parte de uma escolha (Choice). 3.5.1. Verso do Sistema Mtodo: Versao Esse servio ser executado atravs da chamada do mtodo Versao, no sendo necessria a passagem de parmetros. O servio retorna uma cadeia de caractere com a identificao da verso do sistema. O servio tambm pode ser utilizado para verificar a conectividade.

3.5.2. Recepo de Lote RPS Mtodo: RecepcionarLoteRps 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 CAMPO EnviarLoteRpsEnvio LoteRps Signature pParam TIPO tcLoteRps dsig:Signature ddDuasStrings PAI 1 1 DESCRIO Conjunto de dados para a identificao do Lote RPS. OC. 1-1 1-1 0-1 1-1

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia ) retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Nota Fiscal de Servios Eletrnica - NFSE Pgina 35 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Utilizao do Mtodo Inicialmente a Signature e Id no esto sendo usados, tendo como segundo parmetro ddDuasStrings.

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


# 1 CAMPO EnviarLoteRps Resposta NumeroLote TIPO PAI DESCRIO OC. 1-1 Choice 1-1

DataRecebime nto Protocolo

D C

1 1

Nmero da Nota Fiscal de Servio Eletrnica Formato AAAANNNNNNNNNNN. Data e hora. Formato AAAA-MM-DDTHH:mm:ss Nmero do protocolo de recebimento do

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 36 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

ListaMensage mRetorno

ListaMensagem Retorno

RPS. Representa a estrutura de mensagem de retorno de servio.

1-1

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

3.5.3. Consulta de Situao de Lote de RPS Mtodo: ConsultarSituacaoLoteRps 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 CAMPO ConsultarSituacaoLoteRpsEnvio Prestador Protocolo 2 pParam TIPO tcIdentificacao Prestador C ddDuasStrings PAI 1 1 DESCRIO Conjunto de dados de identificao do prestador de servio. Nmero do protocolo de recebimento do RPS OC. 1-1 1-1 1-1 1-1

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia )

retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Nota Fiscal de Servios Eletrnica - NFSE Pgina 37 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Utilizao do Mtodo

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


# 1 CAMPO ConsultarSituacaoLo teRpsResposta NumeroLote Situao TIPO PAI DESCRIO OC. 1-1 Choice 1-1

N N

1 1

ListaMensagemRetor no

ListaMensagem Retorno

Nmero do Lote de RPS Cdigo de situao de lote de RPS 1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso Representa a estrutura de mensagem de retorno de servio.

1-1

Utilizao do Mtodo

3.5.4. Consulta de NFS-e por RPS Mtodo: ConsultarNfsePorRps Esse servio ser executado atravs da chamada ao mtodo

ConsultarNfsePorRps, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 38 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

# 1

CAMPO ConsultarNfseRpsEnvio IdentificacaoRps Prestador

TIPO tcIdentificacao Rps tcIdentificacao Prestador ddDuasStrings

PAI 1 1

DESCRIO Conjunto de dados de identificao do RPS. Conjunto de dados de identificao do prestador de servio.

OC. 1-1 1-1 1-1

pParam

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia )

retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio). Utilizao do Mtodo

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


# 1 CAMPO ConsultarNfseRps Resposta CompNfse TIPO PAI DESCRIO OC.

tcCompNfse

ListaMensagemR etorno

ListaMensagem Retorno

Representa a estrutura de compartilhamento de dados de uma NFS-e. Representa a estrutura de mensagem de retorno de servio.

Choice

1-1

1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 39 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Utilizao do Mtodo

3.5.5. Consulta de NFS-e Mtodo: ConsultarNfse Esse servio ser executado atravs da chamada ao mtodo ConsultarNfse, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 CAMPO ConsultarNfseEnvio Prestador TIPO tcIdentificacaoPrestador PAI 1 DESCRIO Conjunto de dados de identificao do prestador de servio. OC. 1-1 1-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 40 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

NumeroNfse

Nmero da Nota Fiscal de Servio Eletrnica Formato AAAANNNNNNNNNNN. Data inicial da consulta Nfse. Formato: AAAA-MM-DD Data final da consulta Nfse. Conjunto de dados de identificao do tomador de servio. Conjunto de dados de identificao do intermedirio do servio.

0-1

PeriodoEmissao DataInicial DataFinal Tomador IntermediarioServico

PeriodoEmissao D D tcIdentificacaoTomador tcIdentificacaoIntermedi arioServico ddDuasStrings

1 1 1 1 1

0-1 1-1 1-1 1-1 0-1 1-1

pParam

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia ) retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio). Utilizao do Mtodo

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 41 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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


# 1 2 CAMPO ConsultarNfse Resposta ListaNfse CompNfse ListaMensage mRetorno TIPO PAI DESCRIO OC. 1-1 Choice Representa a estrutura de compartilhamento de dados de uma NFS-e. Representa a estrutura de mensagem de retorno de servio. 1-1 0-N 1-1

tcCompNfse ListaMensage mRetorno

1 2 1

Utilizao do Mtodo

3.5.6. Consulta de Lote de RPS Mtodo: ConsultarLoteRps 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 CAMPO ConsultarLoteRpsEnvio Prestador TIPO tcIdentificacaoPrest ador C ddDuasStrings PAI 1 DESCRIO Conjunto de dados de identificao do prestador de servio. Nmero do protocolo recebimento do RPS OC. 1-1 1-1

Protocolo 2 pParam

de

1-1 1-1

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os
Nota Fiscal de Servios Eletrnica - NFSE Pgina 42 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

RPS

foram

convertidos

especificado

na

propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia )

retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio). Utilizao do Mtodo

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


# 1 2 CAMPO ConsultarLoteRps Resposta ListaNfse CompNfse TIPO PAI DESCRIO OC. 1-1 Choice Representa a estrutura de compartilhamento de dados de uma NFSe. Representa a estrutura de mensagem de retorno de servio. 1-1 1-N

tcCompNfse

1 2

ListaMensagemR etorno

ListaMensag emRetorno

1-1

Utilizao do Mtodo

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 43 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

tcCancelamentoNfse ser exibido quando um arquivo RPS retornado for cancelado. tcSubstituicaoNfse ser exibido quando um arquivo RPS retornado for substitudo. 3.5.7. Cancelamento NFS-e Mtodo: CancelarNfse 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 CAMPO CancelarNfseEnvio Pedido TIPO tcPedidoCancelamento PAI 1 DESCRIO Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada. OC. 1-1 1-1

pParam

ddDuasStrings

1-1

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia )

retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio). Utilizao do Mtodo

* Campos no obrigatrios.
Nota Fiscal de Servios Eletrnica - NFSE Pgina 44 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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


# 1 CAMPO CancelarNfse Resposta Cancelamento ListaMensage mRetorno TIPO PAI DESCRIO OC.

tcCancelamento Nfse ListaMensagem Retorno

1 1

Representa os dados de registro de substituio de NFS-e. Representa a estrutura de mensagem de retorno de servio.

Choice

1-1 1-1

Utilizao do Mtodo

* Campos no obrigatrios. 3.5.8. Gerar NFS-e Mtodo: GeraNfse Esse servio ser executado, inicialmente, atravs da chamada ao mtodo GerarNfse, passando a mensagem XML como parmetro com a estrutura definida na tabela que segue.
# 1 2 2 CAMPO GerarNovaNfseEnvio Prestador InformacaoNfse Servico Tomador IntermediarioServico TIPO tcIdentificacaoPrest ador tcInfNovaNfse tcDadosServico tcDadosTomador tcIdentificacaoInter PAI 1 1 2 2 2 DESCRIO Conjunto de dados de identificao do prestador de servio. Conjunto de dados de descrio da NFSe Conjunto de dados que compe o servio prestado. Conjunto de dados do tomador de servio. Conjunto de dados de identificao do OC. 1-1 1-1 1-1 1-1 1-1 0-1

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 45 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

ConstrucaoCivil Signature pParam

mediarioServico tcDadosContrucao Civil dsig:Signature ddDuasStrings

2 1

intermedirio do servio. Conjunto de dados para identificao de construo civil.

0-1 0-1 1-1

Nmero mximo de cem notas vo ser consultada de cada vez a partir do nmero passado no parmetro pConsultarNfseEnvio.NumeroNfse dentro do perodo em que os RPS foram convertidos e especificado na propriedade

pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so opcionais na pesquisa se no houver recebe null notas. ( tag A sem propriedade vazia )

retConsultarNfseResposta.Item.CompNfse

ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio). Utilizao do Mtodo Inicialmente a Signature e Id no esto sendo usados, tendo como segundo parmetro ddDuasStrings.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 46 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

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


# 1 CAMPO GerarNovaNfse Resposta NovaNfse ListaMensagem Retorno TIPO PAI DESCRIO OC.

tcRespostaIdent NovaNfse ListaMensagem Retorno

1 1

Representa a estrutura de mensagem de retorno da NFS-e. Representa a estrutura de mensagem de retorno de servio.

Choice

1-1 1-1

Utilizao do Mtodo

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 47 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

4.

ANEXOS
4.1. TABELA DE ERROS
SOLUO Reenvie assinatura do Hash conforme algoritmo estabelecido no Manual de Instruo da NFS-e. Informe um ms de competncia inferior ou igual ao de emisso do RPS ou da Nota. Utilize um dos tipos: 01 Tributao no municpio; 02 Tributao fora do municpio; 03 Iseno; 04 Imune; 05 Exigibilidade suspensa por deciso judicial; 06 Exigibilidade suspensa por rocedimento administrativo. Envie o RPS para emisso da NFS-e. Informe um nmero de NFS-E substituda que j tenha sido emitida. O cancelamento de uma NFS-e com crdito deve ser feito atravs de processo administrativo aberto em uma repartio fazendria. Confira e informe novamente os dados da NFS-e 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: 1 - RPS', 2 RPSC ou 3 - 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.

CD E1 E2 E3

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

E4 E5 E6

E7 E8 E9 E10 E11 E12 E13 E14 E15 E16 E17

Esse RPS no foi enviado para a nossa base de dados. O nmero da NFS-E substituda informado no existe na base de dados do municpio. Essa NFS-e no pode ser cancelada atravs desse servio, pois h crdito Informado. Essa NFS-e j foi substituda. Campo de optante pelo simples nacional no informado. Campo de incentivador cultural no informado. RPS j informado. 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 data de hoje. A data da emisso do RPS no poder ser inferior data de habilitao do prestador para emisso da NFS-e. O valor dos servios dever ser superior a R$ 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). O valor do INSS dever ser superior ou igual a R$ 0,00 (zero).

E18 E19 E20 E21 E22 E23 E24

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). No permitido valor de reteno inferior a zero (negativo).

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 48 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E26 E27 E28

E29 E30

O valor do IR dever ser superior ou igual a R$ 0,00 (zero). O valor da CSLL dever ser superior ou igual a R$ 0,00 (zero). Item da lista de servio informado incompatvel com a informao de optante pelo simples nacional O cdigo de servio prestado no permite reteno de ISS. Item da lista de servio inexistente.

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

E31 E32

E33 E34

Item da lista de servio no informado para a operao. Cdigo CNAE informado incompatvel com a informao de optante pelo simples nacional Cdigo CNAE inexistente. Cdigo de tributao informado incompatvel com a informao de optante pelo simples nacional. Cdigo de tributao inexistente.

E35

E36 E37

Campo ISSRetido invlido. Apenas servios tributados, no municpio ou fora, podem sofrer reteno de ISS. Contribuintes enquadrados como Microempresa Municipal, Estimativa, Sociedade de Profissionais ou Incentivador Cultural no podem sofrer reteno de ISS. Apenas empresas tomadoras de servios inscritas neste municipio podem efetuar reteno de ISS.

E38

E39

E40 E41

Valor do ISS retido no informado. O campo discriminao dos servios no foi preenchido. 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. CNPJ do prestador no informado. CPF/CNPJ do tomador invlido. O campo CPF/CNPJ do tomador dever ser preenchido com zeros quando for de

E42 E43

E44 E45 E46 E47 E48

Informe o nmero do CNPJ correto do prestador. Confira o numero do CNPJ informado. Caso esteja correto, o prestador no est inscrito no municpio. 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

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 49 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E49

CPF no-informado. Lote de RPS com excesso de inconsistncias. Inscrio Municipal do prestador invlida. Inscrio 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. CNPJ do tomador (<CNPJ enviado>) est vinculado a mais de uma inscrio municipal. Endereo do tomador (logradouro) no corresponde ao CEP informado. Campo endereo do tomador no informado (obrigatrio para tomador com CNPJ). Bairro no corresponde ao CEP informado. Cdigo do municpio do tomador no corresponde ao CEP informado. Campo cidade do tomador no informado (obrigatrio para tomador com CNPJ). A cidade do tomador informada no foi encontrada na base de dados da prefeitura. Sigla da UF do tomador no corresponde ao CEP informado. Cep no existe na tabela DNE dos Correios. Razo Social do intermedirio do servio no informada com CNPJ/CPF ou Inscrio Municipal do intermedirio informada. Inscrio Municipal do intermedirio do servio invlida. Inscrio Municipal do intermedirio do servio no esta vinculada ao CNPJ/CPF informado. CNPJ/CPF do Intermedirio 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. 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

E50 E51 E52 E53

informado. O servio de validao de RPS abortado quando atinge o nmero de 50 inconsistncias. Corrija os erros e reenvie o lote de RPS. Informe a inscrio municipal correta do prestador. Informe a inscrio municipal correta do tomador. Na emisso da NFS-e no permitido que o prestador seja igual ao tomador. Para tomadores estabelecidos fora deste municpio no preencher inscrio municipal. Informe a Inscrio Municipal do tomador vinculada ao CNPJ informado. 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 cdigo do municpio ou o CEP do tomador do servio. O preenchimento da Cidade do Tomador obrigatrio para tomadores Pessoas Jurdicas (com CNPJ). Informe a cidade correta do tomador. No caso de cidade do exterior (fora do pas), informe o campo com 99999. Corrija a sigla da UF ou o CEP do tomador do servio. Informar o Cep correto. Informe a razo social do intermedirio do servio.

E54

E55 E56

E57 E58 E59

E60

E61 E62 E63

E64 E65

Informe a Inscrio Municipal correta do intermedirio do servio. Acerte a Inscrio Municipal ou o CNPJ/CPF do intermedirio do servio. Informe o CNPJ/CPF correto do intermedirio 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. 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 RPS-C". Utilize no cabealho do arquivo datas de emisso da Nota Fiscal compreendidas entre a data incio de emisso do lote e a data fim de emisso do lote.

E66 E67 E68 E69 E70

E71 E72 E73 E74

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 50 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E75 E76 E77 E78

E79 E80 E81 E82 E83 E84 E85 E86 E87 E88 E89 E90 E91 E92 E93 E94 E95 E96 E97 E98 E99 E100

do lote> conforme especificado no cabealho do arquivo. Nmero do RPS substitudo no informado para status do RPS igual a "S". O nmero do RPS substitudo informado no existe na base de dados. Nmero da NFS-e no informado. Nmero da NFS-e inexistente na base de dados para o prestador de servio pesquisado. Essa NFS-e j est cancelada. Cdigo de verificao no informado. Cdigo de verificao no corresponde NFS-e consultada. Pesquisa pela atividade s pode ser feita com a indicao de um CEP ou bairro. Campo Inscrio Municipal do tomador informado incorretamente. 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 NFS-e 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. Campo dedues informado incorretamente. Campo descontos informado incorretamente.

Informe o nmero do RPS substitudo. Informe o nmero do RPS substitudo correto. Informe o nmero da NFS-e. Informe o nmero correto da NFS-e.

Confira e informe novamente os dados da NFS-e que deseja cancelar. Informe o cdigo de verificao da NFS-e. Informe o cdigo de verificao correto. Informe um CEP ou um bairro. O campo Inscrio Municipal do tomador numrico e dever ter tamanho mximo de 15 dgitos. Informe uma atividade. Informe uma atividade. 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 um nmero de RPS que corresponda Sequncia utilizada pelo prestador de servio. Exija do prestador do servio emisso da NFS-E. Faa uma nova consulta mais tarde. Informe a srie correta para o RPS pesquisado. Informe o ms de competncia no formato AAAAMM. Informe o ms de competncia no formato AAAAMM. O campo Nmero do RPS numrico e dever Ter tamanho mximo de 15 dgitos. O campo Srie do RPS alfanumrico e dever Ter tamanho mximo de cinco caracteres. Informe o valor dos servios. No permitido valor de reteno superior ao Valor de servios. O campo valor dos servios numrico e dever Ter tamanho mximo de 15,2, ou seja, 15. Nmeros inteiros e dois decimais. O campo valor das dedues numrico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. O campo valor dos descontos numrico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros

E101

E102

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 51 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E103

Reteno de tributo federal informada incorretamente. 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. Quando a natureza da operao for tributao fora do municpio, o campo municpio da prestao do servio dever ser diferente do municpio do prestador Municpio da prestao do servio no informado. Campo Inscrio Municipal do intermedirio informado incorretamente. Campo nmero do endereo do tomador no informado (obrigatrio para tomador com CNPJ) . Campo bairro do tomador no informado (obrigatrio para tomador com CNPJ). Campo UF do tomador no informado (obrigatrio para tomador com CNPJ). A UF do tomador informada no foi encontrada na base de dados. Campo razo social do tomador informado incorretamente. Campo razo social do tomador no informado. Campo endereo do tomador informado incorretamente. Campo nmero do endereo do tomador informado incorretamente. Campo complemento do endereo do tomador informado incorretamente. 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 e-mail do tomador informado incorretamente.

E104 E105 E106 E107 E108 E109 E110

inteiros e dois decimais. O campo referente a reteno de tributo federal numrico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. 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.

E111 E112

E113

E114 E115 E116

E117 E118

E119 E120 E121 E122 E123 E124 E125 E126

Informe o municpio da prestao do servio, de acordo com a tabela do IBGE. O campo Inscrio Municipal do intermedirio 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. 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. O campo endereo do tomador dever ter tamanho mximo de 125 caracteres. 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 alquota 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 e-mail do tomador dever ter tamanho mximo de 80 caracteres.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 52 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E127 E128 E129 E130 E131

Campo telefone do tomador informado incorretamente. Campo razo social do intermedirio do servio informado incorretamente. Campo cdigo da obra informado incorretamente. Campo ART informado incorretamente. Campo data inicial preenchido incorretamente.

E132

Campo data final preenchido incorretamente.

E133 E134 E135 E136 E137 E138 E139 E140 E141 E142 E143 E144

Data final da pesquisa no poder ser superior 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 NFS-e informado incorretamente. Data de emisso da NFS-e informada incorretamente. CNPJ no autorizado a realizar o servio. Campo nmero da NFS-e substituda informado incorretamente. 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.

O campo telefone do tomador dever ter tamanho mximo de 15 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. 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. 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 NFS-e numrico e dever ter tamanho mximo de 15 dgitos. Informe a data correta da emisso da NFS-e a ser consultada. Informe o CNPJ autorizado a executar o servio. O campo nmero da NFS-e substituda numrico e dever ter tamanho mximo de 15 dgitos. Informe o bairro do prestador. Informe a Inscrio Municipal do prestador. 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 municpio; 02 Tributao fora do municpio; 03 Iseno; 04 Imune; 05 Exigibilidade suspensa por deciso judicial; 06 Exigibilidade suspensa por procedimento administrativo. 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). Utilize um dos tipos: 1 Sim; 2 - No. Utilize um dos tipos: 1 Sim; 2 - No. Informe o status do RPS. O campo CNPJPrestador numrico e dever ter tamanho mximo de 14 dgitos. Campo de preenchimento obrigatrio, caso no utilize srie, preencha o campo com 00000. Informe a quantidade de RPS.

E145

Regime Especial de Tributao invlido.

E146 E147 E148 E149 E150 E151

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. Quantidade de RPS no informada.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 53 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E152 E153

Campo ISSRetido no informado. Campo ValorISSRetido informado incorretamente. Campo CNPJ/CPF do Intermedirio do Servio informado incorretamente. Campo CPFCNPJTomador informado incorretamente. CNPJ do prestador no autorizado a emitir NFS-e. Usurio no est autorizado a utilizar esse servio para esse contribuinte. Campo Inscrio Municipal do prestador informado incorretamente. 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.

E154

E155 E156 E157 E158

E159

Informe um dos tipos: 1 para ISS Retido ou 2 para ISS no Retido. O campo ValorISSRetido numrico e dever ter tamanho mximo de 15,2, ou seja, 15 nmeros inteiros e dois decimais. O campo CNPJ/CPF do Intermedirio do Servio numrico e dever ter tamanho mximo de 14 dgitos. O campo CPFCNPJTomador numrico e dever ter tamanho mximo de 14 dgitos. Solicite autorizao para emitir NFS-e para o CNPJ informado. Solicite ao contribuinte autorizao para utilizar o servio em seu nome. 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.

E160 E161

4.2.
CD A1

TABELA DE ALERTAS
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 municipal, Item 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 municpio. O e-mail do tomador de servios no vlido. Este campo ser ignorado e no haver envio de e-mail.

MENSAGEM Item da lista de servio, cdigo CNAE ou cdigo de tributao informado para a operao no est cadastrado para o Prestador de servio.

A2

A3

A4 A5

A6 A7 A8

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. E-mail do tomador de servios invlido. Email no ser enviado.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 54 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

4.3.
CD A900 E900 E901 E902 E903 E904 E905 E906

TABELA DE MENSAGENS PERSONALIZADAS


SOLUO Antes de fazer a consulta verifique a situao do lote. Entre em contato com o suporte. Entre em contato com o suporte. Envie o lote novamente com a quantidade de rps's dentro do limite. Altere o nmero do lote. Confira o nmero do protocolo e os dados do prestador. Informe o nmero do protocolo. Verifique os valores informados.

E907 E908 E909 E910

MENSAGEM O lote consultado no foi recebido, no foi processado ou foi processado com erro. Chamada ao mtodo retornou erro. Erro na autenticao do usurio. Usurio e senha no conferem. Quantidades de rps's enviandos no lote extrapolou o limite de {0}. J existe lote protocolado com esse nmero para o mesmo cnpj e inscrio municipal. Nmero de protocolo no corresponde a identificao do prestador informado. Nmero do protocolo no informado. Soma total dos Itens de Servio informados (Quantidade * ValorUnitario) diferente do Valor do Servio informado no Rps. Existe descricao de item de servio vazia. Exite quantidade informada de item de servio menor ou igual a 0(zero). Existe valor unitrio de item de servio menor ou igua a 0(zero). Campo de E910 informado incorretamente.

E911

Campo de E911 informado incorretamente.

E912

Campo de E912 informado incorretamente.

E913

Campo de E913 informado incorretamente.

E914

Campo de E914 informado incorretamente.

E915

Campo de E915 informado incorretamente.

E916

Campo de E916 informado incorretamente.

E917

Campo de E917 informado incorretamente.

E918

Campo de E918 informado incorretamente.

E919

Campo de E919 informado incorretamente.

Preencha a descrio dos itens do servio faltando. A quantidade dos itens de servio devem ser maior que 0(zero). O valor unitrio dos itens de servio devem ser maior que 0(zero). O campo ValorServicos numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorDeducoes numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorPis numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorCofins numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorInss numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIr numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorCsll numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIssRetido numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIss numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo OutrasRetencoes numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 55 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E920

Campo de E920 informado incorretamente.

E921

Campo de E921 informado incorretamente.

E922

Campo de E922 informado incorretamente.

E923

Campo de E923 informado incorretamente.

E924

Campo de E924 informado incorretamente.

E925

Campo de E925 informado incorretamente.

E926

Campo de E926 informado incorretamente.

E927

Campo de E927 informado incorretamente.

E928

Campo de E928 informado incorretamente.

E929

Campo de E929 informado incorretamente.

E930

Campo de E930 informado incorretamente.

E931

Campo de E931 informado incorretamente.

E932

Campo de E932 informado incorretamente.

E933

Campo de E933 informado incorretamente.

E934

Campo de E934 informado incorretamente.

E935

Campo de E935 informado incorretamente.

E936

Campo de E936 informado incorretamente.

E937

Campo de E937 informado incorretamente.

O campo BaseCalculo numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo Aliquota numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorLiquidoNfse numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo DescontoCondicionado numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo DescontoIncondicionado numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorDeducoes numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorPis numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorCofins numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorInss numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIr numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorCsll numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIssRetido numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorIss numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo OutrasRetencoes numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo BaseCalculo numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo ValorLiquidoNfse numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo DescontoCondicionado numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. O campo DescontoIncondicionado numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 56 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E938

Campo de E938 informado incorretamente.

E939 E940

O valor de BaseCalculo declarado no est correto. O valor de ValorLiquidoNfse declarado no est correto.

E941 E942 E943 E944 E945

E946 E947 E948 E949 E950 E951

O valor de alquota declarado no est correto. O ValorIss declarado no est correto. O ValorIss declarado diferente do ValorIssRetido retido para IssRetido = 1. Tipo invlido para Identificao do tipo de documento do Tomador. O campo CPF/CNPJ do intermedirio do servio dever ser preenchido com zeros quando for de CPF no-informado. O intermedirio do servio informado o prprio prestador. Este servio tem reteno obrigatria. Esse Rps j foi substitudo. Esse Rps j est cancelado. Campo nmero da Nfs-e substituda informado incorretamente. Arquivo enviado fora do layout de arquivo de entrada (pode estar faltando o preechimento de um campo obrigatrio). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.DataEmissao). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.IdentificacaoRps). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.IdentificacaoRps.Numero). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.IdentificacaoRps.Serie). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico). Arquivo enviado fora da estrutura do arquivo

O campo Aliquota numrico e dever ter tamanho mximo de 15,2 ou seja, 15 nmero inteiros e 2 decimais. Valor correto: BaseCalculo = ValorServico (ValorDeducoes + DescontoIncondicionado). O clculo para ValorLiquidoNfse : ValorLiquidoNfse = ValorServico - (ValorPis + ValorCofins + ValorInss + ValorIr + ValorCsll + OutrasRetencoes + ValorIssRetido + DescontoIncondicionado + DescontoCondicionado). Consulte a legislao vigente para saber o valor correto. Verifique os dados. O ValorIss deve ser igual ao ValorIssRetido para IssRetido = 1. Tipos aceitos [Cpf|Cnpj]. Preencher o campo CPF/CNPJ do intermedirio do servio com zeros quando se tratar de tomador com CPF no informado. Na emisso da NFS-e no permitido que o prestador seja igual ao intermedirio do servio. Altere o campo 'ISS Retido'para 1 (Nota Fiscal com ISS Retido). Confira e informe novamente os dados do Rps que deseja substituir. Confira e informe novamente os dados do Rps que deseja cancelar. O campo nmero da Nfs-e substituda nmerico e dever ter tamanho mximo de 15 dgitos. Envie um arquivo dentro do layout de arquivo de entrada (verifique se todos os campos obrigatrios esto preenchidos). Inclua no arquivo o campo obrigatrio (ListaRps).

E952

E953

Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.DataEmissao). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.IdentificacaoRps). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.IdentificacaoRps.Numero). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.IdentificacaoRps.Serie). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Servico). Inclua no arquivo o campo obrigatrio

E954

E955

E956

E957

E958

E959

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 57 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E960

E961

E962

E963

E964

E965

E966

E967

E968

E969

E970

E971

E972 E973 E974 E975

XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico.ItemListaServico). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico.Discriminacao). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico.Valores). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico.ItensServico). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Servico.ItensServico[].Descr icao). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Prestador). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Prestador.Cnpj). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Prestador.InscricaoMunicipa l). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Tomador). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Tomador.IdentificacaoToma dor). Arquivo enviado fora da estrutura do arquivo XML de entrada - campo obrigatrio faltando (ListaRps[].InfRps.Tomador.IdentificacaoToma dor.CpfCnpj). Existe alguma descricao de item de servio muito grande. Tamanho mximo 100 caracteres. Existe mais de uma srie de Nfs-e definida para uso com o web service para este contribuinte. No existe nenhuma srie de Nfs-e definida para uso com o web service. O servio {0} no est mais disponvel. No existe nenhuma srie de Nfs-e liberada para ser usada com o web service. A data de emisso do RPS ou da Nfs-e no poder ser superior data limite autorizada para a emisso da Nfs-e. A numerao da Nfs-e a ser gerada ultrapassar a numerao limite autorizada pela prefeitura para a emisso de Nfs-e. Existe mais de uma srie de Nfs-e liberada para ser usada com o web service o que no

(ListaRps[].InfRps.Servico.ItemListaServico). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Servico.Discriminacao). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Servico.Valores). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Servico.ItensServico). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Servico.ItensServico[].Descrica o). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Prestador). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Prestador.Cnpj). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Prestador.InscricaoMunicipal).

Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Tomador). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Tomador.IdentificacaoTomador ). Inclua no arquivo o campo obrigatrio (ListaRps[].InfRps.Tomador.IdentificacaoTomador .CpfCnpj). Verifique o tamanho das descries de itens de servio. Entre em contato com a prefeitura para mais informaes. Entre em contato com a prefeitura para mais informaes. Entre em contato com o fornecedor do servio para mais informaes. Entre em contato com a prefeitura para mais informaes. Entre em contato com a prefeitura para mais informaes. Entre em contato com a prefeitura para mais informaes. Entre em contato com a prefeitura para mais informaes.

E976

E977

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 58 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

E978 E979 E980

E981

E982 E983 E984 E985 E986 E987 E988 E989 E990

permitido. Nota Fiscal sem valor de ISS no pode ter ISS Retido. Campo Valor do ISS Retido deve ser 0.0 para ISS No Retido. O somatrio das dedues e do desconto incondicionado est maior que o valor dos servios. A somatria dos descontos, retenes federais e ISSQN retido na fonte est maior que o valor dos servios. Cdigo de tributao no permite desconto condicionado. Cdigo de tributao no permite desconto incondicionado. Campo Outras Informaes informado Incorretamente. Campo Inscrio Estadual do tomador informado incorretamente. No pode ser cancelada a Nfs-e do Livro do Prestador. J existe guia vinculada. No pode ser cancelada a Nfs-e do Livro do Tomador. J existe guia vinculada. No permitido o envio de RPS com data de emisso inferior dez dias da data atual. Campo de Optante pelo Simples Nacional no confere com o cadastro da Prefeitura. Opo Simples Nacional conflita com o Regime Especial de Tributao informado. O Regime Especial de Tributao Microempresrio Individual (MEI) no permite reteno de ISS. A quantidade de itens de servio informada excede o nmero mximo permitido. O cdigo de tributao informado difere do registrado na Prefeitura. O cdigo de CNAE informado difere do registrado na Prefeitura.

Altere o campo ISS Retido para 2 (Nota Fiscal sem ISS Retido) Altere o campo Valor do ISS Retido para 0.0. O preo do servio deve ser maior ou igual soma das dedues com o desconto incondicionado. O preo do servio deve ser maior ou igual soma dos tributos federais, o ISSQN devido e os descontos. O tipo de servio prestado no permite desconto condicionado. O tipo de servio prestado no permite desconto incondicionado. O campo Outras Informaes alfanumrico e dever Ter tamanho mximo de 255 caracteres. O campo Inscrio Municipal do tomador dever ter tamanho mximo de 20 caracteres. Primeiro entre em contato com a Prefeitura e solicite o cancelamento da guia. Primeiro entre em contato com a Prefeitura e solicite o cancelamento da guia. Informe a data de emisso que esteja dentro do perodo autorizado. Verifique no site, Configuraes do Prestador, a opo correta. Apenas podem ser Optantes pelo Simples Nacional empresas enquadradas nos Regimes: 5 - MEI; 6 - ME EPP ou 8 - FIXO. Altere o campo ISS Retido para 2.

E991

E992 E993 E994

A quantidade dos itens de servio no deve ser maior que 15 (quinze). Procure a Prefeitura para atualizar o cdigo de tributao no cadastro do contribuinte. Procure a Prefeitura para atualizar o cdigo de CNAE no cadastro do contribuinte.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 59 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

5.

VERSES DO MANUAL
5.1. ATUALIZAES

Verso 1.01 17/01/2011 Incluso da tabela tcItemServico: Tabela que descreve a lista de servios, quantidade de itens e valor de cada servio. Incluso das tabelas tcInfNovaNfse, tcIdentNovaNfse e tcRepostaIdentNovaNfse: Conjunto de tabelas que compem o servio Gerar Nfs-e.

Incluso do servio Gerar Nfs-e: Servio utilizado para a emisso de uma nica Nfs-e por vez, no comportando envio de lote nem processamento de RPS. Item 3.5.8 do manual. Verso 1.02 11/05/2011 Alterao do campo tsIndicacaoCpfCnpj: CPF 1; CNPJ 2; No Informado 3.

Alterao da tabela tcInfNovaNfse: Foram adicionados os campos: Id, NaturezaOperacao, RegimeEspecialTributacao, OptanteSimplesNacional, IncentivadorCultural, Status, Competencia,

NfseSubstituida, OutrasInformacoes e IntermediarioServico. Incluso do servio Versao: Servio utilizado para verificar a conectividade entre o sistema do contribuinte e o sistema web service. Verso 1.03 30/06/2011 Correo da tabela tcDadosServico: Remoo dos campos Descricao, Quantidade e ValorUnitario, que causavam duplicidade de dados com os da tabela tcItemServico. Verso 1.04 23/02/2012 Incluso do campo OutrasInformacoes na tabela tcInfRps: Campo usado para agregar informaes adicionais ao documento.
Pgina 60 de 62

Nota Fiscal de Servios Eletrnica - NFSE

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Incluso de mensagens personalizadas: Adicionado mensagens de erros. Da mensagem E950 at a mensagem E978, que dizem respeito estrutura do arquivo XML, srie e data de autorizao para a emisso de RPS. Incluso do Item 2.4. Ambiente de Homologao: Disponibilizao dos links de Cadastro e de Homologao. Verso 1.05 17/07/2012 Incluso de novas mensagens personalizadas. Item 4.3 do manual. E979, E980, E981, E982, E983 e E984. Verso 1.06 20/08/2012 Alterado exemplo de formato de valores percentuais, Item 3.2. Incluso de novo campo na tabela tipo simples, Item 3.3: tsInscricaoEstadual.

Incluso do campo tipo simples na tabela tipo complexo tcIdentificacaoTomador, Item 3.4: InscricaoEstadual. Para utilizar este novo campo, tem que refazer a referncia do link de conexo entre aplicao cliente e web services. Adicionado opes de motivo de cancelamento no campo tsCodigoCancelamentoNfse, Item 3.3. Alterao do campo tsTelefone de 11 para 15 caracteres. Atualizada mensagem de erro E127, Item 4.1. Adio de novas Mensagens Personalizadas no item 4.3. do manual. E985, E986, E987, E988, E989, E990, E991. Verso 1.07 20/09/2012 Adio de novas Mensagens Personalizadas no item 4.3. do manual. E992.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 61 de 62

Manual de Utilizao do Web Service


Verso: 1.09

Revisado em: 7/11/2012 Verso da ABRASF: 1.00

Verso 1.08 03/10/2012 Alterao da Mensagem Personalizada no item 4.3. do manual. E992. Verso 1.09 07/10/2012 Adio de novas Mensagens Personalizadas no item 4.3. do manual. E993, E994.

Nota Fiscal de Servios Eletrnica - NFSE

Pgina 62 de 62

Вам также может понравиться