Manual de Utilização Do Web Service - NFSe Blumenau

Nota Fiscal de Servios
Eletrnica - NFS-e
Manual de Utilizao do Web Service
Verso: 1.2
Para baixar a verso mais atualizada deste documento, acesse o link:
http://www.blumenau.sc.gov.br/nfse
27/6/2013
Pgina 1 de 73
Prefeitura Municipal de Blumenau

Notas Fiscal de Servios Eletrnica (NFS-e)
ndice
1
INTRODUO ..................................................................................................................................................... 4
INTERFACES DISPONVEIS ............................................................................................................................... 5
2.1
ENVIO DE RPS ............................................................................................................................................... 5
2.2
ENVIO DE LOTE DE RPS .................................................................................................................................. 5
2.3
TESTE DE ENVIO DE LOTE DE RPS .................................................................................................................. 5
2.4
CONSULTA DE NFS-E ...................................................................................................................................... 5
2.5
CONSULTA DE NFS-E RECEBIDAS.................................................................................................................... 5
2.6
CONSULTA DE NFS-E EMITIDAS ....................................................................................................................... 5
2.7
CONSULTA DE LOTE ........................................................................................................................................ 6
2.8
CONSULTA INFORMAES DO LOTE ................................................................................................................. 6
2.9
CANCELAMENTO DE NFS-E ............................................................................................................................. 6
2.10
CONSULTA DE CNPJ ....................................................................................................................................... 6
ARQUITETURA DE COMUNICAO ................................................................................................................. 7

3.1
MODELO CONCEITUAL ..................................................................................................................................... 7
3.2
PADRES TCNICOS ....................................................................................................................................... 8
3.2.1
Padro de Comunicao ...................................................................................................................... 8
3.2.2
Padro de Certificado Digital ................................................................................................................ 8
3.2.3
Padro de Assinatura Digital ................................................................................................................ 9
3.2.4
Validao de Assinatura Digital pelo Sistema de NFS-e ................................................................... 11
3.2.5
Resumo dos Padres Tcnicos .......................................................................................................... 12
3.3
MODELO OPERACIONAL ................................................................................................................................. 13
3.3.1
3.4
Servios .............................................................................................................................................. 13
PADRO DAS MENSAGENS XML ..................................................................................................................... 14
3.4.1
Validao da estrutura das Mensagens XML ..................................................................................... 14
3.4.2
Schemas XML (arquivos XSD) ........................................................................................................... 15
3.4.3
Verso dos Schemas XML ................................................................................................................. 15
3.4.4
Regras de preenchimento dos campos .............................................................................................. 18
3.4.5
Tratamento de caracteres especiais no texto de XML ....................................................................... 19
WEB SERVICE LOTENFE ................................................................................................................................. 20

4.1
WSDL.......................................................................................................................................................... 21
4.2
TIPOS UTILIZADOS ......................................................................................................................................... 23
4.2.1
Tipos Simples ..................................................................................................................................... 23
27/6/2013
Pgina 2 de 73

4.2.2
4.3
SERVIOS E MTODOS .................................................................................................................................. 33
4.3.1
Regras Gerais ..................................................................................................................................... 33
4.3.2
Envio de RPS...................................................................................................................................... 36
4.3.3
Envio de Lote de RPS (EnvioLoteRPS) ............................................................................................. 42
4.3.4
Teste de Envio de Lote de RPS (TesteEnvioLoteRPS) ..................................................................... 45
4.3.5
Pedido de Consulta de NFS-e (ConsultaNFe) ................................................................................... 46
4.3.6
Pedido de Consulta de NFS-e Recebidas (ConsultaNFeRecebidas) ................................................ 49
4.3.7
Pedido de Consulta de NFS-e Emitidas (ConsultaNFeEmitidas)....................................................... 54
4.3.8
Pedido de Consulta de Lote (ConsultaLote) ....................................................................................... 56
4.3.9
Pedido de Informaes do Lote (ConsultaInformacoesLote) ............................................................. 58
4.3.10
Pedido de Cancelamento de NFS-e (CancelamentoNFe) ................................................................. 60
4.3.11
Pedido de Consulta de CNPJ (ConsultaCNPJ) .................................................................................. 64
4.4
Tipos Complexos ................................................................................................................................ 27
TABELA DE ERROS E ALERTAS ....................................................................................................................... 66
4.4.1
Erros ................................................................................................................................................... 66
4.4.2
Alertas ................................................................................................................................................. 71
ARQUIVOS DE EXEMPLOS.............................................................................................................................. 72
ANEXO I ..................................................................................................................................................................... 73
TABELA DE MUNICPIOS ............................................................................................................................................. 73
27/6/2013
Pgina 3 de 73

1 INTRODUO
Este manual tem como objetivo apresentar a definio das especificaes e critrios tcnicos
necessrios para utilizao do Web Service disponibilizado pela Prefeitura de Blumenau 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 da Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau. Desta forma, consegue-se
automatizar o processo de emisso, consulta e cancelamento de NFS-e.
27/6/2013
Pgina 4 de 73

2 INTERFACES DISPONVEIS
Atravs do Web Service, o Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau,
disponibiliza uma srie de interfaces que podero ser acessadas pelos sistemas dos contribuintes. A
seguir, esto resumidas as interfaces disponveis e suas respectivas funcionalidades bsicas.
2.1
ENVIO DE RPS
Atravs desta interface, os prestadores de servios podero enviar um RPS emitido por seu sistema
para que seja substitudo por uma Nota Fiscal de Servios Eletrnica. Esta interface destina-se aos
prestadores que desejam emitir NFS-e online e individualmente. Para emisses de grandes volumes
recomendamos a utilizao da interface Envio de Lote de RPS.
2.2
ENVIO DE LOTE DE RPS
Atravs desta interface, os prestadores de servios podero enviar lotes de RPS emitidos por seus
sistemas para que sejam substitudos por Nota Fiscal de Servios Eletrnica. Esta interface destina-se
aos prestadores que desejam emitir NFS-e ofline e em grandes volumes.
2.3
TESTE DE ENVIO DE LOTE DE RPS
O uso desta interface opcional. A interface de Envio de Lote de RPS faz exatamente as mesmas
verificaes, entretanto na interface de Teste, nenhuma NFS-e gerada. Esta interface dever ser
usada apenas na fase de adaptao dos sistemas dos contribuintes. Nos casos de sistemas j
adaptados, seu uso resulta em duplicidade de esforos desnecessrios.
2.4
CONSULTA DE NFS-E
Esta interface permite os prestadores de servios consultarem as NFS-e emitidas por ele.
2.5
CONSULTA DE NFS-E RECEBIDAS
Esta interface possibilita aos tomadores e/ou prestadores de servios consultarem as NFS-e que
tiverem sido emitidas para ele, possibilitando, por exemplo, a alimentao automtica de seu mdulo de
contas a pagar.
2.6
CONSULTA DE NFS-E EMITIDAS
Esta interface possibilita aos prestadores de servios consultarem as NFS-e que tiverem sido emitidas
por ele.
27/6/2013
Pgina 5 de 73

2.7
CONSULTA DE LOTE
Aps o envio bem sucedido de um Lote de RPS, o Web Service retorna diversas informaes, entre
elas o nmero do lote processado. Com esta interface, basta informar o nmero do lote desejado para
receber as informaes de todas as NFS-e geradas neste lote.
2.8
CONSULTA INFORMAES DO LOTE
Aps o envio bem sucedido de um Lote de RPS, o Web Service retorna diversas informaes, entre
elas o nmero do lote processado. Com esta interface, basta informar o nmero do lote desejado para
receber informaes resumidas: data/hora de envio do lote, quantidade de notas processadas, tempo
de processamento, etc...
Para ter informaes das notas processadas, deve-se usar a interface de Consulta de Lote.
2.9
CANCELAMENTO DE NFS-E
Com esta interface, os prestadores de servios podero cancelar as NFS-e emitidas por ele, informando
apenas os nmeros da NFS-e que devero ser cancelados.
2.10 CONSULTA DE CNPJ

Esta interface possibilita aos tomadores e/ou prestadores de servios consultarem quais Inscries
Municipais (CMC) esto vinculadas a um determinado CNPJ e se estes Contribuintes j emitem NFS-e.
27/6/2013
Pgina 6 de 73

3 ARQUITETURA DE COMUNICAO
3.1
MODELO CONCEITUAL
O Web Service do Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau ir

disponibilizar as seguintes funcionalidades:
A. Envio de RPS;
B. Envio de Lote de RPS;
C. Teste de Envio de Lote de RPS;
D. Consulta de NFS-e;
E. Consulta de NFS-e Recebidas;
F. Consulta de NFS-e Emitidas;
G. Consulta de Lote;
H. Consulta de Informaes de Lote;
I.
Cancelamento de NFS-e;
J. Consulta de CNPJ.
Existir um nico Web Service com todos os servios apresentados a cima. 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.
O pedido de servio ser atendido na mesma conexo (todos os servios sero sncronos). O
processamento do pedido do servio concludo na mesma conexo, com a devoluo de uma
mensagem XML contendo o retorno do processamento do servio pedido;
O diagrama a seguir ilustra o fluxo conceitual de comunicao entre o sistema do contribuinte e o
Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau:
27/6/2013
Pgina 7 de 73

3.2
PADRES TCNICOS
3.2.1
Padro de Comunicao
A comunicao entre os sistemas de informaes dos contribuintes e o Sistema de Nota Fiscal de

Servios Eletrnica da Prefeitura de Blumenau ser baseada em um Web Service disponibilizado no
Sistema de Nota Fiscal de Servios Eletrnica. O meio fsico de comunicao utilizado ser a Internet,
com o uso do protocolo SSL, que alm de garantir um duto de comunicao seguro na Internet, permite
a identificao do servidor e do cliente atravs de certificados digitais, eliminando a necessidade de
identificao do usurio atravs de nome ou cdigo de usurio e senha.
O modelo de comunicao segue o padro de Web Services definido pelo WS-I Basic Profile.
A troca de mensagens entre o Web Service do Sistema de Nota Fiscal de Servios Eletrnica da
Prefeitura de Blumenau 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.
3.2.2
Padro de Certificado Digital
Os certificados digitais utilizados no Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de

Blumenau sero emitidos por Autoridade Certificadora credenciada pela Infra-estrutura de Chaves
Pblicas Brasileira ICP-Brasil, tipo A1, A3 ou A4, devendo conter o CNPJ do proprietrio do certificado
digital.
27/6/2013
Pgina 8 de 73

Os certificados digitais sero exigidos no mnimo* em dois (2) momentos distintos:

A. Assinatura de Mensagens XML:
Quem pode assinar a Mensagem XML:
Todas as Mensagens XML podem ser assinadas pelo prprio contribuinte.
Neste caso o certificado digital utilizado dever conter o CNPJ do contribuinte
que gerou a mensagem XML;
As Mensagens XML de consulta de NFS-e Emitidas, NFS-e Recebidas e
Informaes de lote, podem ser assinadas pelo contador (desde que cadastrado
na tela de Configuraes do Perfil do Contribuinte) ou por um terceiro (ex.:
funcionrio da empresa contribuinte), desde que o contribuinte tenha concedido
a este permisso de acesso a consultas (atravs do menu Gerenciamento de
Usurios do Sistema de Nota Fiscal de Servios Eletrnica). Neste caso o
certificado digital utilizado dever conter o CPF/CNPJ do contador / usurio
autorizado.
Todas as mensagens XML devero conter o CPF/CNPJ de quem estar autorizado a efetuar a
sua transmisso (TAG CPFCNPJRemetente). No caso de as Mensagens XML serem
transmitidas por quem as gerou o CPF/CNPJ informado dever ser o do prprio.
B. Autenticao na transmisso das mensagens entre os servidores do contribuinte e da Prefeitura
de Blumenau: O certificado digital utilizado para identificar essa funo dever conter o
CPF/CNPJ do responsvel pela transmisso das mensagens. Este CPF/CNPJ dever ser o
mesmo que consta na TAG CPFCNPJRemetente da mensagem XML.
* Adicionalmente os certificados digitais tambm podero ser exigidos conforme a necessidade
especfica de cada servio (exemplo: itens 4.3.2 e 4.3.10).
3.2.3
Padro de Assinatura Digital
As mensagens enviadas ao Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau

so documentos eletrnicos elaborados no padro XML e devem ser assinados digitalmente utilizando
certificado digital, descrito no item 3.2.2.
27/6/2013
Pgina 9 de 73

Os elementos abaixo esto presentes dentro do Certificado do contribuinte tornando desnecessria a

sua representao individualizada na mensagem XML. Portanto, a mensagem XML no deve conter os
elementos:
<X509SubjectName>
<X509IssuerSerial>
<X509IssuerName>
<X509SerialNumber>
<X509SKI>
Analogamente, as TAGs abaixo no devero ser informadas, pois as informaes sero obtidas a partir
do Certificado do emitente:
<KeyValue>
<RSAKeyValue>
<Modulus>
<Exponent>
Para o processo de assinatura, o contribuinte no deve fornecer a Lista de Certificados Revogados, j
que a mesma ser montada e validada pelo Sistema de Nota Fiscal de Servios Eletrnica da
Prefeitura de Blumenau.
27/6/2013
Pgina 10 de 73

A assinatura digital do documento eletrnico dever atender aos seguintes padres adotados:
A. Padro
de
assinatura:
XML
Digital
Signature,
utilizando
formato
Enveloped
(http://www.w3c.org/TR/xmldsig-core/);
B. Certificado
digital:
Emitido
por
AC
credenciada
no
ICP-Brasil
(http://www.w3c.org/2000/09/xmldsig#X509Data);
C. Cadeia de Certificao: EndCertOnly (Incluir na assinatura apenas o certificado do usurio final);
D. Tipo do certificado: A1, A3 ou A4 (o uso de HSM recomendado);
E. Tamanho da Chave Criptogrfica: Compatvel com os certificados A1 e A3 (1024bits) ou A4
(2048 bits);
F. Funo criptogrfica assimtrica: RSA (http://www.w3c.org/2000/09/xmldsig#rsa-sha1);
G. Funo de message digest: SHA-1 (http://www.w3c.org/2000/09/xmldsig#sha1);
H. Codificao: Base64 (http://www.w3c.org/2000/09/xmldsig#base64);
I.
Transformaes exigidas: til para realizar a canonicalizao do XML enviado para realizar a
validao correta da Assinatura Digital. So elas:
(1) Enveloped (http://www.w3c.org/2000/09/xmldsig#enveloped-signature)
(2) C14N (http://www.w3c.org/TR/2001/REC-xml-c14n-20010315)
3.2.4
Validao de Assinatura Digital pelo Sistema de NFS-e
Para a validao da assinatura digital, seguem as regras que sero adotadas pelo Sistema de Nota
Fiscal de Servios Eletrnica da Prefeitura de Blumenau:
A. Extrair a chave pblica do certificado digital e no utilizar a chave indicada na TAG XML
(ds:KeyValue);
B. Verificar o prazo de validade do certificado utilizado;
C. Montar e validar a cadeia de confiana dos certificados validando tambm a LCR (Lista de
Certificados Revogados) de cada certificado da cadeia;
D. 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);
E. Garantir que o certificado utilizado de um usurio final e no de uma Autoridade Certificadora;
F. Adotar as regras definidas pelo RFC 3280 para LCRs e cadeia de confiana;
G. Validar a integridade de todas as LCR utilizadas pelo sistema;
H. Prazo de validade de cada LCR utilizada (verificar data inicial e final)
A forma de conferncia da LCR pelo Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de
Blumenau, pode 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.
27/6/2013
Pgina 11 de 73

3.2.5
Resumo dos Padres Tcnicos
A tabela a seguir resume os principais padres de tecnologia utilizados:

Caracterstica
Web Services
Descrio
Padro definido pelo WS-I Basic Profile 1.1 (http://www.wsi.org/Profiles/BasicProfile-1.1-2004-08-24.html).
Meio lgico de comunicao
Web Service, disponibilizados pelo Sistema de NFS-e da

Prefeitura de Blumenau
Meio fsico de comunicao
Internet
Protocolo Internet
SSL verso 3.0, com autenticao mtua atravs de certificados

digitais.
Padro de troca de mensagens
SOAP verso 1.2.
Padro da mensagem XML
XML no padro Style/Encoding: Document/Literal, wrapped.
Padro de certificado digital
X.509 verso 3, emitido por Autoridade Certificadora credenciada

pela Infra-estrutura de Chaves Pblicas Brasileira ICP-Brasil, do
tipo A1, A3 ou A4, devendo conter o CNPJ do proprietrio do
certificado digital.
Para assinatura de mensagens, utilizar o certificado digital do
estabelecimento emissor da NFS-e (no caso de Consulta de NFSe Recebidas utilizar o certificado digital do tomador).
Opcionalmente as Mensagens XML de consulta de NFS-e
Emitidas, NFS-e Recebidas e Informaes de lote, podem ser
assinadas pelo contador (desde que cadastrado na tela de
Configuraes do Perfil do Contribuinte) ou por um terceiro (ex.:
funcionrio da empresa contribuinte), desde que o contribuinte
tenha concedido a este permisso de acesso a consultas (atravs
do menu Gerenciamento de Usurios do Sistema de Nota Fiscal
de Servios Eletrnica). Neste caso o certificado digital utilizado
dever conter o CPF/CNPJ do contador / usurio autorizado.
Para autenticao, utilizar o certificado digital do responsvel pela
transmisso.
Padro de assinatura digital
XML Digital Signature, Enveloped, com certificado digital X.509

verso 3, com chave privada de 1024 bits (A1 / A3) ou 2048 bits
(A4), com padres de criptografia assimtrica RSA, algoritmo
message
digest
27/6/2013
SHA-1
utilizao
das
transformaes
Pgina 12 de 73

Enveloped e C14N.
Validao de assinatura digital
Ser validado alm da integridade e autoria, a cadeia de

confiana com a validao das LCRs.
Padres de preenchimento XML
Campos no obrigatrios do Schema que no possuam
contedo tero suas tags suprimidas na mensagem XML.

Mscara de nmeros decimais e datas esto definidas no
Schema XML.
Nos campos numricos inteiro, no incluir a vrgula ou ponto
decimal.
Nos campos numricos com casas decimais, utilizar o ponto
decimal na separao da parte inteira.
3.3
MODELO OPERACIONAL
Como dito anteriormente, a forma de processamento dos pedidos de servios do Web Service do
Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau ser sncrona, atendo ao
pedido de servio na mesma conexo.
3.3.1
Servios
Os pedidos de servios so processados imediatamente e o resultado do processamento obtido em

uma nica conexo.
Abaixo, o fluxo simplificado de funcionamento:
Etapas do processo ideal:

1. O sistema do contribuinte inicia a conexo enviando uma mensagem XML de pedido do servio
para o Web Service;
2. O Web Service recebe a mensagem XML de pedido do servio e encaminha ao sistema da
NFS-e;
3. O sistema da NFS-e recebe a mensagem XML de pedido do servio e realiza o processamento*,
devolvendo uma mensagem XML de retorno ao Web Service;
4. O Web Service recebe a mensagem XML de retorno e a encaminha ao sistema do contribuinte;
27/6/2013
Pgina 13 de 73

5. O sistema do contribuinte recebe a mensagem XML de retorno e encerra a conexo.
3.4
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.
3.4.1
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.
27/6/2013
Pgina 14 de 73

3.4.2
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 LoteNFe pode ser obtido na internet acessando o Portal do Sistema de
Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau.
Para obter os Schemas XML do Web Service da NFS-e acione o navegador Web (Firefox, Internet
Explorer, por exemplo) e digite o endereo a seguir:
https://nfse.blumenau.sc.gov.br/ws/schemas.zip
3.4.3
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 no
nome do arquivo XSD precedida da literal _v, como segue:
PedidoEnvioLoteRPS_v02.xsd (Schema XML de Envio de Lote de RPS, verso 2);
RetornoEnvioLoteRPS_v03.xsd (Schema XML do Retorno de Envio de Lote de RPS, verso 3);
TiposNFe_v01.xsd (Schema XML dos tipos bsicos da NFS-e, verso 1).
A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de Nota Fiscal de
Servios Eletrnica da Prefeitura de Blumenau utiliza as definies de tipos simples ou tipos
complexos que esto definidos em outros Schemas XML (ex.: TiposNFe.xsd e xmldsig-coreschema.xsd), nestes casos, a modificao de verso do Schema bsico ser repercutida no Schema
principal.
Por exemplo, o tipo RPS (tpRPS) utilizado no Schema PedidoEnvioLoteRPS_V04.xsd est definido no
Schema TiposNFe_V01.xsd, caso ocorra alguma modificao na definio deste tipo, e um
conseqente incremento da verso do Schema TiposNFe_V01.xsd para TiposNFe_V02.xsd o Schema
PedidoEnvioLoteRPS_V04.xsd (bem como todos os Schemas que utilizam o tipo RPS) deve ter a
declarao import atualizada com o nome do Schema TiposNFe_V02.xsd e a verso atualizada para
PedidoEnvioLoteRPS_V05.xsd
27/6/2013
Pgina 15 de 73

Exemplo de Schema XML de Pedido de Envio de Lote de RPS (arquivo PedidoEnvioLoteRPS_v01.xsd):

<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://www.blumenau.sc.gov.br/nfse"
xmlns:tipos="http://www.blumenau.sc.gov.br/nfse/tipos"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<xs:import namespace="http://www.blumenau.sc.gov.br/nfse/tipos" schemaLocation="TiposNFe_v01.xsd" />
<xs:import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="xmldsig-core-schema_v01.xsd"
/>
<xs:element name="PedidoEnvioLoteRPS">
<xs:annotation>
<xs:documentation>Schema utilizado para PEDIDO de envio de lote de RPS.</xs:documentation>
<xs:documentation>Este Schema XML utilizado pelos prestadores de servios para substituio em
lote de RPS por NFS-e.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Cabecalho" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Cabealho do pedido.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="CPFCNPJRemetente" type="tipos:tpCPFCNPJ" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe o CPF/CNPJ do Remetente autorizado a transmitir a mensagem
XML.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="transacao" type="xs:boolean" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe se os RPS a serem substitudos por NFS-e faro parte de uma
mesma transao. True - Os RPS s sero substitudos por NFS-e se no ocorrer nenhum evento de erro
durante o processamento de todo o lote; False - Os RPS vlidos sero substitudos por NFS-e, mesmo que
ocorram eventos de erro durante processamento de outros RPS deste lote.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dtInicio" type="xs:date" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe a data de incio do perodo transmitido (AAAA-MMDD).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="dtFim" type="xs:date" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe a data final do perodo transmitido (AAAA-MMDD).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="QtdRPS" type="tipos:tpQuantidade" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe o total de RPS contidos na mensagem XML.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ValorTotalServicos" type="tipos:tpValor" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe o valor total dos servios prestados dos RPS contidos na
mensagem XML.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ValorTotalDeducoes" type="tipos:tpValor" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Informe o valor total das dedues dos RPS contidos na mensagem
XML.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="Versao" type="tipos:tpVersao" use="required" fixed="1">
<xs:annotation>
27/6/2013
Pgina 16 de 73

<xs:documentation>Informe a Verso do Schema XML utilizado.</xs:documentation>

</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="RPS" type="tipos:tpRPS" minOccurs="1" maxOccurs="50">
<xs:annotation>
<xs:documentation>Informe os RPS a serem substituidos por NFS-e.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="ds:Signature" minOccurs="1" maxOccurs="1">
<xs:annotation>
<xs:documentation>Assinatura digital emissor dos RPS.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
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 pela Prefeitura de Blumenau e podero
ocorrer sempre que se fizerem necessrias.
27/6/2013
Pgina 17 de 73

3.4.4
Regras de preenchimento dos campos
Campos que representam CPF e CNPJ (respectivamente 11 e 14 caracteres) devem ser

informados com o tamanho fixo previsto, sem formatao e com o preenchimento dos zeros no
significativos;
Campos numricos que representam valores e quantidades so de tamanho varivel,

respeitando o tamanho mximo previsto para o campo e a quantidade de casas decimais
(quando houver). O preenchimento de zeros no significativos causa erro de validao do
Schema XML.
Os campos numricos devem ser informados sem o separador de milhar, com uso do ponto
decimal para indicar a parte fracionria (quando houver) respeitando-se a quantidade de dgitos
prevista no layout;
As datas devem ser informadas no formato AAAA-MM-DD;
Para reduzir o tamanho final das mensagens XML alguns cuidados de programao devero ser
assumidos:
Na gerao das mensagens XML, excetuados os campos identificados como obrigatrios no

respectivo Schema XML, no incluir as TAGs de campos zerados (para campos tipo numrico)
ou vazios (para campos tipo caractere);
No incluir "espaos" no incio e/ou no final de campos alfanumricos;
No incluir comentrios na mensagem XML;
No incluir anotao e documentao na mensagem XML (TAG annotation e TAG

documentation);
No incluir caracteres de formatao na mensagem XML: LF (Line Feed ou salto de linha,

caractere ASCII 10), "CR" (Carriage Return ou retorno do carro, caractere ASCII 13), "tab",
caractere de "espao" entre as TAGs).
27/6/2013
Pgina 18 de 73

3.4.5
Tratamento de caracteres especiais no texto de XML
Todos os textos de uma mensagem XML passam por uma anlise do parser especfico da linguagem.
Alguns caracteres afetam o funcionamento deste parser, no podendo aparecer no texto de uma
forma no controlada. Estes caracteres devem ser substitudos conforme a tabela a seguir:
Caracteres que afetam o parser
Descrio
Substituir por
>
Sinal de maior.
>
<
Sinal de menor.
<
&
e-comercial.
&
Aspas.
"
Sinal de apstrofe.
'
27/6/2013
Pgina 19 de 73

4 WEB SERVICE LOTENFE

O Web Service LoteNFe, do Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de
Blumenau, disponibiliza os servios que sero utilizados pelos sistemas de informao dos
contribuintes. O mecanismo de utilizao do Web Service LoteNFe segue as seguintes premissas:
Ser disponibilizado um Web Service (LoteNFe) para todos os servios, existindo um mtodo Web para
cada tipo de servio.
Os servios disponibilizados sero sncronos, por tanto o envio da mensagem XML de pedido do
servio e a obteno da mensagem XML de retorno sero realizados na mesma conexo atravs de um
nico mtodo.
As mensagens XML de pedido de servio que excederem o tamanho limite previsto (500 KB) obtero
como retorno uma mensagem XML de erro. Por tanto os sistemas de informao dos contribuintes no
podero permitir a gerao de mensagens XML com tamanho superior a 500 KB.
Primeiramente cada mensagem XML de pedido de servio ser recebida pelo Web Service LoteNFe
para validao de seu respectivo Schema XML (arquivo XSD). Caso ocorram erros de validao do
Schema XML, o contedo da mensagem XML no ser processado e ser retornada uma mensagem
XML contendo o(s) erro(s) ocorrido(s).
27/6/2013
Pgina 20 de 73

4.1
WSDL
Para que os sistemas de informao dos contribuintes saibam quais parmetros enviar ao Web Service
LoteNFe e quais parmetros sero retornados, os contribuintes devero utilizar o arquivo WSDL (Web
Service Description Language, linguagem de descrio de servio Web). Trata-se de um arquivo XML
que configura como ocorrer a interao entre um Web Service e seus consumidores (sistemas de
informao dos contribuintes).
O WSDL uma linguagem baseada em XML, com a finalidade de documentar as mensagens XML que
o Web service aceita (pedidos de servio) e gera (retornos). Esse mecanismo padro facilita a
interpretao dos contratos pelos desenvolvedores e ferramentas de desenvolvimento.
Para enxergar o valor do WSDL, imagine que um contribuinte quer invocar um dos mtodos que
fornecido pelo Web Service LoteNFe. O contribuinte pode pedir alguns exemplos de mensagens XML
de pedido e de retorno e escrever sua aplicao para produzir e consumir mensagens XML que se
parecem com os exemplos, mas isso pode gerar muitos erros. Por exemplo, o contribuinte pode assumir
que um campo um inteiro, quando de fato uma string. O WSDL especifica o que a mensagem XML
de pedido deve conter e como vai ser a mensagem XML de retorno, em uma notao no ambgua.
A notao que o arquivo WSDL usa para descrever o formato das mensagens baseada no padro
XML, o que significa que uma linguagem de programao neutra e baseada em padres, o que a
torna adequada para descrever as interfaces dos Web services, que so acessveis por uma grande
variedade de plataformas e linguagens de programao. Alm de descrever o contedo das
mensagens, o WSDL define onde o servio est disponvel e quais protocolos de comunicao so
usados para conversar com o servio. Isso significa que o arquivo WSDL define tudo que necessrio
para escrever um programa que utilize o XML Web service. H vrias ferramentas disponveis para ler o
arquivo WSDL e gerar o cdigo para comunicar com o XML Web service.
A documentao do WSDL pode ser obtida na internet acessando o endereo do Web Service do
Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau.
Para obter o WSDL do Web Service da NFS-e acione o navegador Web (Firefox, Internet Explorer, por
exemplo) e digite o endereo a seguir: https://nfse.blumenau.sc.gov.br/ws/lotenfe.asmx?WSDL
27/6/2013
Pgina 21 de 73

27/6/2013
Pgina 22 de 73

4.2
TIPOS UTILIZADOS
A seguir so apresentados os tipos Simples e Complexos utilizados nos Schemas XML de pedido e de
retorno. Estes tipos esto definidos no Schema XML de TiposNF-e (arquivo TiposNFe_V01.xsd).
Para obter a verso mais recente do Schema XML de TiposNF-e (bem como os demais Schemas XML)
acesse o link: https://nfse.blumenau.sc.gov.br/ws/schemas.zip
4.2.1
Tipos Simples
Descrio dos nomes e abreviaes utilizadas nas colunas de cabealho do layout da tabela de Tipos
Simples:
Nome do Tipo
tpCidade
Descrio
Tipo
(Tipo utilizado para informar ...)
Base
Cdigo da cidade do endereo.
Tamanho
Dec
Observao
O cdigo informado dever pertencer Tabela de

Municpios (do IBGE) disponibilizada pela
A. Coluna Nome do Tipo: Nome do tipo simples;

B. Coluna Descrio: Descrio do tipo simples;
C. Coluna Tipo Base: tipo base utilizado na criao do tipo simples.
B boolean;
Base64Binary;
C campo alfanumrico;
D campo data;
N campo numrico;
D. Coluna Tamanho: x-y, onde x indica o tamanho mnimo e y o tamanho mximo; a existncia de
um nico valor indica que o campo tem tamanho fixo, devendo-se informar a quantidade de
caracteres exigidos, preenchendo-se os zeros no significativos; tamanhos separados por
vrgula indicam que o campo deve ter um dos tamanhos fixos da lista;
E. Coluna Dec: indica a quantidade mxima de casas decimais do campo;
27/6/2013
Pgina 23 de 73

Tabela de Tipos Simples

Nome do Tipo
Descrio
Tipo
(Tipo utilizado para
Base
Tamanho
Dec
3-5
Observao
informar ...)
tpAliquota
Valor da alquota do
servio.
Exemplo:
5% - 0.05
2,5% - 0.025
1,75% - 0.0175
tpAssinatura
Assinatura Digital de NFSe / RPS
base64Bi
Cadeia de caracteres (com informaes
nary
do RPS emitido) assinada conforme

descrito no item 4.3.2.
tpAssinaturaCancelamento
Assinatura Digital de
Cancelamento de NFS-e.
base64Bi
Cadeia de caracteres (com informaes
nary
da NFS-e emitida) assinada conforme

descrito no item 4.3.10.
tpBairro
Bairro do endereo.
0-30
Bairro.
tpCEP
CEP do endereo.
7-8
CEP.
tpCidade
Cdigo da cidade do
endereo.
O cdigo informado dever pertencer

Tabela de Municpios (do IBGE)
disponibilizada pela Prefeitura de
Blumenau.
tpCNPJ
Nmero no Cadastro
14
1-8
Nacional da Pessoa
Jurdica.
tpCodigoServico
Cdigos do servio.
O cdigo informado dever pertencer

Tabela de Servios disponibilizada pela
tpCodigoEvento
Cdigo do evento.
3-4
O cdigo informado dever pertencer a

Tabela de Erros ou a Tabela de Alertas
disponibilizada pela Prefeitura de
Blumenau.
tpCodigoVerificacao
Cdigo de verificao da
NFS-e.
Cdigo de verificao da NFS-e gerado

pelo Sistema de Nota Fiscal de Servios
Eletrnica.
tpComplementoEndereco
Complemento do
0-30
11
0-300
endereo.
tpCPF
Nmero no Cadastro de
Pessoas Fsicas.
tpDescricaoEvento
Descrio do evento.
Descrio correspondente ao cdigo do

evento ocorrido.
tpDiscriminacao
Discriminao dos
0-2000
Servios.
Texto contnuo descritivo dos servios. O

conjunto de caracteres correspondentes
ao cdigo ASCII 13 e ASCII 10 dever
ser substitudo pelo caracter | (pipe ou
barra
vertical. ASCII 124).
27/6/2013
Pgina 24 de 73

Nome do Tipo
Descrio
Tipo
Base
Tamanho
Dec
Observao
informar ...)
Exemplo:
Digitado na NF
Lavagem de carro
com lavagem de motor
Preenchimento do arquivo:
Lavagem de carro|com lavagem de
motor
No devem ser colocados espaos neste
campo para completar seu tamanho
mximo, devendo o campo ser preenchido
apenas com contedo a ser processado /
armazenado.
(*) Este campo impresso num
retngulo com 95 caracteres (largura) e
21 linhas (altura). permitido (no
recomendvel), o uso de mais de 1000
caracteres. Caso seja ultrapassado o
limite de 21 linhas, o contedo ser
truncado durante a impresso da Nota.
tpEmail
E-mail.
0-75
tpInscricaoEstadual
Inscrio Estadual.
1-19
tpInscricaoMunicipal
Inscrio Municipal.
1-15
tpLogradouro
Endereo.
0-50
tpNumero
Nmero.
1-13
Tipo utilizado para informar nmero de

NFS-e, nmero de RPS, nmero de Guia,
nmero de Lote, nmero de pgina, ...
tpNumeroEndereco
Nmero do endereo.
0-10
tpOpcaoSimples
Opo pelo Simples.
Opo pelo Simples:

0 - No-optante pelo Simples Federal nem
Municipal;
1 - Optante pelo Simples Federal
(Alquota de 1,0%);
2 - Optante pelo Simples Federal
(Alquota de 0,5%);
3 - Optante pelo Simples Municipal.
4 - Simples Nacional
6 - MEI
tpQuantidade
Tipo quantidade.
1-15
tpRazaoSocial
Tipo Razo Social.
0-75
Nome/Razo Social.
tpSerieRPS
Tipo Srie do RPS.
1-5
Srie do RPS.
tpStatusNFe
Status da NFS-e.
Status da NFS-e:
N Normal;
C Cancelada;
E Extraviada.
27/6/2013
Pgina 25 de 73

Nome do Tipo
Descrio
Tipo
Base
Tamanho
Dec
Observao
informar ...)
tpSucesso
O contedo deste campo
indica se o pedido do
servio obteve sucesso ou
no (conforme descrito no
item (4.3.1).
tpTempoProcessamento
Tempo de processamento
1-15
tpTipoLogradouro
Tipo de endereo.
0-3
tpTipoRPS
Tipo do RPS.
(em segundos).
Rua, Av, ...
Tipo do RPS:
RPS Recibo Provisrio de Servios;
RPS-M Recibo Provisrio de Servios
proveniente
de Nota Fiscal Conjugada (Mista);
RPS-C Cupom.
tpTributacaoNFe
Tipo de Tributao.
Tipo de Tributao:
T - Tributao no municipio de Blumenau;
F - Tributao fora do municipio de
Blumenau;
I Isento;
J - ISS Suspenso por Deciso Judicial.
tpUF
Sigla da UF do endereo.
tpValor
Valores.
0-15
2
Tipo utilizado para valores com 15 dgitos,

sendo 13 de corpo e 2 decimais.
Exemplo:
R$ 500,85 500.85
R$ 826,00 826
tpVersao
Verso.
1-3
O contedo deste campo indica a verso

do Schema XML utilizado.
Exemplo:
Verso 1 1
Verso 10 10
Verso 100 100
27/6/2013
Pgina 26 de 73

4.2.2
Tipos Complexos
Layout da tabela utilizada para representar a estrutura XML dos Tipos Complexos:
<Nome do Tipo Complexo>
<Descrio do Tipo Complexo>
Nome do Elemento
Tipo do Elemento
Ocorrncia*
Descrio
<Nome do Elemento 1>
<Tipo do Elemento 1>
x-y
<Descrio do elemento 1>
<Nome do Elemento ...>
<Tipo do Elemento ...>
x-y
<Descrio do elemento 1>
Elemento que
<Nome do Elemento de Escolha a>
<Tipo do Elemento a>
deriva de uma
<Nome do Elemento de Escolha b>
<Tipo do Elemento b.>
escolha (Choice).
<Nome do Elemento de Escolha c>
<Tipo do Elemento c.>
<Nome do Elemento N>
<Descrio do elemento a>

x-y
<Descrio do elemento b>
x-y
<Descrio do elemento N>
<Descrio do elemento c>
<Tipo do Elemento N>
* Ocorrncia: x - y, onde x indica a ocorrncia mnima e y a ocorrncia mxima.
tpEvento
Tipo que representa a ocorrncia de eventos de erro/alerta durante o processamento da mensagem XML.
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
Codigo
tpCodigoEvento
1-1
Cdigo do evento ocorrido.
Descricao
tpDescricaoEvento
0-1
Descrio do evento ocorrido.

Chave de identificao da NFS-e que
(Choice)
Caso o evento tenha sido gerado
ChaveNFe
tpChaveNFe
durante o processamento de uma
0-1
NFS-e (ou RPS), o tpEvento

tambm retorna a chave da NFS-
gerou o evento (ver detalhes na tabela
ChaveRPS
tpChaveRPS
e (ou RPS) que o gerou.
tpChaveNFe).
Chave de identificao do RPS que gerou
o evento (ver detalhes na tabela
tpChaveRPS).
tpCPFCNPJ
Tipo que representa um CPF/CNPJ
Nome do Elemento
(Choice)
Tipo do Elemento
Ocorrncia
CPF
tpCPF
1-1
CNPJ
tpCNP
1-1
27/6/2013
Descrio
Nmero no Cadastro de
Pessoas Fsicas.
Nmero no Cadastro
Nacional da Pessoa Jurdica.
Pgina 27 de 73

tpChaveNFeRPS
Tipo que representa a Chave de uma NFS-e e a Chave do RPS que a mesma substitui.
Nome do Elemento
Tipo do Elemento
Ocorrncia
ChaveNFe
tpChaveNFe
1-1
ChaveRPS
tpChaveRPS
1-1
Descrio
Chave de identificao da NFS-e que substitui o RPS (ver
detalhes na tabela tpChaveNFe).
Chave de identificao do RPS substitudo (ver detalhes
na tabela tpChaveRPS).
tpChaveNFe
Tipo que representa a chave que um NFS-e
Nome do Elemento
Tipo do Elemento
InscricaoPrestador
Ocorrncia
1-1
Descrio
Inscrio Municipal do Prestador que emitiu a NFS-e.
Numero
tpNumero
1-1
Nmero da NFS-e.
CodigoVerificacao
tpCodigoVerificacao
0-1
Cdigo de Verificao da NFS-e.
tpChaveRPS
Tipo que define a chave identificadora de um RPS
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
InscricaoPrestador
1-1
Inscrio Municipal do Prestador que emitiu o RPS.
SerieRPS
tpSerieRPS
0-1
Srie do RPS.
NumeroRPS
tpNumero
1-1
Nmero do RPS.
tpEndereco
Tipo que representa um Endereo
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
TipoLogradouro
tpTipoLogradouro
0-1
Tipo do endereo.
Logradouro
tpLogradouro
0-1
Endereo.
NumeroEndereco
tpNumeroEndereco
0-1
Nmero do endereo.
ComplementoEndereco
tpComplementoEndereco
0-1
Complemento do endereo.
Bairro
tpBairro
0-1
Bairro do endereo.
Cidade
tpCidade
0-1
Cdigo da cidade do endereo.
UF
tpUF
0-1
CEP
tpCEP
0-1
CEP do endereo.
27/6/2013
Pgina 28 de 73

tpInformacoesLote
Tipo que representa as informaes do lote processado
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
NumeroLote
tpNumero
0-1
Nmero do lote.
InscricaoPrestador
1-1
Inscrio Municipal do prestador dos RPS contidos no lote.
CPFCNPJRemetente
tpCPFCNPJ
1-1
CPF/CNPJ do remetente autorizado a transmitir a mensagem XML.
DataEnvioLote
dateTime
1-1
Data/Hora do envio do lote (AAAA-MM-DDThh:mm:ss).
QtdNotas
tpQuantidade
1-1
Quantidade de RPS contidos no lote.
TempoProcessamento
tpTempoProcessamento
1-1
Tempo de processamento do lote.
ValorTotalServicos
tpValor
1-1
Valor total dos servios dos RPS contidos na mensagem XML.
ValorTotalDeducoes
tpValor
0-1
Valor total das dedues dos RPS contidos na mensagem XML.
27/6/2013
Pgina 29 de 73

tpNFe
Tipo que representa uma NFS-e
Nome do Elemento
Assinatura
Tipo do Elemento
tpAssinatura
Ocorrncia
Descrio
0-1
Assinatura do RPS que gerou a NFS-e (conforme especificado no Item

4.3.2).
ChaveNFe
tpChaveNFe
1-1
Chave de identificao da NFS-e (ver detalhes na tabela

tpChaveNFe).
DataEmissaoNFe
dateTime
1-1
Data/Hora da emisso da NFS-e (AAAA-MM-DDThh:mm:ss).
NumeroLote
tpNumero
0-1
Nmero do lote que gerou a NFS-e.
ChaveRPS
tpChaveRPS
0-1
Chave de identificao do RPS (ver detalhes na tabela tpChaveRPS).
TipoRPS
tpTipoRPS
0-1
Tipo do RPS.
DataEmissaoRPS
date
0-1
Data da emisso do RPS.
CPFCNPJPrestador
tpCPFCNPJ
1-1
CPF/CNPJ do prestador.
RazaoSocialPrestador
tpRazaoSocial
1-1
Nome / Razo Social do prestador.
EnderecoPrestador
tpEndereco
1-1
Endereo do prestador.
EmailPrestador
tpEmail
0-1
E-mail do prestador.
StatusNFe
tpStatusNFe
1-1
Status da NFS-e.
DataCancelamento
date
0-1
Se a NFS-e tiver sido cancelada, este campo ser preenchido com a
TributacaoNFe
tpTributacaoNFe
1-1
Tipo de tributao da NFS-e.
OpcaoSimples
tpOpcaoSimples
1-1
Tipo de opo pelo Simples.
NumeroGuia
tpNumero
0-1
Nmero da guia vinculada a NFS-e.
DataQuitacaoGuia
Date
0-1
Data de quitao da guia vinculada a NFS-e.
data de cancelamento da NFS-e (AAAA-MM-DDThh:mm:ss).
ValorServicos
tpValor
1-1
Valor dos servios em R$.
ValorDeducoes
tpValor
0-1
Valor das dedues em R$.
ValorPIS
tpValor
0-1
Valor da reteno do PIS em R$.
ValorCOFINS
tpValor
0-1
Valor da reteno do COFINS em R$.
ValorINSS
tpValor
0-1
Valor da reteno do INSS em R$.
ValorIR
tpValor
0-1
Valor da reteno do IR em R$.
ValorCSLL
tpValor
0-1
Valor da reteno do CSLL em R$.
CodigoServicos
tpCodigo
1-1
Cdigo do servio prestado.
AliquotaServicos
tpAliquota
1-1
Alquota do servio prestado.
ValorISS
tpValor
1-1
Valor do ISS em R$.
ValorCredito
tpValor
1-1
Valor do crdito gerado.
ISSRetido
Boolean
1-1
Reteno do ISS. Preencher com:

"true" - para NFS-e com ISS Retido;
"false" - para NFS-e sem ISS Retido
CPFCNPJTomador
tpCPFCNPJ
0-1
CPF/CNPJ do tomador.
InscricaoMunicipalTomador
0-1
Inscrio Municipal do tomador.
InscricaoEstadualTomador
tpInscricaoEstadual
0-1
Inscrio Estadual do tomador.
RazaoSocialTomador
tpRazaoSocial
0-1
Nome / Razo Social do tomador.
EnderecoTomador
tpEndereco
0-1
Endereo do tomador.
EmailTomador
tpEmail
0-1
E-mail do tomador.
Discriminacao
tpDiscriminacao
1-1
Discriminao dos servios.
27/6/2013
Pgina 30 de 73

27/6/2013
Pgina 31 de 73

tpRPS
Tipo que representa RPS
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
Assinatura
tpAssinatura
1-1
Assinatura do RPS emitido (conforme especificado no Item 4.3.2).
ChaveRPS
tpChaveRPS
1-1
Chave de identificao do RPS (ver detalhes na tabela
TipoRPS
tpTipoRPS
1-1
Tipo do RPS.
DataEmissao
date
1-1
Data da emisso do RPS.
StatusRPS
tpStatusNFe
1-1
Status do RPS.
TributacaoRPS
tpTributacaoNFe
1-1
Tipo de tributao do RPS.
tpChaveRPS).
ValorServicos
tpValor
1-1
Valor dos servios em R$.
ValorDeducoes
tpValor
1-1
Valor das dedues em R$.
ValorPIS
tpValor
0-1
Valor da reteno do PIS em R$.
ValorCOFINS
tpValor
0-1
Valor da reteno do COFINS em R$.
ValorINSS
tpValor
0-1
Valor da reteno do INSS em R$.
ValorIR
tpValor
0-1
Valor da reteno do IR em R$.
ValorCSLL
tpValor
0-1
Valor da reteno do CSLL em R$.
CodigoServicos
tpCodigo
1-1
Cdigo do servio prestado.
AliquotaServicos
tpAliquota
1-1
Alquota do servio prestado.
ISSRetido
Boolean
1-1
Reteno do ISS. Preencher com:

"true" - para NFS-e com ISS Retido;
"false" - para NFS-e sem ISS Retido
CPFCNPJTomador
tpCPFCNPJ
0-1
CPF/CNPJ do tomador do servio.
InscricaoMunicipalTomador
0-1
Inscrio Municipal do tomador.

ATENO 1: Este elemento s dever ser preenchido para
tomadores estabelecidos no municpio de Blumenau(CMC).
ATENO 2: O preenchimento deste elemento implica na
obrigatoriedade do preenchimento do elemento CPFCNPJTomador.
Ser verificado se o CNPJ vinculado ao CMC corresponde ao CNPJ
informado no elemento CPFCNPJTomador.
InscricaoEstadualTomador
tpInscricaoEstadual
0-1
Inscrio Estadual do tomador.
RazaoSocialTomador
tpRazaoSocial
0-1
Nome / Razo Social do tomador.
EnderecoTomador
tpEndereco
0-1
Endereo do tomador.
EmailTomador
tpEmail
0-1
E-mail do tomador.
Discriminacao
tpDiscriminacao
1-1
Discriminao dos servios.
27/6/2013
Pgina 32 de 73

4.3
SERVIOS E MTODOS
A seguir so descritos cada um dos servios disponibilizados pelo Web Service LoteNFe, bem como
seus respectivos mtodos e schemas XML de pedido e de retorno do servio.
4.3.1
Regras Gerais
Parmetros
Todos os mtodos de pedido de servio disponveis recebem dois parmetros conforme o exemplo:
<Nome do Mtodo>(<Parmetro VersaoSchema>, <Parmetro MensagemXML>)
Onde,
Parmetro VersaoSchema: Verso do Schema XML utilizado para montar a mensagem XML de pedido
do servio (tipo de dado: Integer);
Parmetro MensagemXML: Mensagem XML de pedido do servio (tipo de dado: String).
Todos os mtodos retornam uma mensagem XML de retorno no respectivo Schema XML de retorno do
servio pedido (string). Todos os Schemas XML de retorno contem uma TAG chamada Sucesso no
cabealho. Esta TAG indica se o pedido foi atendido com sucesso (true) ou no (false) conforme
descrito a seguir:
Sucesso: True
Caso todo o pedido do servio tenha sido processado sem que ocorram eventos de erro.
Sendo assim, o Web Service transmitir uma mensagem XML de retorno do respectivo
servio informando o sucesso da operao (TAG sucesso = true) e as demais informaes
pertinentes ao respectivo Schema de Retorno. Caso ocorram eventos de alerta durante o
processamento, os alertas gerados sero apresentados na mensagem XML de retorno.
Eventos de alerta no impedem que o pedido seja atendido com sucesso.
Sucesso: False
Caso ocorra algum evento de erro durante o processamento do pedido do servio. Sendo
assim, o Web Service transmitir uma mensagem XML de retorno do respectivo servio
27/6/2013
Pgina 33 de 73

informando o no sucesso da operao (TAG sucesso = false) e as demais Informaes

sobre os eventos de erro/alerta ocorridos.
27/6/2013
Pgina 34 de 73

Observaes:
Descrio dos nomes e abreviaes utilizadas no cabealho das tabelas que representam estrutura
definida nos schemas XML:
<nome do arquivo .xsd>
#
P1
Campo
Descrio
Ele.
Pai
Tipo
Ocorr.
1-1
Verso do XML Schema Utilizado.
P1
tpVersao
1-1
Data de incio do perodo transmitido.
P1
1-1
Cabecalho
TAG de grupo das informaes do
Versao
dtInicio
Observao
cabealho
(AAAA-MM-DD)
A. Coluna #: Cdigo de identificao do campo. Este cdigo utilizado por um elemento filho
identificar seu elemento pai na coluna Pai;
B. Coluna Descrio: Descrio do campo;
C. Coluna Ele.:
A - indica que o campo um atributo do Elemento anterior;
E - indica que o campo um Elemento;
CE indica que o campo um Elemento que deriva de uma Escolha (Choice);
G indica que o campo um Elemento de Grupo;
CG - indica que o campo um Elemento de Grupo que deriva de uma Escolha (Choice);
D. Coluna Pai: Indica qual o elemento pai;
E. Coluna Tipo:
Tipos Base:
N campo numrico;
C campo alfanumrico;
D campo data;
Tipos Simples e Tipos Complexos:
Coluna Ocorr.: x - y, onde x indica a ocorrncia mnima e y a ocorrncia mxima;
Para obter a verso mais recente dos Schemas XML acesse o link:
https://nfse.blumenau.sc.gov.br/ws/schemas.zip
27/6/2013
Pgina 35 de 73

4.3.2
I.
Envio de RPS
Descrio: Este mtodo responsvel por atender aos pedidos de Envio Individual de RPS para
substituio por NFS-e.
II. Mtodo: EnvioRPS

III. Mensagem XML: O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme
tabela a seguir:
PedidoEnvioRPS.xsd*
#
P1
Campo
Descrio
Cabecalho
TAG de grupo das
Versao
Verso do XML Schema
CNPJRemetente
CNPJ
Ele
Pai
Tipo
Ocorr
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
Observao
informaes do cabealho.
Utilizado.
autorizado
do
a
Remetente
transmitir
mensagem XML.
P2
RPS
Recibo Provisrio de Servio.
tpRPS
1-1
P3
Signature
Assinatura digital da
SignatureType
1-1
mensagem XML.
Signature o elemento raiz de

uma assinatura XML. Este
elemento descrito no arquivo
xmldsig-core-schema_v01.xsd
* Representao da estrutura definida no schema XML PedidoEnvioRPS.xsd.

Observao: Assinatura Adicional
O RPS dever ter uma assinatura digital. Esta assinatura utilizar o mesmo certificado digital usado
na assinatura da mensagem XML (item 3.2.2A), com os mesmos padres de criptografia assimtrica
RSA e algoritmo message digest SHA-1.
27/6/2013
Pgina 36 de 73

Para criar a assinatura dever ser gerado um Hash (utilizando SHA1) de uma cadeia de caracteres
(ASCII) com informaes do RPS emitido. Este Hash dever ser assinado utilizando RSA. A
assinatura do Hash ser informada na TAG Assinatura (tipo RPS apresentado no item 4.2.1).
A cadeia de caracteres a ser assinada dever conter 86 posies com as informaes apresentadas
na tabela a seguir:
#
1
Informao
Inscrio
Municipal
Contedo
do
Inscrio Municipal do Prestador com 8 posies (dgitos). Completar com zeros
Prestador
esquerda caso seja necessrio.
Srie do RPS
Srie do RPS com 5 posies (caracteres). Completar com espaos em branco direita
caso seja necessrio.
Ateno: No utilize espaos esquerda. O contedo dever estar alinhado a esquerda.
Nmero do RPS
Nmero do RPS com 12 posies (dgitos). Completar com zeros esquerda caso seja
Data de Emisso do RPS
Data de emisso do RPS no formato AAAAMMDD (caracteres).
Tipo de Tributao do RPS
Tipo de Tributao do RPS com 1 posio (caractere):
necessrio.
T - Tributao no municipio de Blumenau;

F - Tributao fora do municipio de Blumenau;
I Isento;
J - ISS Suspenso por Deciso Judicial.
6
Status do RPS
Status do RPS com 1 posio (caractere):

N Normal;
C Cancelado;
E Extraviado.
ISS Retido
Valor S (SIM) para ISS Retido (caractere).
Valor dos Servios
Valor dos Servios do RPS, incluindo os centavos (sem ponto decimal e sem R$), com 15
Valor N (NO) para Nota Fiscal sem ISS Retido.
posies (dgitos).
Exemplo:
R$ 500,85 000000000050085
R$ 500,00 000000000050000
9
Valor das Dedues
Valor das Dedues do RPS, incluindo os centavos (sem ponto decimal e sem R$), com
15 posies (dgitos).
Exemplo:
R$ 500,85 000000000050085
R$ 500,00 000000000050000
10
Cdigo do Servio Prestado
Cdigo do Servio do RPS com 5 posies (dgitos). Completar com zeros esquerda
caso seja necessrio.
11
Indicador de CPF/CNPJ do
Indicador de CPF/CNPJ com 1 posio (dgito).
Tomador
Valor 1 para CPF.

Valor 2 para CNPJ.
Valor 3 para No-Informado
12
CPF/CNPJ do Tomador
CPF/CNPJ do tomador com 14 posies (dgitos). Sem formatao (ponto, trao, barra,
....). Completar com zeros esquerda caso seja necessrio. Se o Indicador do CPF/CNPJ
for 3 (no-informado), preencher com 14 zeros.
27/6/2013
Pgina 37 de 73

27/6/2013
Pgina 38 de 73

Passos bsicos para assinatura de um RPS:

1 - Monte a string de caracteres conforme a tabela a apresentada anteriormente.
A seguir apresentamos o exemplo de parte de uma mensagem XML de pedido de envio de RPS (os
campos utilizados na montagem da cadeia de caracteres esto em negrito).
...
<ChaveRPS>
<InscricaoPrestador>31000</InscricaoPrestador>
<SerieRPS>OL03</SerieRPS>
<NumeroRPS>1</NumeroRPS>
</ChaveRPS>
<TipoRPS>RPS-M</TipoRPS>
<DataEmissao>2011-01-03</DataEmissao>
<StatusRPS>N</StatusRPS>
<TributacaoRPS>T</TributacaoRPS>
<ValorServicos>20500</ValorServicos>
<ValorDeducoes>5000</ValorDeducoes>
<CodigoServico>2658</CodigoServico>
<AliquotaServicos>0.05</AliquotaServicos>
<ISSRetido>false</ISSRetido>
<CPFCNPJTomador>
<CPF>13167474254</CPF>
</CPFCNPJTomador>
...
Com base no trecho da mensagem XML apresentada, montamos a seguinte string de caracteres:
"00031000OL03 00000000000120110103TNN00000000205000000000000050000002658100013167474254"
Note que o valor dos servios (R$ 20.500,00) foi transformado em 2050000, o valor de
dedues (R$ 5.000,00) foi transformado em 500000. Tambm foi acrescentado srie do RPS
um espao em branco direita para preencher as 5 posies. A srie do RPS deve estar em
maiscula para ser assinada.
2 - Converta a cadeia de caracteres ASCII para bytes.

3 - Gere o HASH (array de bytes) utilizando SHA1.
4 - Assine o HASH (array de bytes) utilizando RSA-SHA1.
ATENO! Na maioria das linguagens de programao, os passos 3 e 4 so feitos atravs de uma
nica funo. Verifique a documentao de sua linguagem para evitar assinar um hash de um hash.
27/6/2013
Pgina 39 de 73

IV. Schema da Mensagem XML do Retorno: RetornoEnvioRPS.xsd

RetornoEnvioRPS.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
Versao
P1
tpVersao
1-1
Sucesso
Status do Pedido de Envio de Lote
P1
tpSucesso
1-1
tpEvento
0-N
tpEvento
0-N
tpChaveNFeRPS
0-1
de RPS.
P2
Alerta
Informaes sobre a ocorrncia de

eventos
geradores
durante
de
alertas
processamento
da
mensagem XML.
P3
Erro

eventos
geradores
durante
de
processamento
erros
da
mensagem XML.
P4
ChaveNFeRPS
Chave do RPS e Chave da NFS-e

gerada.
* Representao da estrutura definida no schema XML RetornoEnvioRPS.xsd.

V. Formato das Mensagens SOAP:
Pedido:
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<EnvioRPSRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
<VersaoSchema>1</VersaoSchema>
<MensagemXML>INCLUIR AQUI A MENSAGEM XML CONFORME ITEM III</MensagemXML>
</EnvioRPSRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<EnvioRPSResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
<RetornoXML>MENSAGEM XML DE RETORNO CONFORME ITEM IV</RetornoXML>
</EnvioRPSResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 40 de 73

27/6/2013
Pgina 41 de 73

4.3.3
I.
Envio de Lote de RPS (EnvioLoteRPS)
Descrio: Este mtodo responsvel por atender aos pedidos de Envio de Lote de RPS para
substituio por NFS-e.
II. Mtodo: EnvioLoteRPS

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:
PedidoEnvioLoteRPS.xsd*
#
P1
Campo
Cabecalho
Descrio
TAG de grupo das
Ele
Pai
Tipo
Ocorr
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
P1
boolean
0-1
Observao
informaes do cabealho.
Versao
Verso do XML Schema

Utilizado.
CNPJRemetente
CNPJ
do
autorizado
Remetente
transmitir
mensagem XML.
Transacao
Informe se os RPS a serem
True - Os RPS s sero
substitudos por NFS-e faro
substitudos por NFS-e se no
parte
ocorrer nenhum evento de erro
de
uma
mesma
transao.
durante o processamento de
todo o lote.
False - Os RPS vlidos sero
substitudos por NFS-e, mesmo
que ocorram eventos de erro
durante processamento de
outros RPS deste lote.
Default: true.
dtInicio
Data de incio do perodo
P1
1-1
(AAAA-MM-DD)
P1
1-1
(AAAA-MM-DD)
transmitido.
dtFim
Data
final
do
perodo
27/6/2013
Pgina 42 de 73

PedidoEnvioLoteRPS.xsd*
#
Campo
Descrio
Ele
Pai
Tipo
Ocorr
P1
tpQuantidade
1-1
P1
tpValor
1-1
P1
tpValor
1-1
Observao
transmitido.
QtdRPS
Quantidade de RPS contidos

no lote.
ValorTotalServicos
Valor total dos servios dos
ValorTotalDeducoes
Valor total das dedues dos
RPS contidos no lote.
RPS/Cupom contidos no lote.

P2
RPS
Recibo Provisrio de Servio.
tpRPS
1-50
P3
Signature
SignatureType
1-1
Signature o elemento raiz de
mensagem XML.
uma assinatura XML. Este

elemento descrito no arquivo
xmldsig-core-schema_v01.xsd
* Representao da estrutura definida no schema XML PedidoEnvioLoteRPS.xsd.

Observao 1: Assinatura Adicional
Cada RPS enviado no lote dever ser assinado digitalmente conforme especificado no item 4.3.2
(Envio de RPS).
Observao 2: Transao
Se ocorrerem eventos de erro de validao dos dados do cabealho do pedido de envio de lote de
RPS, independente da opo informada no campo Transao, nenhum RPS ser substitudo por
NFS-e.
IV. Schema da Mensagem XML do Retorno: RetornoEnvioLoteRPS.xsd
RetornoEnvioLoteRPS.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
Versao
P1
tpVersao
1-1
Sucesso
Status do Pedido de Envio de Lote
P1
tpSucesso
1-1
de RPS.
P2
InformacoesLote
Informaes sobre o Lote.
P1
tpInformacoesLote
0-1
Alerta
tpEvento
0-N
tpEvento
0-N
tpChaveNFeRPS
0-50
eventos
geradores
durante
de
alertas
processamento
da
mensagem XML.
P3
Erro

eventos
geradores
durante
de
processamento
erros
da
mensagem XML.
P4
ChaveRPSNFe
Chave do RPS e Chave da NFS-e
27/6/2013
Pgina 43 de 73

gerada.
* Representao da estrutura definida no schema XML RetornoEnvioLoteRPS.xsd.

Observao: Transao
Para pedidos de envio de lote de RPS com transao (Transacao = True), o campo
InformacoesLote retornar (dentre outras informaes) o total dos servios, o total das dedues e a
quantidade de RPS enviados na mensagem XML de pedido do servio.
Para pedidos de envio de lote de RPS sem transao (Transacao = False), o campo
InformacoesLote retornar (dentre outras informaes) o total dos servios, o total das dedues e a
quantidade de RPS que efetivamente foram substitudos por NFS-e.
Pedido:
<soap:Body>
<EnvioLoteRPSRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</EnvioLoteRPSRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<EnvioLoteRPSResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</EnvioLoteRPSResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 44 de 73

4.3.4
I.
Teste de Envio de Lote de RPS (TesteEnvioLoteRPS)
Descrio: Este mtodo responsvel por atender aos pedidos de Teste de Envio de Lote de RPS
para substituio por NFS-e. Este mtodo no substitui os RPS por NFS-e.
Observao:
Conforme informado no item 2.3, este mtodo dever ser usado apenas na fase de adaptao dos
sistemas dos contribuintes. Nos casos de sistemas j adaptados, seu uso resulta em duplicidade de
esforos desnecessrios, pois as verificaes feitas no mtodo TesteEnvioLoteRPS so as mesmas
realizadas pelo mtodo EnvioLoteRPS.
II. Mtodo: TesteEnvioLoteRPS

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela apresentada
no item V
IV. Schema da Mensagem XML do Retorno: RetornoEnvioLoteRPS.xsd
(Idntico ao Schema da Mensagem XML do Retorno do item V)
27/6/2013
Pgina 45 de 73

4.3.5
I.
Pedido de Consulta de NFS-e (ConsultaNFe)
Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NFS-e / RPS. Seu
acesso permitido apenas pela chave de identificao da NFS-e ou pela chave de identificao do
RPS.
II. Mtodo: ConsultaNFe

PedidoConsultaNFe.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
Versao
P1
tpVersao
1-1
CNPJRemetente
CNPJ do Remetente autorizado a
P1
tpCPFCNPJ
1-1
1-50
tpChaveRPS
1-1
enviar a mensagem XML.

P2
Detalhe
ChaveRPS
Chave do RPS.
CE
P2
ChaveNFe
Chave da NFS-e.
CE
P2
tpChaveNFe
1-1
Signature
Assinatura digital da mensagem
SignatureType
1-1
detalhe.
P3
XML.
Signature o
elemento raiz de
uma assinatura
XML. Este
elemento
descrito no
arquivo xmldsigcoreschema_v01.xsd
27/6/2013
Pgina 46 de 73

*Representao da estrutura definida no schema XML PedidoConsultaNFe.xsd.

IV. Schema da Mensagem XML do Retorno: RetornoConsulta.xsd
RetornoConsulta.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
P2
Versao
P1
tpVersao
1-1
Sucesso
Status do Envio de Lote.
P1
tpSucesso
1-1
Alerta
Informaes
tpEvento
0-N
tpEvento
0-N
tpNFe
0-50
sobre
ocorrncia
de
eventos geradores de alertas durante o

processamento da mensagem XML.
P3
Erro
Informaes
sobre
ocorrncia
de
eventos geradores de erros durante o

P4
NFe
Elemento NFe - pode se repetir quantas

vezes for necessrio (respeitando o limite
de mmimo estabelecido). Cada item ser
um NFS-e.
* Representao da estrutura definida no schema XML RetornoConsulta.xsd.

Pedido:
<soap:Body>
<ConsultaNFeRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<ConsultaNFeResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 47 de 73

27/6/2013
Pgina 48 de 73

4.3.6
I.
Pedido de Consulta de NFS-e Recebidas (ConsultaNFeRecebidas)
Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NFS-e Recebidas.
II. Mtodo: ConsultaNFeRecebidas

PedidoConsultaNFePeriodo.xsd*
#
P1
Campo
Cabecalho
Descrio
TAG de grupo das
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
P1
tpCPFCNPJ
1-1
P1
0-1
Observao
informaes do
cabealho.
Versao
Verso do XML
Schema Utilizado.
CPFCNPJRemeten
CPF/CNPJ
te
Remetente autorizado
do
a enviar a mensagem
XML.
CPFCNPJ
Para consulta de
NFS-e Recebidas:
Informe o CPF/CNPJ
do tomador da NFS-e.
Para consulta de
NFS-e Emitidas:
Informe o CNPJ do
emissor da NFS-e.
Inscricao
Para consulta de
ATENO 1: Este campo
NFS-e Recebidas:
s dever ser preenchido
Informe a Inscrio
com a inscrio de
Municipal do
contribuintes estabelecidos
Tomador.
no municpio de Blumenau
27/6/2013
Pgina 49 de 73

Para consulta de
(CMC).
NFS-e Emitidas:
Informe a Inscrio
Municipal do
Prestador. Neste tipo
de consulta o
preenchimento deste
campo se torna
obrigatrio.
dtInicio
Data incio da
P1
1-1
consulta.
dtFim
Data fim da consulta.
P1
1-1
NumeroPagina **
Nmero da pgina
P1
tpNumero
1-1
Default = 1
Signature
SignatureType
1-1
Signature o elemento raiz
consultada
P2
mensagem XML.
de uma assinatura XML. Este

elemento descrito no
arquivo xmldsig-coreschema_v01.xsd
* Representao da estrutura definida no schema XML PedidoConsultaNFePeriodo.xsd. Os mtodos

ConsultaNFeRecebidas e ConsultaNFeEmitidas utilizam o mesmo schema XML para o pedido do
servio.
** Conforme especificado no Schema XML RetornoConsulta.xsd (utilizado no retorno dos pedidos de
Consulta de NFS-e, Consulta de NFS-e Recebidas, Consulta de NFS-e Emitidas e Consulta de Lote) s
sero retornadas at 50 NFS-e por consulta. Porm a Consulta de NFS-e Recebidas (assim como a
Consulta de NFS-e Emitidas) pode encontrar uma quantidade maior de NFS-e do que o limite
especificado.
Sendo assim, as NFS-e encontradas sero agrupadas em pginas com at 50 NFS-e. Para consultar as
NFS-e de cada uma das pginas o contribuinte dever transmitir uma mensagem XML de pedido de
Consulta de NFS-e Recebidas indicando qual pgina deseja consultar. Desta forma, caso um pedido de
consulta de NFS-e Recebidas, para pgina X, retorne 50 NFS-e o sistema de informao do
Contribuinte deve efetuar novo pedido de Consulta de NFS-e Recebidas, para pgina X+1, para verificar
se existem mais NFS-e Recebidas no perodo consultado.
Quando o sistema de informao do Contribuinte efetuar um pedido de Consulta de NFS-e Recebidas
para uma determinada pgina e est consulta retornar menos que 50 NFS-e o sistema de informao
do contribuinte saber que estas so as ltimas NFS-e recebidas para o perodo consultado e que por
tanto est a ltima pgina. Se o Web Service retornar uma mensagem XML informando sucesso (tag
sucesso = true) e sem nenhuma NFS-e por que a pgina consultada no existe.
27/6/2013
Pgina 50 de 73

Exemplo:
O sistema de informao de um Contribuinte envia uma mensagem XML de Pedido Consulta de NFS-e
Recebidas para o perodo de 01/09/2010 30/09/2010 e requerendo a pgina 1. Para este pedido so
encontradas 137 NFS-e recebidas. As 137 NFS-e so agrupadas em trs pginas: Pgina 1 com as
primeiras 50 NFS-e (1 50); pgina 2 com as prximas 50 NFS-e (51 100) e pgina 3 com as 37
NFS-e restantes (101 137). O Web Service retorna uma mensagem XML com a pgina requerida
(pgina 1). Ao receber a mensagem XML de retorno o sistema de informao do Contribuinte verifica
que foram retornadas 50 NFS-e para a pgina 1. O sistema de informao do Contribuinte envia outra
mensagem XML de Pedido Consulta de NFS-e Recebidas para o mesmo perodo, mas desta vez
requerendo a prxima pgina (pgina 2). O Web Service retorna uma mensagem XML com a pgina
requerida (pgina 2). Ao receber a mensagem XML de retorno o sistema de informao do Contribuinte
verifica que foram retornadas 50 NFS-e para a pgina 2. O sistema de informao do Contribuinte envia
outra mensagem XML de Pedido Consulta de NFS-e Recebidas para o mesmo perodo, mas desta vez
requerendo a prxima pgina (pgina 3). O Web Service retorna uma mensagem XML com a pgina
requerida (pgina 3). Ao receber a mensagem XML de retorno o sistema de informao do Contribuinte
verifica que foram retornadas 37 NFS-e para a pgina 3 e por tanto no existem mais NFS-e recebidas
para o perodo consultado.
Obs.: As NFS-e encontradas so ordenadas por data de emisso da NFS-e (ou data do cancelamento,
caso a NFS-e tenha sido cancelada) e pela inscrio municipal (CMC) do prestador que emitiu a NFS-e.
Abaixo, fluxo de funcionamento baseado no exemplo descrito:
27/6/2013
Pgina 51 de 73


(Idntico ao do item 4.3.5)
Pedido:
<soap:Body>
<ConsultaNFeRecebidasRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeRecebidasRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<ConsultaNFeRecebidasResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeRecebidasResponse>
</soap:Body>
27/6/2013
Pgina 52 de 73

</soap:Envelope>
27/6/2013
Pgina 53 de 73

4.3.7
I.
Pedido de Consulta de NFS-e Emitidas (ConsultaNFeEmitidas)
Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NFS-e Emitidas.
II. Mtodo: ConsultaNFeEmitidas

III. O parmetro MensagemXML (idntico ao Schema da Mensagem XML de pedido apresentado no
item 4.3.6 III).
VI. Schema da Mensagem XML do Retorno: RetornoConsulta.xsd
VII. Formato das Mensagens SOAP:
Pedido:
<soap:Body>
<ConsultaNFeEmitidasRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeEmitidasRequest>
</soap:Body>
</soap:Envelope>
Retorno:
27/6/2013
Pgina 54 de 73

<soap:Body>
<ConsultaNFeEmitidasResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaNFeEmitidasResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 55 de 73

4.3.8
I.
Pedido de Consulta de Lote (ConsultaLote)
Descrio: Este mtodo responsvel por atender aos pedidos de Consulta de Lote de NFS-e
geradas a partir do mtodo EnvioLoteRPS.
II. Mtodo: ConsultaLote

PedidoConsultaLote.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
TAG de grupo das informaes
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
ser
P1
tpNumero
1-1
SignatureType
1-1
Observao
do cabealho.
Versao
Verso do XML Schema

Utilizado.
CNPJRemetente
CNPJ do Remetente autorizado

a enviar a mensagem XML.
NumeroLote
Nmero
do
lote
consultado.
P2
Signature
XML.
Signature o
elemento raiz de uma
assinatura XML. Este
elemento descrito
no arquivo xmldsigcore-schema_v01.xsd
* Representao da estrutura definida no schema XML PedidoConsultaLote.xsd.

27/6/2013
Pgina 56 de 73


Pedido:
<soap:Body>
<ConsultaLoteRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaLoteRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<ConsultaLoteResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaLoteResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 57 de 73

4.3.9
I.
Pedido de Informaes do Lote (ConsultaInformacoesLote)
Descrio: Este mtodo responsvel por atender aos pedidos de Consulta de Informaes de Lote
de NFS-e geradas a partir do mtodo EnvioLoteRPS.
II. Mtodo: ConsultaInformacoesLote

PedidoInformaesLote.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
Versao
P1
tpVersao
1-1
CNPJRemetente
P1
tpCPFCNPJ
1-1
NumeroLote
Nmero do lote a ser consultado.
P1
tpNumero
0-1

Caso no seja
informado o nmero do
lote, sero retornadas
informaes do ltimo
lote gerador de NFS-e.
InscricaoPrestador
Inscrio municipal do prestador
P1
1-1
SignatureType
1-1
de servios que gerou o lote a ser

consultado.
P2
Signature

XML.
Signature o elemento
raiz de uma assinatura
XML. Este elemento
descrito no arquivo
xmldsig-coreschema_v01.xsd
27/6/2013
Pgina 58 de 73

* Representao da estrutura definida no schema XML PedidoInformacoesLote.xsd.

IV. Schema da Mensagem XML do Retorno: RetornoInformacoesLote.xsd
RetornoInformacoesLote.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho
P2
Versao
Verso do XML Schema Utilizado
P1
tpVersao
1-1
Sucesso
Status do Envio de Lote
P1
tpSucesso
1-1
InformacoesLote
Informaes sobre o Lote
P1
tpInformacoesLote
0-1
Alerta
tpEvento
0-N
tpEvento
0-N
eventos
geradores
durante
de
alertas
processamento
da
mensagem XML.
P3
Erro

eventos
geradores
durante
de
processamento
erros
da
mensagem XML.
* Representao da estrutura definida no schema XML RetornoInformacoesLote.xsd.

Pedido:
<soap:Body>
<ConsultaInformacoesLoteRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaInformacoesLoteRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<ConsultaInformacoesLoteResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaInformacoesLoteResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 59 de 73

4.3.10 Pedido de Cancelamento de NFS-e (CancelamentoNFe)
I.
Descrio: Este mtodo responsvel por atender aos pedidos referentes ao cancelamento de
NFS-e geradas a partir do mtodo EnvioLoteRPS.
II. Mtodo: CancelamentoNFe

PedidoCancelamentoNFe.xsd*
#
P1
Campo
Cabecalho
Descrio
TAG de grupo das
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
P1
boolean
0-1
Observao
informaes do cabealho
Versao
Verso do XML Schema

Utilizado
CNPJRemetente
CNPJ
autorizado
do
Remetente
a
enviar
mensagem XML
Transacao
Informe se as NFS-e a serem
True - As NFS-e s
canceladas faro parte de
sero canceladas se
uma mesma transao.
no ocorrer nenhum
evento de erro
durante o
processamento de
todo o lote.
False - As NFS-e
aptas a serem
canceladas sero
canceladas, mesmo
que ocorram eventos
de erro durante
27/6/2013
Pgina 60 de 73

processamento do
cancelamento de
outras NFS-e deste
lote.
Default: true.
P2
Detalhe
TAG de grupo das
ChaveNFe
AssinaturaCancelamento
1-50
Chave da NFS-e.
P2
tpChaveNFe
1-1
Assinatura de cancelamento
P2
tpAssinaturaCancela
1-1
informaes do detalhe.
da NFS-e.
P3
Signature
mento
SignatureType
1-1
mensagem XML.
Signature o
elemento raiz de uma
assinatura XML. Este
elemento descrito
no arquivo xmldsigcore-schema_v01.xsd
* Representao da estrutura definida no schema XML PedidoCancelamentoNFe.xsd.

Observao 1: Transao
Se ocorrerem eventos de erro de validao dos dados do cabealho do pedido de cancelamento de
NFS-e, independente da opo informada no campo Transao, nenhuma NFS-e ser cancelada.
Observao 2: Assinatura Adicional
Cada NFS-e a ser cancelada (representada pela TAG ChaveNFe) dever ter sua respectiva
assinatura de cancelamento.
Esta assinatura utilizar o mesmo certificado digital usado na assinatura da mensagem XML (item
3.2.2A), com os mesmos padres de criptografia assimtrica RSA e algoritmo message digest SHA1.
Para criar a assinatura dever ser gerado um Hash (utilizando SHA1) de uma cadeia de caracteres
(ASCII) com informaes da NFS-e a ser cancelada. Este Hash dever ser assinado utilizando RSA.
A assinatura do Hash ser informada na TAG AssinaturaCancelamento.
A cadeia de caracteres a ser assinada dever conter 20 posies com as informaes apresentadas
na tabela a seguir:
#
1
Informao
Inscrio
Municipal
Contedo
do
Inscrio Municipal do Prestador com 8 posies (dgitos). Completar com zeros
Prestador
esquerda caso seja necessrio.
Nmero da NFS-e
Nmero da NFS-e com 12 posies (dgitos). Completar com zeros esquerda caso seja
27/6/2013
Pgina 61 de 73

necessrio.
Passos bsicos para assinatura de cancelamento de uma NFS-e:

1 - Monte a string de caracteres conforme a tabela a apresentada anteriormente.
A seguir apresentamos o exemplo de um trecho de uma mensagem XML de pedido de
cancelamento de NFS-e (os campos utilizados na montagem da cadeia de caracteres esto em
negrito).
...
<ChaveNFe>
<InscricaoPrestador>31000</InscricaoPrestador>
<NumeroNFe>9</NumeroNFe>
</ChaveNFe>
...
Com base no trecho da mensagem XML apresentada, montamos a seguinte String de caracteres:
"00031000000000000009"
2 - Converta a cadeia de caracteres ASCII para bytes.
3 - Gere o HASH (array de bytes) utilizando SHA1.
4 - Assine o HASH (array de bytes) utilizando RSA-SHA1.
ATENO! Na maioria das linguagens de programao, os passos 3 e 4 so feitos atravs de uma
nica funo. Verifique a documentao de sua linguagem para evitar assinar um hash de um hash.
IV. Schema da Mensagem XML do Retorno: RetornoCancelamentoNFe.xsd
RetornoCancelamentoNFe
#
P1
Descrio
Ele
Pai
Tipo
Ocorr.
Cabecalho
Campo
1-1
Versao
P1
tpVersao
1-1
Sucesso
Status do cancelamento.
P1
tpSucesso
1-1
Alerta
tpEvento
0-N
tpEvento
0-N
Observao
cabealho.
P2
eventos
geradores
durante
de
alerta
processamento
da
mensagem XML.
P3
Erro

eventos
geradores
de
erros
27/6/2013
Pgina 62 de 73

durante
processamento
da
mensagem XML
* Representao da estrutura definida no schema XML RetornoCancelamentoNFe.xsd.

O Sistema da NFS-e verificar se a NFS-e existe e se no h nenhum impedimento para o
cancelamento.
O cancelamento poder ser realizado para vrias notas numa mesma mensagem XML (Obedecendo ao
limite de 50).
Pedido:
<soap:Body>
<CancelamentoNFeRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</CancelamentoNFeRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<CancelamentoNFeResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</CancelamentoNFeResponse>
</soap:Body>
</soap:Envelope>
27/6/2013
Pgina 63 de 73

4.3.11 Pedido de Consulta de CNPJ (ConsultaCNPJ)
I.
Descrio: Este mtodo responsvel por atender aos pedidos de consulta de CNPJ. Este mtodo
possibilita aos tomadores e/ou prestadores de servios consultarem quais Inscries Municipais
(CMC) esto vinculadas a um determinado CNPJ e se estes CMC emitem NFS-e ou no.
II. Mtodo: ConsultaCNPJ

PedidoConsultaCNPJ.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
Versao
P1
tpVersao
1-1
CNPJRemetente
P1
tpCPFCNPJ
1-1
tpCPFCNPJ
1-1
SignatureType
1-1

P2
CNPJContribuinte
CNPJ do contribuinte que se deseja

consultar.
P3
Signature

XML.
Signature o
elemento raiz de
uma assinatura
XML. Este
elemento
descrito no
arquivo xmldsigcoreschema_v01.xsd
*Representao da estrutura definida no schema XML PedidoConsultaCNPJ.xsd.
27/6/2013
Pgina 64 de 73

IV. Schema da Mensagem XML do Retorno: RetornoConsultaCNPJ.xsd

RetornoConsultaCNPJ.xsd*
#
P1
Campo
Cabecalho
Descrio
Ele
Pai
Tipo
Ocorr.
1-1
Observao
cabealho.
P2
Versao
P1
tpVersao
1-1
Sucesso
Status do Envio de Lote.
P1
tpSucesso
1-1
Alerta
Informaes
tpEvento
0-N
tpEvento
0-N
P4
sobre
ocorrncia
de
eventos geradores de alertas durante o

P3
Erro
Informaes
sobre
ocorrncia
de
eventos geradores de erros durante o

P4
Detalhe
0-N
detalhe.
InscricaoMunicipal
Inscrio Municipal vinculada ao CNPJ

consultado.
EmiteNFe
tpInscricaoMunic
1-1
ipal
Campo que indica se o contribuinte emite
P4
Boolean
1-1
NFS-e.
* Representao da estrutura definida no schema XML RetornoConsultaCNPJ.xsd.

Pedido:
<soap:Body>
<ConsultaCNPJRequest xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaCNPJRequest>
</soap:Body>
</soap:Envelope>
Retorno:
<soap:Body>
<ConsultaCNPJResponse xmlns="http://www.blumenau.sc.gov.br/nfse">
</ConsultaCNPJResponse>
</soap:Body>
27/6/2013
Pgina 65 de 73

</soap:Envelope>
4.4
TABELA DE ERROS E ALERTAS
As tabelas a seguir, apresentam os erros e alertas relacionados ao Web Service do Sistema de Nota
Fiscal de Servios Eletrnica da Prefeitura de Blumenau.
Legenda da coluna Onde Ocorre:
A. VALIDAO DO SCHEMA;
B. VERIFICAO DO CERTIFICADO/ASSINATURA;
C. Envio de RPS;
D. Envio de Lote de RPS;
E. Teste de Envio de Lote de RPS;
F. Consulta de NFS-e;
G. Consulta de NFS-e Recebidas;
H. Consulta de NFS-e Emitidas;
I.
Consulta de Lote;
J. Consulta de Informaes de Lote;

K. Cancelamento de NFS-e;
L. Consulta de CNPJ.
4.4.1
Erros
Tabela de Erros de Schema

Cdigo
Descrio
Onde Ocorre
1001
XML no compatvel com Schema.
1002
Verso do Schema XML Incorreto.
1050
Rejeio: Certificado Assinatura Invlido.
1051
Rejeio: Certificado Assinatura Data Validade.
1052
Rejeio: Certificado Assinatura sem CNPJ.
1053
Rejeio: Certificado Assinatura - Erro Cadeia de Certificao.
1054
Rejeio: Certificado Assinatura revogado.
1055
Rejeio: Certificado Assinatura difere ICP-Brasil.
27/6/2013
Pgina 66 de 73

Cdigo
Descrio
Onde Ocorre
1056
Rejeio: Assinatura - Digest difere do calculado.
1057
Rejeio: Assinatura difere do calculado.
27/6/2013
Pgina 67 de 73

Tabela de Erros de Pedido de Servio

Cdigo
104
106
107
108
Descrio
Onde Ocorre
A Data Inicial de emisso das Notas Fiscais enviadas no pode ser
D, E
inferior a 14/03/2011.
A Data Final de emisso das Notas Fiscais enviadas no pode ser
inferior a 14/03/2011.
A Data Final de emisso das Notas Fiscais enviadas no pode ser
D, E
Superior a <data atual>.

A Data Final de emisso das Notas Fiscais enviadas dever ser
D, E
superior a Data Inicial.

Data de Emisso do RPS no est compreendida entre <data inicio
207
D, E
D, E
de emisso do lote> e <data fim de emisso do lote> conforme

especificado no cabealho da mensagem XML.
209
215
218
O cdigo de servio prestado no permite reteno de ISS.

RPS em duplicidade na mensagem XML enviada. RPS: <Nmero do
D, E
RPS> Srie: <Srie do RPS>.

RPS no poder ser enviado novamente, pois est includo em Guia
C, D, E
de Recolhimento.
O campo Inscrio Municipal do Tomador (<Inscrio Municipal
219
C, D, E
C, D, E
Tomador>) s dever ser preenchido para tomadores estabelecidos

no municpio de Blumenau.
CPF/CNPJ do Tomador (<CPF/CNPJ do Tomador>) possui mais de
220
C, D, E
uma inscrio municipal, sendo obrigatrio o preenchimento do

campo Inscrio Municipal do Tomador.
301
302
O tomador de servios informado o prprio prestador.
C, D, E
CNPJ do Tomador de Servios invlido (dgitos verificadores no
C, D, E
conferem).
303
O Valor dos servios dever ser superior a R$ 0,00 (zero).
C, D, E
304
O Valor das dedues dever ser inferior ao valor dos servios.
C, D, E
305
O Valor das dedues dever ser superior ou igual a R$ 0,00 (zero).
C, D, E
306
Cdigo do Servio Prestado <cdigo enviado> do RPS inexistente.
C, D, E
Cdigo do Servio Prestado <cdigo enviado> do RPS no permite
C, D, E
308
deduo na base de clculo.
27/6/2013
Pgina 68 de 73

Cdigo
309
310
311
Descrio
Cdigo do Servio Prestado <cdigo enviado> do RPS no permite
Onde Ocorre
C, D, E
tributao fora do municpio.

Cdigo do Servio Prestado <cdigo enviado> no Informado.
C, D, E
Apenas empresas tomadoras de servios inscritas no municpio ou
C, D, E
rgos Pblicos podem efetuar reteno de ISS (CPF/CNPJ =

<CPF/CNPJ do Tomador>).
312
A data da emisso do RPS no foi preenchida Corretamente.
C, D, E
313
A data da emisso do RPS no poder ser superior a data de hoje.
C, D, E
314
A data da emisso do RPS no poder ser inferior a 14/03/2011.
C, D, E
315
Nmero do RPS no informado.
C, D, E
Campo Endereo no preenchido (obrigatrio para tomador com
C, D, E
317
318
320
321
322
CNPJ).
Campo Cidade/UF no preenchido (obrigatrio para tomador com
CNPJ).
Inscrio Municipal do Tomador de Servios consta como cancelada.
C, D, E
Apenas Notas com tributao no municpio ou fora do municpio
C, D, E
podem sofrer reteno de ISS.

O campo discriminao dos servios no foi Preenchido.
323
324
325
C, D, E
C, D, E
Nota deveria sofrer reteno do ISS pelo Tomador (Art. 284 Lei Complementar 632) ;
Nota deveria sofrer reteno do ISS pelo Tomador (Art.283-II
- Lei Complementar 632) ;
Nota deveria sofrer reteno do ISS pelo Tomador (Art.280 Lei Complementar 632) ;
Nota deveria sofrer reteno do ISS pelo Tomador (Art.283IV - Lei Complementar 632) ;
Nota deveria sofrer reteno do ISS pelo Tomador .
C, D, E
Nota no deveria sofrer reteno do ISS pelo Tomador (Art.

284 - Lei Complementar 632) ;
Nota no deveria sofrer reteno do ISS pelo Tomador (Art.
280 - Lei Complementar 632) ;
Nota no deveria sofrer reteno do ISS pelo Tomador.
C, D, E
Faturamento Bruto Mensal do Prestador de Servios encontra-se
C, D, E
desatualizado. Emisso de NFS-e no autorizada.
27/6/2013
Pgina 69 de 73

Cdigo
326
1100
1101
Descrio
C, D, E
A alquota deve ser maior que 0 (zero).

O CNPJ do usurio autorizado a enviar a mensagem XML no
Tamanho da mensagem XML ultrapassou o limite mximo permitido
1105
Lote no encontrado.
1106
NFS-e no encontrada.
1109
1201
1202
1203
1204
1205
C, D, E, F, G, H, I, J, K, L
de 500 Kbytes.
Mensagem XML de Pedido do servio sem contedo.
1108
C, D, E, F, G, H, I, J, K , L
confere com o CNPJ usado na comunicao.
1102
1107
Onde Ocorre
C, D, E, F, G, H, I, J, K, L
I, J
K
O CPF/CNPJ da assinatura da mensagem XML no corresponde ao
C, D, E, H, I, J
CPF/CNPJ do Prestador de Servios.

O CPF/CNPJ vinculado ao Inscricao do Tomador no corresponde ao
C, D, E
CPF/CNPJ informado no campo CPFCNPJTomador.

C, D, E, G, H, L
CPF/CNPJ invlido.
S permitido o envio de RPS emitidos por um nico Prestador de
D, E
Servios (mesma inscrio municipal).

Prestador de Servios no encontrado no Cadastro Municipal (CMC).
D, E
Total de RPS no confere com o enviado (<total de RPS enviados no
D, E
arquivo>).
Valor Total de Servios no confere com o enviado (<somatrio do
D, E
valor dos servios presentes no arquivo>).

Valor Total de Deduo no confere com o enviado (<somatrio do
D, E
valor das dedues presentes no arquivo>).
1206
Assinatura Digital do RPS incorreta.
C, D, E
1207
Prestador de Servios no autorizado a emitir NFS-e.
C, D, E
1303
S permitido o cancelamento de NFS-e emitidas por um nico
Prestador de Servios (mesma inscrio municipal).
1304
Erro ao cancelar NFS-e.
1305
Assinatura de cancelamento da NFS-e incorreta.
1306
A NFS-e que se deseja cancelar no foi gerada via Web Service.
S permitido consultar NFS-e emitidas por um nico Prestador de
1401
1402
Servios (mesma inscrio municipal).

O CPF/CNPJ da assinatura da mensagem XML no tem acesso ao
G, H
Tomador de Servios informado.
27/6/2013
Pgina 70 de 73

Cdigo
Onde Ocorre
G, H
As datas informadas compreendem um perodo maior que o
1403
permitido. O perodo no pode abranger mais que 31 dias.

J
A Inscrio Municipal do Prestador de Servios no consta na base
1404
4.4.2
Descrio
de dados.
Alertas
Tabela de Alertas
Cdigo
208
Descrio
Onde Ocorre
Alquota informada (<valor da alquota>) difere da
C, D, E
alquota vigente (<valor da alquota vigente>) para o

cdigo de servio informado (<cdigo de atividade>).
O sistema ir adotar a alquota vigente.
A
211
inscrio
municipal
do
tomador
(<Inscrio
C, D, E
Municipal do Tomador>) no foi encontrada na base

de dados de CMC.
214
216
Cidade/UF informada (<cidade do Tomador>)/(<UF do

Tomador>) no foi encontrada na base de dados.
RPS j foi convertido individualmente em NFS-e
C, D, E
atravs do site e no ser processado novamente.

RPS reenviado. A NFS-e (<nmero da NFS-e>)
217
C, D, E
C, D, E
referente ao RPS (Nmero: <nmero do RPS >, Srie:

<sria do RPS >) foi cancelada e uma nova NFS-e foi
emitida.
O
221
CNPJ
municipal
informado
em
(<CNPJ>)
Blumenau,
possui
porm
foi
inscrio
C, D, E
informado
endereo de fora do municpio (<cidade/UF>).

1106
NFS-e no encontrada.
1301
NFS-e j cancelada em <data de cancelamento>.
1302
NFS-e em duplicidade na mensagem XML enviada.
No h nenhuma Inscrio Municipal vinculada ao
1405
CPF/CNPJ informado.
27/6/2013
Pgina 71 de 73

5 ARQUIVOS DE EXEMPLOS
Para obter exemplos das mensagens XML para todos os pedidos e retornos, acesse:
https://nfse.blumenau.sc.gov.br/ws/exemplos.zip
27/6/2013
Pgina 72 de 73

ANEXO I
TABELA DE MUNICPIOS
Os campos de cdigos de municpios devem ser informados com a utilizao da Tabela de Municpios
mantida pelo IBGE.
27/6/2013
Pgina 73 de 73

Manual de Utilização Do Web Service - NFSe Blumenau

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Manual de Utilização Do Web Service - NFSe Blumenau

Transféré par

Droits d'auteur :

Formats disponibles

Nota Fiscal de Servios

Prefeitura Municipal de Blumenau

INTERFACES DISPONVEIS ............................................................................................................................... 5

ENVIO DE RPS ............................................................................................................................................... 5

ENVIO DE LOTE DE RPS .................................................................................................................................. 5

TESTE DE ENVIO DE LOTE DE RPS .................................................................................................................. 5

CONSULTA DE NFS-E ...................................................................................................................................... 5

CONSULTA DE NFS-E RECEBIDAS.................................................................................................................... 5

CONSULTA DE NFS-E EMITIDAS ....................................................................................................................... 5

CONSULTA DE LOTE ........................................................................................................................................ 6

CONSULTA INFORMAES DO LOTE ................................................................................................................. 6

CANCELAMENTO DE NFS-E ............................................................................................................................. 6

CONSULTA DE CNPJ ....................................................................................................................................... 6

ARQUITETURA DE COMUNICAO ................................................................................................................. 7

MODELO CONCEITUAL ..................................................................................................................................... 7

PADRES TCNICOS ....................................................................................................................................... 8

Padro de Comunicao ...................................................................................................................... 8

Padro de Certificado Digital ................................................................................................................ 8

Padro de Assinatura Digital ................................................................................................................ 9

Validao de Assinatura Digital pelo Sistema de NFS-e ................................................................... 11

Resumo dos Padres Tcnicos .......................................................................................................... 12

MODELO OPERACIONAL ................................................................................................................................. 13

PADRO DAS MENSAGENS XML ..................................................................................................................... 14

Validao da estrutura das Mensagens XML ..................................................................................... 14

Schemas XML (arquivos XSD) ........................................................................................................... 15

Verso dos Schemas XML ................................................................................................................. 15

Regras de preenchimento dos campos .............................................................................................. 18

Tratamento de caracteres especiais no texto de XML ....................................................................... 19

WEB SERVICE LOTENFE ................................................................................................................................. 20

TIPOS UTILIZADOS ......................................................................................................................................... 23

Tipos Simples ..................................................................................................................................... 23

Prefeitura Municipal de Blumenau

SERVIOS E MTODOS .................................................................................................................................. 33

Regras Gerais ..................................................................................................................................... 33

Envio de Lote de RPS (EnvioLoteRPS) ............................................................................................. 42

Teste de Envio de Lote de RPS (TesteEnvioLoteRPS) ..................................................................... 45

Pedido de Consulta de NFS-e (ConsultaNFe) ................................................................................... 46

Pedido de Consulta de NFS-e Recebidas (ConsultaNFeRecebidas) ................................................ 49

Pedido de Consulta de NFS-e Emitidas (ConsultaNFeEmitidas)....................................................... 54

Pedido de Consulta de Lote (ConsultaLote) ....................................................................................... 56

Pedido de Informaes do Lote (ConsultaInformacoesLote) ............................................................. 58

Pedido de Cancelamento de NFS-e (CancelamentoNFe) ................................................................. 60

Pedido de Consulta de CNPJ (ConsultaCNPJ) .................................................................................. 64

Tipos Complexos ................................................................................................................................ 27

TABELA DE ERROS E ALERTAS ....................................................................................................................... 66

Prefeitura Municipal de Blumenau

Prefeitura Municipal de Blumenau

ENVIO DE LOTE DE RPS

TESTE DE ENVIO DE LOTE DE RPS

CONSULTA DE NFS-E RECEBIDAS

CONSULTA DE NFS-E EMITIDAS

Prefeitura Municipal de Blumenau

CONSULTA INFORMAES DO LOTE

2.10 CONSULTA DE CNPJ

Prefeitura Municipal de Blumenau

O Web Service do Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau ir

Prefeitura Municipal de Blumenau

A comunicao entre os sistemas de informaes dos contribuintes e o Sistema de Nota Fiscal de

Padro de Certificado Digital

Os certificados digitais utilizados no Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de

Prefeitura Municipal de Blumenau

Os certificados digitais sero exigidos no mnimo* em dois (2) momentos distintos:

Padro de Assinatura Digital

As mensagens enviadas ao Sistema de Nota Fiscal de Servios Eletrnica da Prefeitura de Blumenau