manual webservice nfse
Post on 13-Oct-2015
250 Views
Preview:
DESCRIPTION
TRANSCRIPT
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 1 de 62
Nota Fiscal de Servios Eletrnica - NFSE
NOTA FISCAL DE SERVIOS ELETRNICA NFSE
Manual de Utilizao do Web Service
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 2 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Sumrio 1. INTRODUO ............................................................................................................ 4
1.1. NOTA FISCAL DE SERVIOS ELETRNICA - NFS-E....................................... 4
1.2. RECIBO PROVISRIO DE SERVIO RPS ..................................................... 4
2. 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. AMBIENTE DE HOMOLOGAO ..................................................................... 17
3. 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. FORMATOS E PADRES UTILIZADOS ........................................................... 21
3.3. TIPOS SIMPLES ................................................................................................ 23
3.4. TIPOS COMPLEXOS ......................................................................................... 25
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 3 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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. TABELA DE ERROS .......................................................................................... 48
4.2. TABELA DE ALERTAS ...................................................................................... 54
4.3. TABELA DE MENSAGENS PERSONALIZADAS .............................................. 55
5. VERSES DO MANUAL .......................................................................................... 60
5.1. ATUALIZAES ................................................................................................ 60
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 4 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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 NFS-
e 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 tornar-
se indisponvel.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 5 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 6 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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).
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 7 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 8 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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).
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 9 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 10 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 11 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 12 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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:
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 13 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Deve-se evitar o uso das TAGs abaixo, pois as informaes sero obtidas a partir
do Certificado do emitente:
O Projeto NFS-e utiliza um subconjunto do padro de assinatura XML definido pelo
http://www.w3.org/TR/xmldsig-core/, que tem o seguinte leiaute:
# CAMPO ELEMENTO PAI TIPO DESCRIO OC. XS01 Signature Raiz XS02 Id A XS01 C 1-1 XS03 SignedInfo G XS01 Grupo da Informao da
assinatura 1-1
XS04 CanonicalizationMethod
G XS03 Grupo do Mtodo de Canonicalizao
1-1
XS05 Algorithm A XS04 C Atributo Algorithm de CanonicalizationMethod: http://www.w3.org/TR/2001/REC-xml-c14n- 20010315
1-1
XS06 SignatureMethod G XS03 Grupo do Mtodo de Assinatura
1-1
XS07 Algorithm A XS06 C Atributo Algorithm de SignedInfo: http://www.w3.org/2000/09/xmldsig#rsa-sha1
1-1
XS08 Reference G XS03 Grupo do Mtodo de Reference
1-1
XS09 URI A XS08 C Atributo URI da tag Reference 1-1 XS10 Transforms G XS08 Grupo do algorithm de
Transform 1-1
XS11 Unique_Transf_Alg
RC XS10 Regra para o atributo Algorithm do Transform ser nico
1-1
XS12 Transform G XS10 Grupo de Transform 2-2 XS13 Algorithm A XS12 C Atributos vlidos Algorithm do
Transform: http://www.w3.org/TR/2001/REC-xml-c14n-20010315 http://www.w3.org/2000/09/xmldsig#envelopedsignature
1-1
XS14 Xpath E XS12 C Xpath 0-N
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 14 de 62
Nota Fiscal de Servios Eletrnica - NFSE
XS15 DigestMethod G XS08 Grupo do Mtodo de DigestMethod
1-1
XS16 Algorithm A XS15 C Atributo Algorithm de DigestMethod: http://www.w3.org/2000/09/xmldsig#sha1
1-1
XS17 DigestValue E XS08 C Digest Value (Hash SHA-1 Base64)
1-1
XS18 SignatureValue G XS01 Grupo do Signature Value 1-1 XS19 KeyInfo G XS01 Grupo do KeyInfo 1-1 XS20 X509Data G XS19 Grupo X509 1-1 XS21 X509Certificate E XS20 C Certificado Digital x509 em
Base64b 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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 15 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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;
2.3. PADRO DAS MENSAGENS XML
A especificao adotada para as mensagens XML a recomendao W3C para
XML 1.0, disponvel em www.w3.org/TR/REC-xml e a codificao dos caracteres ser em
UTF-8.
As chamadas dos Web Services disponibilizados 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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 16 de 62
Nota Fiscal de Servios Eletrnica - NFSE
1 cabealho G TAG raiz do cabealho da mensagem.
1-1
verso A 1 N 4 Verso do leiaute. 1-1 2 versaoDados E 1 N 4 O contedo deste campo indica a
verso do leiaute XML da estrutura XML informada na rea de dados da mensagem.
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 17 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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:
_v.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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 18 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 19 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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 IMPLEMENTAO Recepo e Processamento de Lote de RPS Assncrona Consulta de Situao de Lote de RPS Sncrona Consulta de NFS-e por RPS Sncrona Consulta de Lote de RPS Sncrona Consulta de NFS-e Sncrona Cancelamento de NFS-e 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:
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 20 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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;
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 21 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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 OBSERVAO Data (date) Formato: AAAA-MM-DD
onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres
Data/Hora (datetime) Formato AAAA-MM-DDTHH:mm:ss onde: AAAA = ano com 4 caracteres MM = ms com 2 caracteres DD = dia com 2 caracteres T = caractere de formatao que deve existir separando a data da hora HH = hora com 2 caracteres
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 22 de 62
Nota Fiscal de Servios Eletrnica - NFSE
mm: minuto com 2 caracteres ss: segundo com 2 caracteres
Valores Decimais (decimal)
Formato: 0.00 No deve ser utilizado separador de milhar. O ponto (.) deve ser utilizado para separar a parte inteira da fracionria. Exemplo: 48.562,25 = 48562.25 1,00 = 1.00 ou 1 0,50 = 0.50 ou 0.5
Valores Percentuais (decimal)
Formato 00.00 O formato em percentual presume o valor percentual em sua forma fracionria, contendo 5 dgitos. O ponto (.) separa a parte inteira da fracionria. Exemplo: 62% = 62.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 (contedo).
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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 23 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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 TIPO TAM. DESCRIO tsNumeroNfse N 15 Nmero da Nota Fiscal de Servio Eletrnica,
formado pelo ano com 04 (quatro) dgitos e um nmero sequencial com 11 posies Formato AAAANNNNNNNNNNN
tsCodigoVerificacao C 9 Cdigo de verificao do nmero da nota tsStatusRps N 1 Cdigo de status do RPS
1 Normal 2 Cancelado
tsStatusNfse N 1 Cdigo de status da NFS-e 1 Normal 2 Cancelado
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 24 de 62
Nota Fiscal de Servios Eletrnica - NFSE
tsNaturezaOperacao 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
tsRegimeEspecialTributacao 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)
tsSimNao N 1 Identificao de Sim/No 1 Sim 2 No
tsQuantidadeRps N 4 Quantidade de RPS do Lote tsNumeroRps N 15 Nmero do RPS tsSerieRps C 5 Nmero de srie do RPS tsTipoRps N 1 Cdigo de tipo de RPS
1 RPS 2 Nota Fiscal Conjugada (Mista) 3 Cupom
tsOutrasInformacoes C 255 Informaes adicionais ao documento tsValor N 15,2 Valor monetrio.
Formato: 0,000.00 (ponto separando casa decimal, vrgula separando casa do milhar)
tsItemListaServico C 5 Cdigo de item da lista de servio tsCodigoCnae N 7 Cdigo CNAE tsCodigoTributacao C 20 Cdigo de Tributao tsAliquota N 5,4 Valor percentual tsDiscriminacao C 200 Discriminao do contedo da NFS-e tsCodigoMunicipioIbge N 7 Cdigo de identificao do municpio conforme tabela do
IBGE. Caso seja de fora do pas, colocar 99999. tsIncricaoMunicipal C 15 Nmero de inscrio municipal tsInscricaoEstadual C 20 Nmero de Inscrio Estadual tsRazaoSocial C 115 Razo Social do contribuinte tsNomeFantasia C 115 Nome fantasia do contribuinte tsCnpj C 14 CNPJ do contribuinte tsEndereco C 125 Endereo do contribuinte tsNumeroEndereco C 10 Nmero do endereo tsComplementoEndereco C 60 Complemento de endereo tsBairro C 60 Bairro do contribuinte tsUf C 2 Sigla da unidade federativa. Caso seja de fora do pas,
colocar EX. tsCep N 8 Nmero do CEP do contribuinte tsEmail C 80 E-mail do contribuinte tsTelefone C 15 Telefone do contribuinte tsCpf C 11 CPF do contribuinte tsIndicacaoCpfCnpj N 1 Indicador de uso de CPF ou CNPJ
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 25 de 62
Nota Fiscal de Servios Eletrnica - NFSE
1 CPF 2 CNPJ 3 No Informado
tsCodigoObra C 15 Cdigo de Obra tsArt C 15 Cdigo ART tsNumeroLote N 15 Nmero do Lote de RPS tsNumeroProtocolo C 50 Nmero do protocolo de recebimento do RPS tsSituacaoLoteRps N 1 Cdigo de situao de lote de RPS
1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso
tsCodigoMensagemAlerta C 4 Cdigo de mensagem de retorno de servio tsDescricaoMensagemAlerta C 200 Descrio da mensagem de retorno de servio tsCodigoCancelamentoNfse C 4 Motivo do Cancelamento da NFS-e
1 Lanamento Indevido 2 Erro de digitao
tsIdTag C 255 Atributo de identificao da tag a ser assinada no documento XML
P1 C 14 CNPJ do contribuinte, apenas nmero. P2 C 20 Senha do contribuinte tsLink C 200 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: (1) (2)
CAMPO TIPO TAM. DESCRIO OC. (3) (4) (5) (6) (7) (8)
(4) (5) (6) (7) (8)
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
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 26 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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
tcCpfCnpj Representa CPF/CNPJ. CAMPO TIPO TAM. DESCRIO OC.
Choice Cpf C 11 Nmero do Cpf. 1-1 Cnpj C 14 Nmero do Cnpj. 1-1
tcEndereco Conjunto de dados de identificao completa do endereo.
CAMPO TIPO TAM. DESCRIO OC. Endereco C 125 Endereo. 0-1 Numero C 10 Nmero do endereo. 0-1 Complemento C 60 Complemento do Endereo. 0-1 Bairro C 60 Nome do bairro. 0-1 CodigoMunicipio N 7 Cdigo de identificao do municpio conforme tabela do
IBGE. 0-1
Uf C 2 Sigla da unidade federativa. 0-1 Cep C 8 Nmero do CEP. 0-1
tcContato Representa forma de contato com a pessoa (fsica/jurdica). CAMPO TIPO TAM. DESCRIO OC. Telefone C 11 Telefone para contato. 0-1 Email C 80 E-mail para contato. 0-1
tcIdentificacaoOrgaoGerador Conjunto de dados de identificao de rgo gerador. CAMPO TIPO TAM. DESCRIO OC. CodigoMunicipio N 7 Cdigo de identificao do municpio conforme tabela do
IBGE. 1-1
Uf C 2 Sigla da unidade federativa. 1-1
tcIdentificacaoRps Conjunto de dados de identificao do RPS. CAMPO TIPO TAM. DESCRIO OC. Numero N 15 Nmero do RPS. 1-1 Serie C 5 Nmero de srie do RPS. 1-1 Tipo N 1 Cdigo de tipo de RPS.
1 RPS 2 Nota Fiscal Conjugada (Mista) 3 Cupom
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
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 27 de 62
Nota Fiscal de Servios Eletrnica - NFSE
tcIdentificacaoTomador Conjunto de dados de identificao do tomador de servio. CAMPO TIPO TAM. DESCRIO OC. CpfCnpj tcCpfCnpj Caso Tomador no identificado, preencher com 11
zeros. 1-1
InscricaoMunicipal C 15 Nmero de Inscrio Municipal do tomador. 0-1 InscricaoEstadual C 20 Nmero de Inscrio Estadual do tomador. 0-1
tcDadosTomador Conjunto de dados do tomador de servio. CAMPO TIPO TAM. DESCRIO OC. IdentificacaoTomador tcIdentificacaoTomador Conjunto de dados de identificao do
tomador de servio. 1-1
RazaoSocial C 115 Razo Social do tomador. 0-1 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.
0-1
Contato tcContato Representa forma de contato com a pessoa (fsica/jurdica).
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.
CAMPO TIPO TAM. DESCRIO OC. ValorServicos N 15,2 Valor dos servios em R$. 1-1 ValorDeducoes N 15,2 Valor das dedues para Reduo da Base de Clculo
em R$. 0-1
ValorPis N 15,2 Valor da reteno do PIS em R$. Informao declaratria.
0-1
ValorCofins N 15,2 Valor da reteno do COFINS em R$. Informao declaratria.
0-1
ValorInss N 15,2 Valor da reteno do INSS em R$. Informao declaratria.
0-1
ValorIr N 15,2 Valor da reteno do IR em R$. Informao declaratria.
0-1
ValorCsll N 15,2 Valor da reteno do CSLL em R$. Informao declaratria.
0-1
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.
1-1
ValorIss N 15,2 Valor do ISS. 0-1 OutrasRetencoes N 15,2 Valor de outras retenes. 0-1 BaseCalculo N 15,2 (Valor dos servios Valor das dedues descontos
incondicionados). 0-1
Aliquota N 15,2 Valor percentual. 0-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 28 de 62
Nota Fiscal de Servios Eletrnica - NFSE
ValorLiquidoNfse N 15,2 (ValorServicos ValorPIS ValorCOFINS ValorINSS ValorIR ValorCSLL utrasRetenoes ValorISSRetido - DescontoIncondicionado - DescontoCondicionado).
0-1
ValorIssRetido N 15,2 Valor do ISS Retido. 0-1 DescontoCondicionado N 15,2 Valor do Desconto Condicionado. 0-1 DescontoIncondicionado N 15,2 Valor do Desconto Incondicionado. 0-1
tcDadosServico Conjunto de dados que compe o servio prestado. CAMPO TIPO TAM. DESCRIO OC. Valores tcValores Conjunto de valores que compe o
documento fiscal. 1-1
ItemListaServico C 5 Cdigo de item da lista de servio. 1-1 CodigoCnae N 7 Cdigo CNAE. 0-1 CodigoTributacaoMunicipio C 20 Cdigo de Tributao. 1-1 Discriminacao C 200 Discriminao do contedo da NFS-e. 1-1 CodigoMunicipio N 7 Cdigo de identificao do municpio
conforme tabela do IBGE. Preencher com 5 noves para servio prestado no exterior.
1-1
ItensServico tcItemServico 1-N
tcDadosConstrucaoCivil Conjunto de dados para identificao de construo civil. CAMPO TIPO TAM. DESCRIO OC. CodigoObra C 15 Cdigo de Obra. 1-1 Art C 15 Cdigo ART. 1-1
tcDadosPrestador Conjunto de dados do prestador do servio.
CAMPO TIPO TAM. DESCRIO OC. IdentificacaoPrestador tcIdentificacao
Prestador Conjunto de dados de identificao do prestador
de servio. 1-1
RazaoSocial C 115 Razo Social do prestador. 1-1 NomeFantasia C 115 Nome Fantasia do prestador. 0-1 Endereco tcEndereco Conjunto de dados de identificao completa do
endereo. 1-1
Contato tcContato Representa forma de contato com a pessoa (fsica/jurdica).
0-1
tcInfRps Conjunto de dados informativos do Recibo Provisrio de Servio (RPS). CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser
assinada no documento XML.
IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificao do RPS.
1-1
DataEmissao D Data da Emisso. Formato AAAA-MM-DDTHH:mm:ss
1-1
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
1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 29 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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)
0-1
OptanteSimplesNacional N 1 Identificao de Sim/No 1 Sim; 2 No
1-1
IncentivadorCultural N 1 Identificao de Sim/No 1 Sim; 2 No
1-1
Status N 1 Cdigo de status do RPS 1 Normal; 2 Cancelado
1-1
RpsSubstituido tcIdentificacaoRps Conjunto de dados de identificao do RPS.
0-1
OutrasInformacoes C 255 Informaes Adicionais ao Documento.
0-1
Servico tcDadosServico Conjunto de dados que compe o servio prestado.
1-1
Prestador tcIdentificacaoPrestador
Conjunto de dados de identificao do prestador de servio.
1-1
Tomador tcDadosTomador Conjunto de dados do tomador de servio.
1-1
IntermediarioServico tcIdentificacaoIntermediarioServico
Conjunto de dados de identificao do intermedirio do servio.
0-1
ConstrucaoCivil tcDadosContrucaoCivil
Conjunto de dados para identificao de construo civil.
0-1
tcRps Representa a estrutura do Recibo Provisrio de Servio (RPS) assinada. CAMPO TIPO TAM. DESCRIO OC. InfRps tcInfRps Conjunto de dados informativos do Recibo
Provisrio de Servio (RPS). 1-1
Signature dsig:Signature 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 -
Formato AAAANNNNNNNNNNN. 1-1
Cnpj C 14 CNPJ. 1-1 InscricaoMunicipal C 15 Nmero de inscrio municipal. 0-1 CodigoMunicipio N 7 Cdigo de identificao do municpio conforme
tabela do IBGE. 1-1
tcInfNfse Representa os dados informativos da Nota Fiscal de Servios Eletrnica. CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser
assinada no documento XML. 1-1
Numero N 15 Nmero da Nota Fiscal de Servio Eletrnica - Formato AAAANNNNNNNNNNN.
1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 30 de 62
Nota Fiscal de Servios Eletrnica - NFSE
CodigoVerificacao C 9 Cdigo de verificao do nmero da nota.
1-1
DataEmissao D Data e Hora da Emisso. Formato AAAA-MM-DDTHH:mm:ss
0-1
IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificao do RPS.
0-1
DataEmissaoRps D Data da Emisso do RPS. Formato: AAAA-MM-DD
1-1
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
0-1
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)
1-1
OptanteSimplesNacional N 1 Identificao de Sim/No 1 Sim 2 No
1-1
IncetivadorCultural N 1 Identificao de Sim/No 1 Sim 2 No
1-1
Competencia D Formato: AAAA-MM-DD 0-1 NfseSubstituida N 15 Nmero da Nota Fiscal de Servio
Eletrnica - Formato AAAANNNNNNNNNNN.
1-1
Servico tcDadosServico Conjunto de dados que compe o servio prestado.
0-1
ValorCredito N 15,2 Valor monetrio. Formato: 0,000.00 (ponto separando casa decimal, vrgula separando casa do milhar)
1-1
PrestadorServico tcDadosPrestador Conjunto de dados do prestador do servio.
1-1
TomadorServico tcDadosTomador Conjunto de dados do tomador de servio.
0-1
IntermediarioServico tcIdentificacaoIntermediarioServico
Conjunto de dados de identificao do intermedirio do servio.
1-1
OrgaoGerador tcIdentificacaoOrgaoGerador
Conjunto de dados de identificao de rgo gerador.
0-1
ConstrucaoCivil tcDadosContrucaoCivil
Conjunto de dados para identificao de construo civil.
1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 31 de 62
Nota Fiscal de Servios Eletrnica - NFSE
tcNfse Representa a estrutura da Nota Fiscal de Servios Eletrnica assinada. CAMPO TIPO TAM. DESCRIO OC. InfNfse tcInfNfse Representa os dados informativos da Nota Fiscal
de Servios Eletrnica. 1-1
Signature Dsig:Signature 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 Nota Fiscal de Servios Eletrnica.
1-1
CodigoCancelamento C 4 Cdigo de cancelamento com base na tabela de Erros e alertas.
0-1
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
Nota Fiscal de Servios Eletrnica. 1-1
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 OC. Sucesso boolean Sucesso da operao. 1-1 DataHora D Data e hora.
Formato AAAA-MM-DDTHH:mm:ss 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 tcPedidoCancelamento
Representa a estrutura de Pedido de Cancelamento da Nota Fiscal de Servios Eletrnica assinada.
1-1
InfConfirmacaoCancelamento tcInfConfirmacaoCancelamento
Representa a estrutura de dados da confirmao de cancelamento da Nota Fiscal de Servios Eletrnica feito pelo Fisco Municipal.
1-1
tcCancelamentoNfse Representa os dados de registro de substituio de NFS-e.
CAMPO TIPO TAM. DESCRIO OC. Confirmacao tcConfirmacaoCance
lamento Representa a estrutura de
Confirmao de Cancelamento da Nota Fiscal de Servios Eletrnica assinada.
Signature Dsig:Signature 1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 32 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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 - Formato AAAANNNNNNNNNNN.
1-1
tcSubstituicaoNfse Representa a estrutura de substituio de NFS-e. CAMPO TIPO TAM. DESCRIO OC. SubstituicaoNfse tcInfSubstituicaoNfse Representa a estrutura completa
(pedido + confirmao) de cancelamento de NFS-e.
1-1
Signature dsig:Signature 1-2
tcCompNfse Representa a estrutura de compartilhamento de dados de uma NFS-e. CAMPO TIPO TAM. DESCRIO OC. Nfse tcNfse Representa a estrutura da Nota Fiscal de
Servios Eletrnica assinada. 1-1
NfseCancelamento tcCancelamentoNfse Representa os dados de registro de substituio de NFS-e.
0-1
NfseSubstituicao tcSubstituicaoNfse Representa a estrutura de substituio de NFS-e.
0-1
ListaMensagemRetorno Representa a estrutura de mensagem de retorno de servio. CAMPO TIPO TAM. DESCRIO OC. MensagemRetorno tcMensagemRetorno Representa a estrutura de mensagem de
retorno de servio. 1-N
tcMensagemRetornoLote Representa a estrutura de mensagem de retorno de servio. CAMPO TIPO TAM. DESCRIO OC. IdentificacaoRps tcIdentificacaoRps Conjunto de dados de identificao
do RPS. 1-1
Codigo C 4 Cdigo de mensagem de retorno de servio.
1-1
Mensagem C 200 Descrio da mensagem de retorno de servio.
1-1
tcLoteRps Conjunto de dados para a identificao do Lote RPS.
CAMPO TIPO TAM. DESCRIO OC. Id C 255 Atributo de identificao da tag a ser assinada no
documento XML.
NumeroLote N 15 Nmero do Lote de RPS. 1-1 Cnpj C 14 CNPJ do contribuinte. 1-1 InscricaoMunicipal C 15 Nmero de Inscrio Municipal. 1-1 QuantidadeRps N 4 Quantidade de RPS do Lote. 1-1 ListaRps tcRps Representa a estrutura do Recibo Provisrio de
Servio (RPS) assinada. 1-N
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 33 de 62
Nota Fiscal de Servios Eletrnica - NFSE
tcItemServico CAMPO TIPO TAM. DESCRIO OC. Descricao C 200 Descrio do servio. 1-1 Quantidade N 7 Quantidade de itens. 1-1 ValorUnitario N 15,2 Valor unitrio de cada servio. 1-1
ddDuasStrings CAMPO TIPO TAM. DESCRIO OC. P1 P1 14 CNPJ do contribuinte, apenas nmeros. 1-1 P2 P2 20 Senha do contribuinte. 1-1
tcInfNovaNfse Conjunto de dados de descrio da NFS-e CAMPO TIPO TAM. DESCRIO OC. Id 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
1-1
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)
0-1
OptanteSimplesNacional N 1 Identificao de Sim/No 1 Sim 2 No
1-1
IncetivadorCultural N 1 Identificao de Sim/No 1 Sim 2 No
1-1
Status N 1 Cdigo de status da NFS-e 1 Normal 2 Cancelado
1-1
Competencia D Formato: AAAA-MM-DD 1-1 NfseSubstituida N 15 Nmero da Nota Fiscal de
Servio Eletrnica - Formato AAAANNNNNNNNNNN.
0-1
OutrasInformacoes C 255 Informaes adicionais ao documento.
0-1
Servico tcDadosServico Conjunto de dados que compe o servio prestado.
1-1
Tomador tcDadosTomador Conjunto de dados do tomador de servio.
1-1
IntermediarioServico tcIdentificacaoIntermedi Conjunto de dados de 0-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 34 de 62
Nota Fiscal de Servios Eletrnica - NFSE
arioServico identificao do intermedirio do servio.
ConstrucaoCivil tcDadosConstrucaoCivil Conjunto de dados para identificao de construo civil.
0-1
tcIdentNovaNfse Identificao da NFS-e
CAMPO TIPO TAM. DESCRIO OC. IdentificacaoPrestador tcIdentificacaoPrestador Conjunto de dados de identificao
do prestador de servio. 1-1
Numero N 15 Nmero da NFS-e. 1-1 Serie C 5 Nmero de srie da nota. 1-1 CodigoVerificacao C 9 Cdigo de verificao do nmero
da nota. 1-1
DataEmissao D Data da Emisso. Formato AAAA-MM-DDTHH:mm:ss
1-1
Link C 200 Disponibilizado para a impresso da NFS-e.
0-1
tcRespostaIdentNovaNfse - Representa a estrutura de mensagem de retorno da NFS-e
CAMPO TIPO TAM. DESCRIO OC. IdentificacaoNfse tcIdentNovaNfse Identificao da NFS-e 1-1 Signature dsig:Signature 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: # NOME TIPO PAI DESCRIO OC.
(1) (2) (3) (4) (5) (6) (7) (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:
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 35 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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. # CAMPO TIPO PAI DESCRIO OC. 1 EnviarLoteRpsEnvio 1-1 LoteRps tcLoteRps 1 Conjunto de dados para a identificao do
Lote RPS. 1-1
Signature dsig:Signature 1 0-1 2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 36 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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. # CAMPO TIPO PAI DESCRIO OC. 1 EnviarLoteRps
Resposta 1-1
NumeroLote N 1 Nmero da Nota Fiscal de Servio Eletrnica - Formato AAAANNNNNNNNNNN.
Choice 1-1
DataRecebimento
D 1 Data e hora. Formato AAAA-MM-DDTHH:mm:ss
Protocolo C 1 Nmero do protocolo de recebimento do
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 37 de 62
Nota Fiscal de Servios Eletrnica - NFSE
RPS. 2 ListaMensage
mRetorno ListaMensagemRetorno
1 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. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarSituacaoLoteRpsEnvio 1-1 Prestador tcIdentificacao
Prestador 1 Conjunto de dados de identificao
do prestador de servio. 1-1
Protocolo C 1 Nmero do protocolo de recebimento do RPS
1-1
2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia ) ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 38 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Utilizao do Mtodo
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarSituacaoLo
teRpsResposta 1-1
NumeroLote N 1 Nmero do Lote de RPS Choice 1-1 Situao N 1 Cdigo de situao de lote de RPS
1 No Recebido 2 No Processado 3 Processado com Erro 4 Processado com Sucesso
2 ListaMensagemRetorno
ListaMensagemRetorno
1 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.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 39 de 62
Nota Fiscal de Servios Eletrnica - NFSE
# CAMPO TIPO PAI DESCRIO OC. 1 ConsultarNfseRpsEnvio IdentificacaoRps tcIdentificacao
Rps 1 Conjunto de dados de identificao do
RPS. 1-1
Prestador tcIdentificacaoPrestador
1 Conjunto de dados de identificao do prestador de servio.
1-1
2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Utilizao do Mtodo
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarNfseRps
Resposta
CompNfse tcCompNfse 1 Representa a estrutura de compartilhamento de dados de uma NFS-e.
Choice 1-1
2 ListaMensagemRetorno
ListaMensagemRetorno
1 Representa a estrutura de mensagem de retorno de servio.
1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 40 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarNfseEnvio 1-1 Prestador tcIdentificacaoPrestador 1 Conjunto de dados de identificao
do prestador de servio. 1-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 41 de 62
Nota Fiscal de Servios Eletrnica - NFSE
NumeroNfse N 1 Nmero da Nota Fiscal de Servio Eletrnica - Formato AAAANNNNNNNNNNN.
0-1
2 PeriodoEmissao PeriodoEmissao 1 0-1 DataInicial D 1 Data inicial da consulta Nfse.
Formato: AAAA-MM-DD 1-1
DataFinal D 1 Data final da consulta Nfse. 1-1 Tomador tcIdentificacaoTomador 1 Conjunto de dados de identificao
do tomador de servio. 1-1
IntermediarioServico tcIdentificacaoIntermediarioServico
1 Conjunto de dados de identificao do intermedirio do servio.
0-1
2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia ) ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Utilizao do Mtodo
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 42 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarNfse
Resposta 1-1
2 ListaNfse 1 Choice 1-1 0-N CompNfse tcCompNfse 2 Representa a estrutura de
compartilhamento de dados de uma NFS-e. 3 ListaMensage
mRetorno ListaMensagemRetorno
1 Representa a estrutura de mensagem de retorno de servio.
1-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. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarLoteRpsEnvio 1-1 Prestador tcIdentificacaoPrest
ador 1 Conjunto de dados de
identificao do prestador de servio.
1-1
Protocolo C 1 Nmero do protocolo de recebimento do RPS
1-1
2 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
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 43 de 62
Nota Fiscal de Servios Eletrnica - NFSE
RPS foram convertidos e especificado na propriedade
pConsultarNfseEnvio.PeriodoEmissao. Campos Tomador e IntermediarioServico so
opcionais na pesquisa se no houver notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia ) ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Utilizao do Mtodo
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 ConsultarLoteRps
Resposta 1-1
2 ListaNfse 1 Choice 1-1 CompNfse tcCompNfse 2 Representa a estrutura de
compartilhamento de dados de uma NFS-e.
1-N
3 ListaMensagemRetorno
ListaMensagemRetorno
1 Representa a estrutura de mensagem de retorno de servio.
1-1
Utilizao do Mtodo
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 44 de 62
Nota Fiscal de Servios Eletrnica - NFSE
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. # CAMPO TIPO PAI DESCRIO OC. 1 CancelarNfseEnvio 1-1 Pedido tcPedidoCancelamento 1 Representa a estrutura de Pedido
de Cancelamento da Nota Fiscal de Servios Eletrnica assinada.
1-1
2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia ) ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Utilizao do Mtodo
* Campos no obrigatrios.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 45 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 CancelarNfse
Resposta
Cancelamento tcCancelamentoNfse
1 Representa os dados de registro de substituio de NFS-e.
Choice 1-1
2 ListaMensagemRetorno
ListaMensagemRetorno
1 Representa a estrutura de mensagem de retorno de servio.
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. # CAMPO TIPO PAI DESCRIO OC. 1 GerarNovaNfseEnvio 1-1 2 Prestador tcIdentificacaoPrest
ador 1 Conjunto de dados de identificao do
prestador de servio. 1-1
2 InformacaoNfse tcInfNovaNfse 1 Conjunto de dados de descrio da NFS-e
1-1
Servico tcDadosServico 2 Conjunto de dados que compe o servio prestado.
1-1
Tomador tcDadosTomador 2 Conjunto de dados do tomador de servio.
1-1
IntermediarioServico tcIdentificacaoInter 2 Conjunto de dados de identificao do 0-1
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 46 de 62
Nota Fiscal de Servios Eletrnica - NFSE
mediarioServico intermedirio do servio. ConstrucaoCivil tcDadosContrucao
Civil 2 Conjunto de dados para identificao de
construo civil. 0-1
Signature dsig:Signature 1 0-1 2 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 notas. A propriedade
retConsultarNfseResposta.Item.CompNfse recebe null ( tag sem vazia )
ConsultarNfse(ConsultarNfseEnvio pConsultarNfseEnvio).
Utilizao do Mtodo
Inicialmente a Signature e Id no esto sendo usados, tendo como segundo
parmetro ddDuasStrings.
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 47 de 62
Nota Fiscal de Servios Eletrnica - NFSE
Em resposta a chamada do servio ser devolvida a estrutura definida na tabela a
seguir. # CAMPO TIPO PAI DESCRIO OC. 1 GerarNovaNfse
Resposta
NovaNfse tcRespostaIdentNovaNfse
1 Representa a estrutura de mensagem de retorno da NFS-e.
Choice 1-1
2 ListaMensagemRetorno
ListaMensagemRetorno
1 Representa a estrutura de mensagem de retorno de servio.
1-1
Utilizao do Mtodo
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 48 de 62
Nota Fiscal de Servios Eletrnica - NFSE
4. ANEXOS
4.1. TABELA DE ERROS
CD MENSAGEM SOLUO E1 Assinatura do Hash no confere. Reenvie assinatura do Hash conforme algoritmo
estabelecido no Manual de Instruo da NFS-e. E2 Ms de competncia superior ao de
emisso do RPS ou da Nota. Informe um ms de competncia inferior ou igual ao de emisso do RPS ou da Nota.
E3 Natureza da operao no informada. 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.
E4 Esse RPS no foi enviado para a nossa base de dados.
Envie o RPS para emisso da NFS-e.
E5 O nmero da NFS-E substituda informado no existe na base de dados do municpio.
Informe um nmero de NFS-E substituda que j tenha sido emitida.
E6 Essa NFS-e no pode ser cancelada atravs desse servio, pois h crdito Informado.
O cancelamento de uma NFS-e com crdito deve ser feito atravs de processo administrativo aberto em uma repartio fazendria.
E7 Essa NFS-e j foi substituda. Confira e informe novamente os dados da NFS-e que deseja substituir.
E8 Campo de optante pelo simples nacional no informado.
Utilize um dos tipos: 1 Sim; 2 - No.
E9 Campo de incentivador cultural no informado.
Utilize um dos tipos: 1 Sim; 2 - No.
E10 RPS j informado. Para essa Inscrio Municipal/CNPJ j existe um RPS informado com o mesmo nmero, srie e tipo.
E11 Nmero do RPS no informado. Informe o nmero do RPS. E12 Tipo do RPS no informado. Informe o tipo do RPS. E13 Campo tipo do RPS invlido. Utilize um dos tipos especificados: 1 - RPS', 2 -
RPSC ou 3 - RPSM. E14 Data da emisso do RPS no informada. Informe a Data da emisso do RPS no formato Date. E15 Data da emisso do RPS invlida. Informe a Data da emisso do RPS no formato Date. E16 A data da emisso do RPS no poder ser
superior data de hoje. Informe uma data de emisso de RPS vlida.
E17 A data da emisso do RPS no poder ser inferior data de habilitao do prestador para emisso da NFS-e.
Informe uma data de emisso de RPS vlida.
E18 O valor dos servios dever ser superior a R$ 0,00 (zero).
No permitido envio de valor de servios igual a zero.
E19 O valor das dedues dever ser inferior ou igual ao valor dos servios.
No permitido valor de deduo superior ao valor de servios.
E20 O valor das dedues dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de deduo inferior a zero (negativo).
E21 O valor dos descontos dever ser inferior ou igual ao valor dos servios.
No permitido valor de desconto superior ao valor de servios.
E22 O valor dos descontos dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de desconto inferior a zero (negativo).
E23 O valor do PIS dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de reteno inferior a zero (negativo).
E24 O valor do INSS dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de reteno inferior a zero (negativo).
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 49 de 62
Nota Fiscal de Servios Eletrnica - NFSE
E26 O valor do IR dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de reteno inferior a zero (negativo).
E27 O valor da CSLL dever ser superior ou igual a R$ 0,00 (zero).
No permitido valor de reteno inferior a zero (negativo).
E28 Item da lista de servio informado incompatvel com a informao de optante pelo simples nacional
Consulte a legislao vigente para saber se o item informado permite a opo pelo simples nacional.
E29 O cdigo de servio prestado no permite reteno de ISS.
Altere o campo "ISS Retido" para: 2 (Nota Fiscal sem ISS Retido).
E30 Item da lista de servio inexistente. Consulte a legislao vigente para saber o item da lista de servio que dever ser informado neste campo.
E31 Item da lista de servio no informado para a operao.
Informe o item relativo ao servio prestado nessa operao.
E32 Cdigo CNAE informado incompatvel com a informao de optante pelo simples nacional
Consulte a legislao vigente para saber se o cdigo informado permite a opo pelo simples nacional.
E33 Cdigo CNAE inexistente. Consulte a legislao vigente para saber o cdigo CNAE que dever ser informado neste campo.
E34 Cdigo de tributao informado incompatvel com a informao de optante pelo simples nacional.
Consulte a legislao vigente para saber se o cdigo informado permite a opo pelo simples nacional.
E35 Cdigo de tributao inexistente. Consulte a legislao vigente para saber o Cdigo de tributao que dever ser informado neste campo.
E36 Campo ISSRetido invlido. Utilize um dos tipos: 1 para ISS Retido ou 2 para ISS no Retido.
E37 Apenas servios tributados, no municpio ou fora, podem sofrer reteno de ISS.
Operaes isentas, imunes ou com exigibilidade suspensa por deciso judicial ou procedimento administrativo no podem sofrer reteno de ISS.
E38 Contribuintes enquadrados como Microempresa Municipal, Estimativa, Sociedade de Profissionais ou Incentivador Cultural no podem sofrer reteno de ISS.
No faa a reteno do ISS nos casos de empresas enquadradas como Microempresa Municipal, Estimativa, Sociedade de Profissionais ou Incentivador Cultural.
E39 Apenas empresas tomadoras de servios inscritas neste municipio podem efetuar reteno de ISS.
O CNPJ e/ou a Inscrio Municipal informada do tomador no foi encontrada na base de dados do municpio, no sendo permitida a reteno. Acerte o CNPJ e/ou Inscrio Municipal ou altere o campo ISS Retido para 2 (Sem reteno de ISS).
E40 Valor do ISS retido no informado. O valor do ISS retido deve ser informado quando o campo "IssRetido" for marcado com 1- Sim.
E41 O campo discriminao dos servios no foi preenchido.
O preenchimento da discriminao dos servios obrigatrio por lei, devendo ser preenchido adequadamente.
E42 Cdigo do municpio da prestao do servio invlido.
Consulte a tabela do IBGE e utilize um dos tipos listados na tabela.
E43 Inscrio Municipal do prestador no encontrada na base de dados do municpio.
Informe a inscrio municipal correta do prestador.
E44 CNPJ do prestador invlido. Informe o nmero do CNPJ correto do prestador. E45 CNPJ no encontrado na base de dados. Confira o numero do CNPJ informado. Caso esteja
correto, o prestador no est inscrito no municpio. E46 CNPJ do prestador no informado. Informe o CNPJ do prestador. E47 CPF/CNPJ do tomador invlido. Informe o CPF/CNPJ correto do tomador. E48 O campo CPF/CNPJ do tomador dever
ser preenchido com zeros quando for de Preencher o campo CPF/CNPJ do Tomador com zeros quando se tratar de tomador com CPF no
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 50 de 62
Nota Fiscal de Servios Eletrnica - NFSE
CPF no-informado. informado. E49 Lote de RPS com excesso de
inconsistncias. O servio de validao de RPS abortado quando atinge o nmero de 50 inconsistncias. Corrija os erros e reenvie o lote de RPS.
E50 Inscrio Municipal do prestador invlida. Informe a inscrio municipal correta do prestador. E51 Inscrio Municipal do tomador invlida Informe a inscrio municipal correta do tomador. E52 O tomador de servios informado o
prprio prestador. Na emisso da NFS-e no permitido que o prestador seja igual ao tomador.
E53 O campo Inscrio Municipal do tomador s dever ser preenchido para tomadores estabelecidos neste municpio.
Para tomadores estabelecidos fora deste municpio no preencher inscrio municipal.
E54 CNPJ do tomador () est vinculado a mais de uma inscrio municipal.
Informe a Inscrio Municipal do tomador vinculada ao CNPJ informado.
E55 Endereo do tomador (logradouro) no corresponde ao CEP informado.
Corrija o endereo (logradouro) ou o CEP do tomador do servio.
E56 Campo endereo do tomador no informado (obrigatrio para tomador com CNPJ).
O preenchimento do endereo (logradouro) obrigatrio para tomadores Pessoas Jurdicas (com CNPJ).
E57 Bairro no corresponde ao CEP informado. Corrija o Bairro ou o CEP do tomador do servio. E58 Cdigo do municpio do tomador no
corresponde ao CEP informado. Corrija o cdigo do municpio ou o CEP do tomador do servio.
E59 Campo cidade do tomador no informado (obrigatrio para tomador com CNPJ).
O preenchimento da Cidade do Tomador obrigatrio para tomadores Pessoas Jurdicas (com CNPJ).
E60 A cidade do tomador informada no foi encontrada na base de dados da prefeitura.
Informe a cidade correta do tomador. No caso de cidade do exterior (fora do pas), informe o campo com 99999.
E61 Sigla da UF do tomador no corresponde ao CEP informado.
Corrija a sigla da UF ou o CEP do tomador do servio.
E62 Cep no existe na tabela DNE dos Correios.
Informar o Cep correto.
E63 Razo Social do intermedirio do servio no informada com CNPJ/CPF ou Inscrio Municipal do intermedirio informada.
Informe a razo social do intermedirio do servio.
E64 Inscrio Municipal do intermedirio do servio invlida.
Informe a Inscrio Municipal correta do intermedirio do servio.
E65 Inscrio Municipal do intermedirio do servio no esta vinculada ao CNPJ/CPF informado.
Acerte a Inscrio Municipal ou o CNPJ/CPF do intermedirio do servio.
E66 CNPJ/CPF do Intermedirio do Servio invalido.
Informe o CNPJ/CPF correto do intermedirio do servio.
E67 Cdigo da obra invlido. Informe o cdigo da obra correto. E68 Status do RPS invlido. Utilize um dos tipos:1 Normal; 2 Cancelado; E69 Quantidade de RPS incorreta. Informe a quantidade de RPS correta. E70 Inscrio Municipal do prestador
especificada no lote no confere com o prestador informado no RPS.
Informe corretamente a Inscrio Municipal do prestador no lote e no RPS.
E71 RPS em duplicidade no arquivo enviado. Remova do arquivo o registro de RPS excedente. E72 Campo Quantidade de RPS informado
incorretamente. O campo quantidade de RPS numrico e dever ter tamanho mximo de 4 dgitos.
E73 Campo tipo do RPS invlido para o tipo de registro='3' (Cupons).
Utilize o tipo RPS-C".
E74 Data de emisso da Nota Fiscal no est compreendida entre e
-
Manual de Utilizao do Web Service Revisado em: 3/10/2012
Verso da ABRASF: 1.00 Verso: 1.08
Pgina 51 de 62
Nota Fiscal de Servios Eletrnica - NFSE
do lote> conforme especificado no cabealho do arquivo.
E75 Nmero do RPS substitudo no informado para status do RPS igual a "S".
Informe o nmero do RPS substitudo.
E76 O nmero do RPS substitudo informado no existe na base de dados.
Informe o nmero do RPS substitudo correto.
E77 Nmero da NFS-e no informado. Informe o nmero da NFS-e. E78 Nmero da NFS-e inexistente na base de
dados para o prestador de servio pesquisado.
Informe o nmero correto da NFS-e.
E79 Essa NFS-e j est cancel
top related