Sei sulla pagina 1di 51

Nota Fiscal

Eletrnica de
Servios
Manual de Utilizao
Web Service

Verso 2.4.4

Manual de Utilizao
Web Service
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 2

NDICE

1. INTRODUO .................................................................................................................................................... 4

2. INTERFACES DISPONVEIS .................................................................................................................................. 4

2.1. ENVIO DE RPS ..................................................................................................................................................... 4


2.2. ENVIO DE LOTE DE RPS ....................................................................................................................................... 4
2.3. TESTE DE ENVIO DE LOTE DE RPS ........................................................................................................................ 4
2.4. CONSULTA DE NF-E ............................................................................................................................................ 4
2.5. CONSULTA DE NF-E RECEBIDAS .......................................................................................................................... 4
2.6. CONSULTA DE NF-E EMITIDAS ............................................................................................................................ 4
2.7. CONSULTA DE LOTE ............................................................................................................................................ 4
2.8. CONSULTA INFORMAES DO LOTE .................................................................................................................. 5
2.9. CANCELAMENTO DE NF-E .................................................................................................................................. 5
2.10. CONSULTA DE CNPJ .......................................................................................................................................... 5

3. ARQUITETURA DE COMUNICAO .................................................................................................................... 6

3.1. MODELO CONCEITUAL ....................................................................................................................................... 6


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

4. WEB SERVICE LOTE NFE ....................................................................................................................................14

4.1. WSDL ................................................................................................................................................................ 14


4.2. TIPOS UTILIZADOS ............................................................................................................................................ 15
4.2.1. Tipos Simples ............................................................................................................................................ 15
4.2.2. Tipos Complexos....................................................................................................................................... 18
4.3. SERVIOS E MTODOS ..................................................................................................................................... 23
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 3

4.3.1. Regras Gerais ............................................................................................................................................ 23


4.3.2. Envio de RPS ............................................................................................................................................. 24
4.3.3. Envio de Lote de RPS (EnvioLoteRPS) ....................................................................................................... 28
4.3.4. Teste de Envio de Lote de RPS (TesteEnvioLoteRPS)................................................................................ 31
4.3.5. Pedido de Consulta de NF-e (ConsultaNFe) ............................................................................................. 31
4.3.6. Pedido de Consulta de NF-e Recebidas (ConsultaNFeRecebidas) ............................................................ 33
4.3.7. Pedido de Consulta de NF-e Emitidas (ConsultaNFeEmitidas) ................................................................. 37
4.3.8. Pedido de Consulta de Lote (ConsultaLote) ............................................................................................. 38
4.3.9. Pedido de Informaes do Lote (ConsultaInformacoesLote) ................................................................... 39
4.3.10. Pedido de Cancelamento de NF-e (CancelamentoNFe) ......................................................................... 41
4.3.11. Pedido de Consulta de CNPJ (ConsultaCNPJ) ......................................................................................... 44
4.4. TABELA DE ERROS E ALERTAS ........................................................................................................................... 46
4.4.1. Erros ......................................................................................................................................................... 47
4.4.2. Alertas ...................................................................................................................................................... 50

5. ARQUIVOS DE EXEMPLOS .................................................................................................................................51

ANEXO I................................................................................................................................................................51

TABELA DE MUNICPIOS .......................................................................................................................................... 51


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 4

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 So Paulo para as
empresas prestadoras, tomadoras ou intermedirias de servios.

Por meio do Web Service as empresas podero integrar seus prprios sistemas de informaes com o
Sistema de Notas Fiscais de Servios Eletrnicas da Prefeitura de So Paulo. Desta forma, consegue-se
automatizar o processo de emisso, consulta e cancelamento de NF-e.

2. INTERFACES DISPONVEIS

Por meio do Web Service, o Sistema de Notas Fiscais de Servios Eletrnicas da Prefeitura de So
Paulo, disponibiliza uma srie de interfaces que podero ser acessadas pelos sistemas dos usurios. 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 Eletrnica. Esta interface destina-se aos prestadores que
desejam emitir NF-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 Notas Fiscais Eletrnicas. Esta interface destina-se aos
prestadores que desejam emitir NF-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 NF-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 NF-E

Esta interface permite aos prestadores de servios consultarem as NF-e emitidas por ele.

2.5. CONSULTA DE NF-E RECEBIDAS

Esta interface possibilita aos tomadores, intermedirios e/ou prestadores de servios consultarem as NF-
e que tiverem sido emitidas para eles, possibilitando, por exemplo, a alimentao automtica de seu
mdulo de contas a pagar.

2.6. CONSULTA DE NF-E EMITIDAS

Esta interface possibilita aos prestadores de servios consultarem as NF-e que tiverem sido emitidas por
eles.

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 NF-e geradas neste lote.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 5

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 NF-E

Com esta interface, os prestadores de servios podero cancelar as NF-e emitidas por eles, informando
apenas os nmeros da NF-e que devero ser cancelados.

2.10. CONSULTA DE CNPJ

Esta interface possibilita aos tomadores, intermedirios e/ou prestadores de servios consultarem quais
Inscries Municipais (CCM) esto vinculadas a um determinado CNPJ e se estes Contribuintes j
possuem autorizao para emisso de NFS-e.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 6

3. ARQUITETURA DE COMUNICAO

3.1. MODELO CONCEITUAL

O Web Service do Sistema de Notas Fiscais Eletrnicas da Prefeitura de So Paulo 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 NF-e;
E. Consulta de NF-e Recebidas;
F. Consulta de NF-e Emitidas;
G. Consulta de Lote;
H. Consulta de Informaes de Lote;
I. Cancelamento de NF-e;
J. Consulta de CNPJ.

Existir um nico Web Service com todos os servios apresentados acima. 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 Notas Fiscais Eletrnicas da Prefeitura de So Paulo:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 7

3.2. PADRES TCNICOS

3.2.1. Padro de Comunicao

A comunicao entre os sistemas de informaes dos contribuintes e o Sistema de Notas Fiscais de


Servios Eletrnicas da Prefeitura de So Paulo ser baseada em um Web Service disponibilizado no
Sistema de Notas Fiscais de Servios Eletrnicas. 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 Notas Fiscais de Servios Eletrnicas da Prefeitura de
So Paulo 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 Notas Fiscais de Servios Eletrnicas da Prefeitura de


So Paulo sero emitidos por Autoridade Certificadora credenciada pela Infraestrutura de Chaves
Pblicas Brasileira ICP-Brasil, tipo A1, A3 ou A4, devendo conter o CNPJ do proprietrio do certificado
digital.

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 NF-e Emitidas, NF-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 Notas
Fiscais Eletrnicas). 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 So Paulo: 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).
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 8

3.2.3. Padro de Assinatura Digital

As mensagens enviadas ao Sistema de Notas Fiscais de Servios Eletrnicas da Prefeitura de So


Paulo so documentos eletrnicos elaborados no padro XML e devem ser assinados digitalmente
utilizando certificado digital, descrito no item 3.2.2.

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 Notas Fiscais de Servios Eletrnicas da
Prefeitura de So Paulo.

A assinatura digital do documento eletrnico dever atender aos seguintes padres adotados:

A. Padro de assinatura: XML Digital Signature, utilizando o 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 NF-e

Para a validao da assinatura digital, seguem as regras que sero adotadas pelo Sistema de Notas
Fiscais de Servios Eletrnicas da Prefeitura de So Paulo:

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;
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 9

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 Notas Fiscais de Servios Eletrnicas da Prefeitura de
So Paulo 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.

3.2.5. Resumo dos Padres Tcnicos

A tabela a seguir resume os principais padres de tecnologia utilizados:

CARACTERSTICA DESCRIO

Padro definido pelo WS-I Basic Profile 1.1


Web Services
(http://www.wsi.org/Profiles/BasicProfile-1.1-2004-08-24.html).
Web Service, disponibilizados pelo Sistema de NF-e da Prefeitura de So
Meio lgico de comunicao
Paulo.

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.

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 NF-e (no caso de Consulta de NF-e Recebidas
utilizar o certificado digital do tomador).

Opcionalmente as Mensagens XML de consulta de NF-e Emitidas, NF-e


Padro de certificado digital 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 Notas Fiscais
Eletrnicas). 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.
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
Padro de assinatura digital
criptografia assimtrica RSA, algoritmo message digest SHA-1 e utilizao
das transformaes Enveloped e C14N.
Ser validada, alm da integridade e autoria, a cadeia de confiana com a
Validao de assinatura digital
validao das LCRs.
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.
Padres de preenchimento 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.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 10

3.3. MODELO OPERACIONAL

Como dito anteriormente, a forma de processamento dos pedidos de servios do Web Service do
Sistema de Notas Fiscais de Servios Eletrnicas da Prefeitura de So Paulo 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 NFe;
3. O sistema da NF-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;
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 s definies e regras de seu respectivo Schema XML.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 11

Qualquer divergncia da estrutura da mensagem XML em relao ao seu respectivo Schema XML,
provoca um erro de validao do Schema XML. Neste caso o contedo da mensagem XML de pedido do
servio no poder ser processado.

A primeira condio para que a mensagem XML seja validada com sucesso que ela seja submetida ao
Schema XML correto. Assim, os sistemas de informao dos contribuintes devem estar preparados para
gerar mensagens XML em seus respectivos Schemas XML em vigor.

3.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
Notas Fiscais Eletrnicas da Prefeitura de So Paulo. Para obter os Schemas XML do Web Service da
NF-e acione o navegador Web (Firefox, Internet Explorer, por exemplo) e digite o endereo a seguir:

a) NFS-e emitidas at 22/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemas.zip

b) NFS-e emitidas a partir de 23/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemasV02.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 NF-e, verso 1).

A maioria dos Schemas XML definidos para a utilizao do Web Service do Sistema de Notas Fiscais de
Servios Eletrnicas da Prefeitura de So Paulo utiliza as definies de tipos simples ou tipos complexos
que esto definidos em outros Schemas XML (ex.: TiposNFe.xsd e xmldsig-core-schema.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.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 12

Exemplo de Schema XML de Pedido de Envio de Lote de RPS (arquivo


PedidoEnvioLoteRPS_v01.xsd):
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 13

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 So Paulo e podero ocorrer
sempre que se fizerem necessrias.

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).

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 &gt;

< Sinal de menor &lt;

& E-comercial &amp;

Aspas &quot;

Sinal de apstrofe &apos;


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 14

4. Web Service Lote NFe

O Web Service LoteNFe, do Sistema de Notas Fiscais de Servios Eletrnicas da Prefeitura de So


Paulo, 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, portanto 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. Portanto 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).

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 Notas Fiscais de Servios Eletrnicas da Prefeitura de So Paulo.

Para obter o WSDL do Web Service da NF-e acione o navegador Web (Firefox, Internet Explorer, por
exemplo) e digite o endereo a seguir: https://nfe.prefeitura.sp.gov.br/ws/lotenfe.asmx?WSDL.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 15

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:

a) NFS-e emitidas at 22/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemas.zip

b) NFS-e emitidas a partir de 23/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemasV02.zip

4.2.1. Tipos Simples

Descrio dos nomes e abreviaes utilizados nas colunas de cabealho do layout da tabela de Tipos
Simples:

DESCRIO
TIPO
NOME DO TIPO (tipo utilizado para TAMANHO DEC OBSERVAO
BASE
informar...)
O cdigo informado dever
pertencer Tabela de Municpios
tpCidade Cdigo da cidade de endereo. N 7 (do IBGE) disponibilizada pela
Prefeitura de So Paulo.

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.

Tabelas de tipos simples


DESCRIO
TIPO
NOME DO TIPO (tipo utilizado para TAMANHO DEC OBSERVAO
BASE
informar...)
Exemplo:
5% - 0.05
tpAliquota Valor da alquota do servio N 3-5 4
2,5% - 0.025
1,75% - 0.0175
Cadeia de caracteres (com
Assinatura digital de NF-e / Base64 informaes do RPS emitido)
tpAssinatura
RPS Binary assinada conforme descrito no
item 4.3.2.
Cadeia de caracteres (com
Assinatura Digital de Base64 informaes do RPS emitido)
tpAssinaturaCancelamento
Cancelamento de NF-e. Binary assinada conforme descrito no
item 4.3.10.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 16

DESCRIO
TIPO
NOME DO TIPO (tipo utilizado para TAMANHO DEC OBSERVAO
BASE
informar...)

tpBairro Bairro do endereo C 0-30 Bairro

tpCEP CEP do endereo N 7-8 CEP

O cdigo informado dever


pertencer Tabela de Municpios
tpCidade Cdigo da cidade do endereo N 7
(do IBGE) disponibilizada pela
Prefeitura de So Paulo.
Nmero no Cadastro Nacional
tpCNPJ C 14
da Pessoa Jurdica
O cdigo informado dever
pertencer Tabela de Servios
tpCodigoServico Cdigos de Servio N 4-5
disponibilizada pela Prefeitura de
So Paulo.
O cdigo informado dever
pertencer Tabela de Erros ou
tpCodigoEvento Cdigo do Evento N 3-4
Tabela de Alertas disponibilizada
pela Prefeitura de So Paulo.
Cdigo de verificao da NF-e
tpCodigoVerificacao Cdigo de Verificao da NF-e C 8 gerado pelo Sistema de Notas
Fiscais Eletrnicas.

tpComplementoEndereco Complemento do Endereo C 0-30

Nmero no Cadastro de
tpCPF C 11
Pessoas Fsicas
Descrio correspondente ao
tpDescricaoEvento Descrio do Evento C 0-300
cdigo do evento ocorrido.
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).

Exemplo:
Digitado na NF Lavagem de
carro com lavagem de motor
Preenchimento do arquivo:
Lavagem de carro|com lavagem
de motor
tpDiscriminacao Discriminao dos Servios C 0-2000 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 24 linhas (altura).
permitido (no recomendvel),
o uso de mais de 2000
caracteres. Caso seja
ultrapassado o limite de 24
linhas, o contedo ser
truncado durante a impresso
da Nota.

tpEmail E-mail C 0-75

tpInscricaoEstadual Inscrio Estadual N 1-19

tpInscricaoMunicipal Inscrio Municipal N 8

tpLogradouro Endereo C 0-50


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 17

DESCRIO
TIPO
NOME DO TIPO (tipo utilizado para TAMANHO DEC OBSERVAO
BASE
informar...)
Tipo utilizado para informar
nmero de NF-e, nmero de
tpNumero Nmero N 1-12
RPS, nmero de Guia, nmero
de Lote, nmero de pgina, ...

tpNumeroEndereco Nmero do Endereo C 0-10

Opo pelo Simples:


0 No optante pelo Simples
Federal nem Municipal;
1 Optante pelo Simples Federal
(Alquota de 1,0%);
tpOpcaoSimples Opo pelo Simples C 1 2 Optante pelo Simples Federal
(Alquota de 0,5%);
3 Optante pelo Simples
Municipal.
4 Optante pelo Simples
Nacional.

tpQuantidade Tipo Quantidade N 1-15

tpRazaoSocial Tipo Razo Social C 0-75 Nome / Razo Social

tpSerieRPS Tipo Srie do RPS C 1-5 Srie do RPS

Status da NF-e:
tpStatusNFe Status da NF-e C 1 N Normal;
C Cancelada
O contedo deste campo indica
se o pedido do servio obteve
tpSucesso B
sucesso ou no (conforme
descrito no item (4.3.1).
Tempo de processamento
tpTempoProcessamento N 1-15
(segundos).

tpTipoLogradouro Tipo de endereo. C 0-3 Rua, Av, ...

Tipo do RPS:
RPS Recibo Provisrio de
Servios;
tpTipoRPS Tipo do RPS. C 1 RPS-M Recibo Provisrio de
Servios proveniente de Nota
Fiscal Conjugada (Mista);
RPS-C Cupom.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 18

DESCRIO
TIPO
NOME DO TIPO (tipo utilizado para TAMANHO DEC OBSERVAO
BASE
informar...)
a) NFS-e emitidas at
22/02/2015: poder ser
preenchido com:
T Tributao no municpio de
So Paulo;
F Tributao fora do municpio
de So Paulo;
I Isento/Imune;
J ISS Suspenso por Deciso
Judicial.

b) NFS-e emitidas a partir de


23/02/2015: poder ser
preenchido com:
tpTributacaoNFe Tipo de Tributao C 1 T Tributado em So Paulo
F Tributado Fora de So Paulo
A Tributado em So Paulo,
porm Isento
B Tributado Fora de So Paulo,
porm Isento
M Tributado em So Paulo,
porm Imune
N Tributado Fora de So Paulo,
porm Imune
X Tributado em So Paulo,
porm Exigibilidade Suspensa
V Tributado Fora de So Paulo,
porm Exigibilidade Suspensa
P Exportao de Servios

tpUF Sigla da UF do endereo. C 2 Sigla da UF do endereo.

Tipo utilizado para valores com


15 dgitos, sendo 13 de corpo e 2
decimais.
tpValor Valores N 0-15 2 Exemplo:
R$ 500,85 500.85
R$ 826,00 826
O contedo deste campo indica a
verso do Schema XML utilizado.
Exemplo:
tpVersao Verso N 1-3
Verso 1 1
Verso 10 10
Verso 100 100
Exemplo:
tpPercentualCargaTributari
5% - 0.05
a Percentual da carga tributria N 7 4
2,5% - 0.025
1,75% - 0.0175
tpFonteCargaTributaria Fonte de informao da carga
C 0-10 Exemplo: IBPT
tributria

4.2.2. Tipos Complexos

Layout da tabela utilizada para representar a estrutura XML dos Tipos Complexos:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 19

* Ocorrncia: x - y, onde x indica a ocorrncia mnima e y a ocorrncia mxima.


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 20

tpNFe
Tipo que representa uma NF-e
Nome do Elemento Tipo do Elemento Ocorrncia Descrio
Assinatura tpAssinatura 0-1 Assinatura do RPS que gerou a NF-e (conforme
especificado no Item 4.3.2).
ChaveNFe tpChaveNFe 1-1 Chave de identificao da NF-e (ver detalhes na
tabela tpChaveNFe).
DataEmissaoNFe dateTime 1-1 Data/Hora da emisso da NF-e (AAAA-MM-
DDThh:mm:ss).
NumeroLote tpNumero 0-1 Nmero do lote que gerou a NF-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.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 21

EmailPrestador tpEmail 0-1 E-mail do prestador.


StatusNFe tpStatusNFe 1-1 Status da NF-e.
DataCancelamento date 0-1 Se a NF-e tiver sido cancelada, este campo ser
preenchido com a data de cancelamento da NF-e
(AAAA-MM-DDThh:mm:ss).
TributacaoNFe tpTributacaoNFe 1-1 Tipo de tributao da NF-e.
OpcaoSimples tpOpcaoSimples 1-1 Tipo de opo pelo Simples.
NumeroGuia tpNumero 0-1 Nmero da guia vinculada a NF-e.
DataQuitacaoGuia Date 0-1 Data de quitao da guia vinculada a NF-e.
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$.
CodigoServico 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 NF-e com ISS Retido;
"false" - para NF-e sem ISS Retido
CPFCNPJTomador tpCPFCNPJ 0-1 CPF/CNPJ do tomador.
InscricaoMunicipalTomador tpInscricaoMunicipal 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.
CPFCNPJIntermediario tpCPFCNPJ 0-1 CPF/CNPJ do intermedirio
InscricaoMunicipalIntermediari tpInscricaoMunicipal 0-1
Inscrio Municipal do intermedirio.
o
ISSRetidoIntermediario Boolean 0-1 true para NF-e com ISS Retido pelo
Intermedirio
false para NF-e sem reteno pelo
Intermedirio
EmailIntermediario tpEmail 0-1 E-mail do intermedirio
ValorCargaTributaria tpValor 0-1 Valor da carga tributria total em R$.

PercentualCargaTributaria tpPercentualCargaTributaria 0-1 Valor percentual da carga tributria

FonteCargaTributaria tpFonteCargaTributaria 0-1 Fonte de informao da carga tributria

CodigoCEI tpNumero 0-1 Cdigo do CEI Cadastro especfico do INSS

MatriculaObra tpNumero 0-1 Nmero da matrcula de obra.

MunicipioPrestacao tpCidade 0-1 Cdigo do municpio onde ocorreu a prestao do


servio, conforme tabela de Cdigos de Municpios
elaborada pelo IBGE.
NumeroEncapsulamento tpNumero 0-1 Cdigo do encapsulamento de notas dedutoras.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 22

Discriminacao tpDiscriminacao 1-1 Discriminao dos servios.


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
tpChaveRPS).
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.
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$.
CodigoServico 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 NF-e com ISS Retido;
"false" - para NF-e sem ISS Retido
CPFCNPJTomador tpCPFCNPJ 0-1 CPF/CNPJ do tomador do servio.
InscricaoMunicipalTomador tpInscricaoMunicipa 0-1 Inscrio Municipal do tomador.
l ATENO 1: Este elemento s dever ser preenchido
para tomadores estabelecidos no municpio de So Paulo
(CCM).
ATENO 2: O preenchimento deste elemento implica
na obrigatoriedade do preenchimento do elemento
CPFCNPJTomador.
Ser verificado se o CNPJ vinculado ao CCM
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.
CPFCNPJIntermediario tpCPFCNPJ 0-1 CPF/CNPJ do intermedirio do servio.
InscricaoMunicipalIntermediari tpInscricaoMunicipa 0-1 Inscrio Municipal do intermedirio.
o l ATENO 1: Este elemento s dever ser preenchido
para intermedirios estabelecidos no municpio de So
Paulo (CCM).
Ser verificado se o CNPJ vinculado ao CCM
corresponde ao CNPJ informado no elemento
CPFCNPJIntermediario.
ISSRetidoIntermediario Boolean 0-1 true para NF-e com ISS Retido pelo Intermedirio
false para NF-e sem reteno pelo Intermedirio
Caso o Intermedirio no seja identificado, essa tag no
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 23

dever ocorrer.
EmailIntermediario tpEmail 0-1 E-mail do intermedirio
Discriminacao tpDiscriminacao 1-1 Discriminao dos servios.
ValorCargaTributaria tpValor 0-1 Valor da carga tributria total em R$.

PercentualCargaTributaria tpPercentualCargaT 0-1 Valor percentual da carga tributria


ributaria

FonteCargaTributaria tpFonteCargaTribut 0-1 Fonte de informao da carga tributria


aria

CodigoCEI tpNumero 0-1 Cdigo do CEI Cadastro especfico do INSS

MatriculaObra tpNumero 0-1 Nmero da matrcula de obra.

MunicipioPrestacao tpCidade 0-1 Cdigo do municpio onde ocorreu a prestao do servio,


conforme tabela de Cdigos de Municpios elaborada pelo
IBGE.
NumeroEncapsulamento tpNumero 0-1 Cdigo do encapsulamento de notas dedutoras.

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 informando o
no sucesso da operao (TAG sucesso = false) e as demais Informaes sobre os eventos de
erro/alerta ocorridos.

Observaes:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 24

Descrio dos nomes e abreviaes utilizados no cabealho das tabelas que representam a estrutura
definida nos schemas XML:

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:
F. 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:

a) NFS-e emitidas at 22/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemas.zip

b) NFS-e emitidas a partir de 23/02/2015

https://nfe.prefeitura.sp.gov.br/ws/schemasV02.zip

4.3.2. Envio de RPS

I. Descrio: Este mtodo responsvel por atender aos pedidos de Envio Individual de RPS para
substituio por NF-e.

II. Mtodo: EnvioRPS.

III. Mensagem XML: O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme
tabela a seguir:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 25

* 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.

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:

# Informao Contedo
1 Inscrio Municipal do Inscrio Municipal do Prestador com 8 posies (dgitos). Completar com zeros
Prestador esquerda caso seja necessrio.
2 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
esquerda.
3 Nmero do RPS Nmero do RPS com 12 posies (dgitos). Completar com zeros esquerda
caso seja necessrio.
4 Data de Emisso do RPS Data de emisso do RPS no formato AAAAMMDD (caracteres).
5 Tipo de Tributao do RPS Tipo de Tributao do RPS com 1 posio (caractere):
a) NFS-e emitidas at 22/02/2015
T Tributao no municipio de So Paulo;
F Tributao fora do municipio de So Paulo;
I Isento;
J ISS Suspenso por Deciso Judicial.
a) NFS-e emitidas a partir 23/02/2015

T Tributado em So Paulo
F Tributado Fora de So Paulo
A Tributado em So Paulo, porm Isento
B Tributado Fora de So Paulo, porm Isento
M Tributado em So Paulo, porm Imune
N Tributado Fora de So Paulo, porm Imune
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 26

X Tributado em So Paulo, porm Exigibilidade Suspensa


V Tributado Fora de So Paulo, porm Exigibilidade Suspensa
P Exportao de Servios
6 Status do RPS Status do RPS com 1 posio (caractere):
N Normal;
C Cancelado.
7 ISS Retido Valor S (SIM) para ISS Retido (caractere).
Valor N (NO) para Nota Fiscal sem ISS Retido.
8 Valor dos Servios Valor dos Servios do RPS, incluindo os centavos (sem ponto decimal e sem
R$), com 15 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 Cdigo do Servio do RPS com 5 posies (dgitos). Completar com zeros
Prestado 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.
13 Indicador de CPF/CNPJ do Indicador de CPF/CNPJ com 1 posio (dgito).
Intermedirio Valor 1 para CPF.
Valor 2 para CNPJ.
Valor 3 para No informado o CPF/CNPJ do Intermedirio
14 CPF/CNPJ do CPF/CNPJ do intermedirio com 14 posies (dgitos). Sem formatao (ponto,
Intermedirio trao, barra,....). Completar com zeros esquerda caso seja necessrio. Se o
Indicador do CPF/CNPJ for 3 (no informado), preencher com 14 zeros.
15 ISS Retido Intermedirio Valor S (SIM) para ISS Retido pelo Intermedirio
Valor N (NO) para ISS no retido pelo Intermedirio

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>31000000</InscricaoPrestador>
<SerieRPS>OL03</SerieRPS>
<NumeroRPS>1</NumeroRPS>
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 27

</ChaveRPS>
<TipoRPS>RPS-M</TipoRPS>
<DataEmissao>2007-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>
...
<CPFCNPJIntermediario>
<CNPJ>09999999000106</CNPJ>
</CPFCNPJIntermediario>
<InscricaoMunicipalIntermediario>99999999</InscricaoMunicipalIntermediario>
<ISSRetidoIntermediario>true</ISSRetidoIntermediario>
...

Com base no trecho da mensagem XML apresentada, montamos a seguinte string de caracteres:

"31000000OL03
00000000000120070103TNN00000000205000000000000050000002658100013167474254209999999000106S"

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.

Observao: no necessrio informar os dados de intermedirio na assinatura se no houver


intermedirio. Como exemplo, sem intermedirio a string montada seria dessa forma:

"31000000OL03 00000000000120070103TNN00000000205000000000000050000002658100013167474254

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: RetornoEnvioRPS.xsd


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 28

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

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.3.3. Envio de Lote de RPS (EnvioLoteRPS)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 29

I. Descrio: Este mtodo responsvel por atender aos pedidos de Envio de Lote de RPS para
substituio por NF-e.

II. Mtodo: EnvioLoteRPS.

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 30

* 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 NF-e.

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

* 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 NF-e.

V. Formato das Mensagens SOAP:

Pedido:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 31

Retorno:

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

I. Descrio: Este mtodo responsvel por atender aos pedidos de Teste de Envio de Lote de
RPS para substituio por NF-e. Este mtodo no substitui os RPS por NF-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)

4.3.5. Pedido de Consulta de NF-e (ConsultaNFe)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 32

I. Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NF-e / RPS. Seu
acesso permitido apenas pela chave de identificao da NF-e ou pela chave de identificao
do RPS.

II. Mtodo: ConsultaNFe


III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

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

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


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 33

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

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.3.6. Pedido de Consulta de NF-e Recebidas (ConsultaNFeRecebidas)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 34

I. Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NF-e Recebidas.

II. Mtodo: ConsultaNFeRecebidas

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

PedidoConsultaNFePeriodo.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho informaes do G - - 1-1
cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.
CPF/CNPJ do
CPFCNPJRemet Remetente
E P1 tpCPFCNPJ 1-1
ente autorizado a enviar a
mensagem XML.
Para consulta de
NF-e Recebidas:
Informe o CPF/CNPJ
do tomador da NF-e.
CPFCNPJ E P1 tpCPFCNPJ 1-1
Para consulta de
NF-e Emitidas:
Informe o CNPJ do
emissor da NF-e.
Para consulta de
NF-e Recebidas:
Informe a Inscrio
ATENO 1: Este
Municipal do campo s dever ser
Tomador. preenchido com a
Para consulta de inscrio de
Inscricao NF-e Emitidas: E P1 tpInscricaoMunicipal 0-1 contribuintes
Informe a Inscrio estabelecidos no
municpio de So
Municipal do Paulo
Prestador. Neste tipo
de consulta o (CCM).
preenchimento deste
campo se torna
obrigatrio.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 35

PedidoConsultaNFePeriodo.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

Data incio da
dtInicio E P1 D 1-1
consulta.

dtFim Data fim da consulta. E P1 D 1-1

Nmero da pgina
NumeroPagina ** E P1 tpNumero 1-1 Default = 1
consultada
Signature o
elemento raiz de uma
Assinatura digital da assinatura XML. Este
P2 Signature G - SignatureType 1-1
mensagem XML. elemento descrito no
arquivo xmldsig-
coreschema_v01.xsd

* Representao da estrutura definida no schema XML PedidoConsultaNFePeriodo.xsd. Os mtodos


ConsultaNFeRecebidas e ConsultaNFeEmitidasidas 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 NF-e, Consulta de NF-e Recebidas, Consulta de NF-e Emitidas e Consulta de Lote) s
sero retornadas at 50 NF-e por consulta. Porm a Consulta de NF-e Recebidas (assim como a
Consulta de NF-e Emitidas) pode encontrar uma quantidade maior de NF-e do que o limite especificado.

Sendo assim, as NF-e encontradas sero agrupadas em pginas com at 50 NF-e. Para consultar as
NF-e de cada uma das pginas o contribuinte dever transmitir uma mensagem XML de pedido de
Consulta de NF-e Recebidas indicando qual pgina deseja consultar. Desta forma, caso um pedido de
consulta de NF-e Recebidas, para pgina X, retorne 50 NF-e o sistema de informao do Contribuinte
deve efetuar novo pedido de Consulta de NF-e Recebidas, para pgina X+1, para verificar se existem
mais NF-e Recebidas no perodo consultado.

Quando o sistema de informao do Contribuinte efetuar um pedido de Consulta de NF-e Recebidas


para uma determinada pgina e esta consulta retornar menos que 50 NF-e o sistema de informao do
contribuinte saber que estas so as ltimas NF-e recebidas para o perodo consultado e que portanto
est a ltima pgina. Se o Web Service retornar uma mensagem XML informando sucesso (tag
sucesso = true) e sem nenhuma NF-e por que a pgina consultada no existe.

Exemplo:

O sistema de informao de um Contribuinte envia uma mensagem XML de Pedido Consulta de NF-e
Recebidas para o perodo de 01/09/2006 a 30/09/2006 e requerendo a pgina 1. Para este pedido so
encontradas 137 NF-e recebidas. As 137 NF-e so agrupadas em trs pginas: Pgina 1 com as
primeiras 50 NF-e (1 50); pgina 2 com as prximas 50 NF-e (51 100) e pgina 3 com as 37 NFe
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 NF-e para a pgina 1. O sistema de informao do Contribuinte envia outra mensagem
XML de Pedido Consulta de NF-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 NF-e para a pgina 2. O sistema de informao do Contribuinte envia outra mensagem
XML de Pedido Consulta de NF-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 NF-e para a pgina 3 e portanto no existem mais NF-e recebidas para o perodo
consultado.

Obs.: As NF-e encontradas so ordenadas por data de emisso da nota (ou data do cancelamento, caso
a NF-e tenha sido cancelada) e pela inscrio municipal (CCM) do prestador que emitiu a nota.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 36

Abaixo, fluxo de funcionamento baseado no exemplo descrito:

IV. Schema da Mensagem XML do Retorno: RetornoConsulta.xsd (Idntico ao do item 4.3.5)

V. Formato das Mensagens SOAP:

Pedido:

Retorno:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 37

4.3.7. Pedido de Consulta de NF-e Emitidas (ConsultaNFeEmitidas)

I. Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NF-e Emitidas.

II. Mtodo: ConsultaNFeEmitidas

III. O parmetro MensagemXML (idntico ao Schema da Mensagem XML de pedido apresentado


no item 4.3.6 III).

IV. Schema da Mensagem XML do Retorno: RetornoConsulta.xsd (Idntico ao do item 4.3.5)

V. Formato das Mensagens SOAP:

Pedido:

Retorno:
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 38

4.3.8. Pedido de Consulta de Lote (ConsultaLote)

I. Descrio: Este mtodo responsvel por atender aos pedidos de Consulta de Lote de NF-e
geradas a partir do mtodo EnvioLoteRPS.

II. Mtodo: ConsultaLote

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

PedidoConsultaLote.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho informaes do G - - 1-1
cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.
CNPJ do Remetente
CNPJRemetente autorizado a enviar a E P1 tpCPFCNPJ 1-1
mensagem XML.
Nmero do Lote a ser
NumeroLote E P1 tpNumero 1-1
consultado.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 39

PedidoConsultaLote.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

Signature o
elemento raiz de uma
Assinatura digital da assinatura XML. Este
P2 Signature G - SignatureType 1-1
mensagem XML. elemento descrito no
arquivo xmldsig-
coreschema_v01.xsd
* Representao da estrutura definida no schema XML PedidoConsultaLote.xsd.

IV. Schema da Mensagem XML do Retorno: RetornoConsulta.xsd (Idntico ao do item 4.3.5)

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.3.9. Pedido de Informaes do Lote (ConsultaInformacoesLote)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 40

I. Descrio: Este mtodo responsvel por atender aos pedidos de Consulta de Informaes de
Lote de NF-e geradas a partir do mtodo EnvioLoteRPS.

II. Mtodo: ConsultaInformacoesLote

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

PedidoInformaesLote.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho informaes do G - - 1-1
cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.
CNPJ do
Remetente
CNPJRemetente E P1 tpCPFCNPJ 1-1
autorizado a enviar
a mensagem XML.
Caso no seja
informado o nmero do
Nmero do Lote a
NumeroLote E P1 tpNumero 0-1 lote, sero retornadas
ser consultado.
informaes do ltimo
lote gerador de NF-e.
Inscrio municipal
do prestador de
InscricaoPrestador servios que gerou E P1 tpInscricaoMunicipal 1-1
o lote a ser
consultado.
Signature o
elemento raiz de uma
Assinatura digital
assinatura XML. Este
P2 Signature da mensagem G - SignatureType 1-1
elemento descrito no
XML.
arquivo xmldsig-
coreschema_v01.xsd
* Representao da estrutura definida no schema XML PedidoInformacoesLote.xsd.

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


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 41

RetornoInformaesLote.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho G - - 1-1
informaes do cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.

Sucesso Status do Envio de Lote E P1 tpSucesso 1-1

InformacoesLote Informaes sobre o Lote G P1 tpInformacoesLote 0-1

Informaes sobre a
ocorrncia de eventos
P2 Alerta geradores de alertas durante G - tpEvento 0-N
o processamento da
mensagem XML.
Informaes sobre a
ocorrncia de eventos
P3 Erro geradores de erros durante o G - tpEvento 0-N
processamento da
mensagem XML.
* Representao da estrutura definida no schema XML RetornoInformacoesLote.xsd.

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.3.10. Pedido de Cancelamento de NF-e (CancelamentoNFe)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 42

I. Descrio: Este mtodo responsvel por atender aos pedidos referentes ao cancelamento de
NF-e geradas a partir do mtodo EnvioLoteRPS.

II. Mtodo: CancelamentoNFe

III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

PedidoCancelamentoNFe.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho informaes do G - - 1-1
cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.
CNPJ do Remetente
CNPJRemetent
autorizado a enviar a E P1 tpCPFCNPJ 1-1
e
mensagem XML
True - As NF-e s sero
canceladas se no ocorrer
nenhum evento de erro
durante o processamento de
todo o lote.
Informe se as NF-e a
False - As NF-e aptas a
serem canceladas
Transacao E P1 Boolean 0-1 serem canceladas sero
faro parte de uma
canceladas, mesmo que
mesma transao.
ocorram eventos de erro
durante processamento do
cancelamento de outras NF-e
deste lote.
Default: true.
Tag de grupo das
P2 Detalhe informaes de G - 1-50
detalhe.

ChaveNFe Chave da NF-e. E P2 tpChaveNFe 1-1

Assinatura de
AssinaturaCanc tpAssinaturaCa
Cancelamento da E P2 1-1
elamento ncelamento
NF-e.
Signature o elemento raiz
de uma assinatura XML. Este
Assinatura digital da
P3 Signature G - SignatureType 1-1 elemento descrito no
mensagem XML.
arquivo xmldsigcore-
schema_v01.xsd
* Representao da estrutura definida no schema XML PedidoCancelamentoNFe.xsd.
Observao 1: Transao
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 43

Se ocorrerem eventos de erro de validao dos dados do cabealho do pedido de cancelamento de NF-
e, independente da opo informada no campo Transao, nenhuma NF-e ser cancelada.

Observao 2: Assinatura Adicional

Cada NF-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
SHA-1.

Para criar a assinatura dever ser gerado um Hash (utilizando SHA1) de uma cadeia de caracteres
(ASCII) com informaes da NF-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:

# Informao Contedo

Inscrio Municipal do Prestador com 8 posies (dgitos). Completar com


1 Inscrio Municipal do Prestador
zeros esquerda caso seja necessrio.
Nmero da NF-e com 12 posies (dgitos). Completar com zeros
2 Nmero da NF-e
esquerda caso seja necessrio.

Passos bsicos para assinatura de cancelamento de uma NF-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


NF-e (os campos utilizados na montagem da cadeia de caracteres esto em negrito).

Com base no trecho da mensagem XML apresentada, montamos a seguinte String de caracteres:
"31000000000000000009"

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.xsd*
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 44

# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das informaes


P1 Cabecalho G - - 1-1
do cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.

Sucesso Status do cancelamento. E P1 tpSucesso 1-1

Informaes sobre a ocorrncia


de eventos geradores de
P2 Alerta alertas durante o G - tpEvento 0-N
processamento da mensagem
XML.
Informaes sobre a ocorrncia
de eventos geradores de erros
P3 Erro G - tpEvento 0-N
durante o processamento da
mensagem XML.
* Representao da estrutura definida no schema XML RetornoCancelamentoNFe.xsd.

O Sistema da NF-e verificar se a NF-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).

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.3.11. Pedido de Consulta de CNPJ (ConsultaCNPJ)


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 45

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 (CCM) esto vinculadas a um determinado CNPJ e se estes CCM emitem NF-e ou
no.

II. Mtodo: ConsultaCNPJ


III. O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:

PedidoConsultaCNPJ.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das


P1 Cabecalho informaes do G - - 1-1
cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.
CNPJ do Remetente
CNPJRemetente autorizado a enviar a E P1 tpCPFCNPJ 1-1
mensagem XML
CNPJ do contribuinte
P2 CNPJContribuinte que se deseja E - tpCPFCNPJ 1-1
consultar.
Signature o elemento
raiz de uma assinatura
Assinatura digital da XML. Este elemento
P3 Signature G - SignatureType 1-1
mensagem XML. descrito no arquivo
xmldsigcore-
schema_v01.xsd
*Representao da estrutura definida no schema XML PedidoConsultaCNPJ.xsd.

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

RetornoConsultaCNPJ.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 46

RetornoConsultaCNPJ.xsd*
# Campo Descrio Ele Pai Tipo Ocorr. Observao

TAG de grupo das informaes


P1 Cabecalho G - - 1-1
do cabealho.
Verso do XML
Versao A P1 tpVersao 1-1
Schema Utilizado.

Sucesso Status do cancelamento. E P1 tpSucesso 1-1

Informaes sobre a ocorrncia


de eventos geradores de
P2 Alerta alertas durante o G - tpEvento 0-N
processamento da mensagem
XML.
Informaes sobre a ocorrncia
de eventos geradores de erros
P3 Erro G - tpEvento 0-N
durante o processamento da
mensagem XML.
TAG de grupo das informaes
P4 Detalhe G - 0-N
do detalhe.
InscricaoMunici Inscrio Municipal vinculada tpInscricaoMuni
E P4 1-1
pal ao CNPJ consultado. cipal
Campo que indica se o
EmiteNFe E P4 Boolean 1-1
contribuinte emite NF-e.
* Representao da estrutura definida no schema XML RetornoConsultaCNPJ.xsd.

V. Formato das Mensagens SOAP:

Pedido:

Retorno:

4.4. TABELA DE ERROS E ALERTAS

As tabelas a seguir, apresentam os erros e alertas relacionados ao Web Service do Sistema de Notas
Fiscais Eletrnicas da Prefeitura de So Paulo.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 47

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 NF-e;
G. Consulta de NF-e Recebidas;
H. Consulta de NF-e Emitidas;
I. Consulta de Lote;
J. Consulta de Informaes de Lote;
K. Cancelamento de NF-e;
L. Consulta de CNPJ.

4.4.1. Erros

Tabela de Erros de Schema

Cdigo Descrio Onde Ocorre

1001 XML no compatvel com Schema. A

1002 Verso do Schema XML Incorreto. A

1050 Rejeio: Certificado Assinatura Invlido. B

1051 Rejeio: Certificado Assinatura Data Validade. B

1052 Rejeio: Certificado Assinatura sem CNPJ. B

1053 Rejeio: Certificado Assinatura Erro Cadeia de Certificao. B

1054 Rejeio: Certificado Assinatura revogado. B

1055 Rejeio: Certificado Assinatura difere ICP-Brasil. B

1056 Rejeio: Assinatura Digest difere do calculado. B

1057 Rejeio: Assinatura difere do calculado. B

Tabela de Erros de Pedido de Servio

Cdigo Descrio Onde Ocorre

104 A Data Inicial de emisso das Notas Fiscais enviadas no pode ser inferior a 01/06/2006. D,E

106 A Data Final de emisso das Notas Fiscais enviadas no pode ser inferior a 01/06/2006. D,E

107 A Data Final de emisso das Notas Fiscais enviadas no pode ser superior a <data atual>. D,E

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

Tipo de tributao invlido. Para mais informaes consulte o item 14.20 da seo de
206 C,D,E
perguntas e respostas.
Data de Emisso do RPS no est compreendida entre <data inicio de emisso do lote> e
207 D,E
<data fim de emisso do lote> conforme especificado no cabealho da mensagem XML.

209 O cdigo de servio prestado no permite reteno de ISS. C,D,E


Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 48

Cdigo Descrio Onde Ocorre

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

218 RPS no poder ser enviado novamente, pois est includo em Guia de Recolhimento. C,D,E

O campo Inscrio Municipal do Tomador (<Inscrio Municipal Tomador>) s dever ser


219 C,D,E
preenchido para tomadores estabelecidos no municpio de So Paulo.
CPF/CNPJ do Tomador (<CPF/CNPJ do Tomador>) possui mais de uma inscrio municipal,
220 C,D,E
sendo obrigatrio o preenchimento do campo Inscrio Municipal do Tomador.

301 O tomador de servios informado o prprio prestador. C,D,E

302 CNPJ do Tomador de Servios invlido (dgitos verificadores no conferem). C,D,E

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 deduo na base de


308 C,D,E
clculo.
Cdigo do Servio Prestado <cdigo enviado> do RPS no permite tributao fora do
309 C,D,E
municpio.

310 Cdigo do Servio Prestado <cdigo enviado> no informado. C,D,E

Apenas empresas tomadoras de servios inscritas no municpio ou rgos Pblicos podem


311 C,D,E
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 01/06/2006. C,D,E

315 Nmero do RPS no informado. C,D,E

317 Campo Endereo no preenchido (obrigatrio para tomador com CNPJ). C,D,E

318 Campo Cidade/UF no preenchido (obrigatrio para tomador com CNPJ). C,D,E

320 Inscrio Municipal do Tomador de Servios consta como cancelada. C,D,E

321 Apenas Notas com tributao no municpio ou fora do municpio podem sofrer reteno de ISS. C,D,E

322 O campo discriminao dos servios no foi preenchido. C,D,E

323 Nota no pode ser cancelada. Ver detalhes no Manual. C,D,E

Operao no autorizada por meio eletrnico em razo de ter sido ultrapassado o prazo
324 C,D,E
permitido.
RPS no poder ser enviado novamente. A NFS-e (<NFS-e informada>) no pde ser
338 C,D,E
cancelada

342 Campo CEP invlido C,D,E


CNPJ do Tomador de Servios invlido (dgitos verificadores no conferem);
343 C,D,E

Para servios de construo civil com deduo na base de clculo do ISS obrigatrio informar
374 C,D,E
o nmero de inscrio no Cadastro Tributrio de Obras de Construo Civil.
Para servios de construo civil com deduo na base de clculo do ISS obrigatrio informar
375 C,D,E
o nmero de controle do encapsulamento das notas dedutveis.
Nmero de inscrio da obra declarado na NFS-e (<Nmero da NFS-e>) no confere com o
376 C,D,E
nmero de inscrio de obra do encapsulamento de dedues (<nmero do encapsulamento>).
Valor de dedues declarado na NFS-e menor que o valor total de dedues contido no
377 C,D,E
encapsulamento.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 49

Cdigo Descrio Onde Ocorre


No declare o nmero de inscrio da obra para servios tributados fora do municpio de So
378 C,D,E
Paulo ou para exportao de servios.

379 Nmero de inscrio da obra invlido. C,D,E

380 Nmero de inscrio da obra inexistente. C,D,E

381 Nmero do encapsulamento invlido. C,D,E

Encapsulamento de notas de subempreitadas e materiais j foi vinculado NFS-e n <nmero


382 C,D,E
da NFS-e>.

383 Cdigo de servio no permite indicao do nmero da obra. C,D,E

384 Nmero de encapsulamento de dedues foi cancelado e no poder ser utilizado. C,D,E

Valor de dedues declarado na NFS-e maior que o valor total de dedues do


385 C,D,E
encapsulamento.

386 NFS-e a ser cancelada foi selecionada para dedues de subempreitadas. C,D,E

No informe nmero de encapsulamento de dedues para emisso de NFS-e de empreitadas


387 C,D,E
isentas ou imunes.
Data do fato gerador de uma ou mais notas de subempreitadas ou registros de materiais
388 C,D,E
posterior data do fato gerador da NFS-e a ser emitida pelo prestador de servios.

389 Cdigo de servio no permite indicao do nmero do encapsulamento. C,D,E

390 Nmero do encapsulamento inexistente. C,D,E

Cdigo de atividade <cdigo informado>, no permite Dedues para o Tipo de Registro=''3''


391 C,D,E
(Cupons).

505 CNPJ do Intermedirio de Servios invlido (dgitos verificadores no conferem). C,D,E

506 E-mail do intermedirio do servio invlido. C,D,E

508 O cdigo de servio ({0}) no permite que o ISS seja retido pelo Intermedirio. C,D,E

509 Intermedirio no possui inscrio municipal. C,D,E

Inscrio Municipal do Intermedirio especificada no arquivo no confere com o CNPJ


C,D,E
511 informado.

Inscrio do Intermedirio de Servios no encontrada na base de dados de CCM do


C,D,E
513 municpio.

514 CNPJ do Intermedirio ({0}) possui mais de uma inscrio municipal. C,D,E

516 Cdigo de Servio Prestado ({0}) no permite a identificao do intermedirio do servio. C,D,E

Para NFS-e sem identificao do intermedirio, a NFS-e dever ser emitida sem reteno ou
C,D,E
519 com reteno pelo tomador.
O CNPJ do usurio autorizado a enviar a mensagem XML no confere com o CNPJ usado na
1100 C,D,E,F,G,H,I,J,K,L
comunicao.

1101 Tamanho da mensagem XML ultrapassou o limite mximo permitido de 500 Kbytes. C,D,E,F,G,H,I,J,K,L

1102 Mensagem XML de Pedido do servio sem contedo. C,D,E,F,G,H,I,J,K,L

1105 Lote no encontrado. I,J

1106 NF-e no encontrada. F

O CPF/CNPJ da assinatura da mensagem XML no corresponde ao CPF/CNPJ do Prestador


1107 C,D,E,H,I,J
de Servios.
O CPF/CNPJ vinculado Inscrio do Tomador no corresponde ao CPF/CNPJ informado no
1108 C,D,E
campo CPFCNPJTomador.
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 50

Cdigo Descrio Onde Ocorre

1109 CPF/CNPJ invlido. C,D,E,G,H,L

S permitido o envio de RPS emitidos por um nico Prestador de Servios (mesma inscrio
1201 D,E
municipal).

1202 Prestador de Servios no encontrado no Cadastro Municipal (CCM). D,E

1203 Total de RPS no confere com o enviado (<total de RPS enviados no arquivo>). D,E

Valor Total de Servios no confere com o enviado (<somatrio do valor dos servios
1204 D,E
presentes no arquivo>).
Valor Total de Deduo no confere com o enviado (<somatrio do valor das dedues
1205 D,E
presentes no arquivo>).

1206 Assinatura Digital do RPS incorreta. C,D,E

1207 Prestador de Servios no autorizado a emitir NF-e. C,D,E

1212 NFS-e no permite indicao de imunidade. CCM do prestador no cadastrado por meio do
C,D,E
sistema de declarao de imunidades (SDI) para a data do fato gerador informada.
1213 NFS-e no permite indicao de imunidade. Cdigo de servio informado na NFS-e no
cadastrado por meio do sistema de declarao de imunidades (SDI) para a data do fato C,D,E
gerador informada.
1222 Obrigatrio informar o municpio onde o servio foi prestado. C,D,E

1223 Para servio tributado em So Paulo ou exportao de servios no informe o municpio onde o
C,D,E
servio foi prestado.
1225 Municpio onde o servio foi prestado inexistente. C,D,E

1227 O prestador de servios dever registrar a solicitao de imunidade por meio do sistema de
C,D,E
declarao de imunidades (Instruo Normativa no. XX/2014).
1228 Exportao de servios no permite a indicao de reteno pelo tomador ou pelo
C,D,E
intermedirio.
1232 O municpio de So Paulo foi informado como Municpio da Prestao mas o servio
C,D,E
tributado fora de So Paulo.
1233 NFS-e no permite indicao de imunidade ou iseno para profissional autnomo C,D,E

1234 Cdigo do Servio Prestado {0} no permite indicao do nmero do Cadastro Especifico do
C,D,E
INSS (CEI)
S permitido o cancelamento de NF-e emitidas por um nico Prestador de Servios (mesma
1303 J
inscrio municipal).

1304 Erro ao cancelar NF-e. J

1305 Assinatura de cancelamento da NF-e incorreta. J

1306 A NF-e que se deseja cancelar no foi gerada via Web Service. J

S permitido consultar NF-e emitidas por um nico Prestador de Servios (mesma inscrio
1401 F
municipal).
O CPF/CNPJ da assinatura da mensagem XML no tem acesso ao Tomador de Servios
1402 G,H
informado.
As datas informadas compreendem um perodo maior que o permitido. O perodo no pode
1403 G,H
abranger mais que 31 dias.

1404 A Inscrio Municipal do Prestador de Servios no consta na base de dados. J

O preenchimento do ISSRetidoIntermedirio implica a obrigatoriedade do preenchimento do C,D,E


1418 CNPJ ou do CCM do Intermedirio.

4.4.2. Alertas

Tabela de Alertas
Manual de Utilizao Web Service Verso do Manual: 2.4.4 pg. 51

Cdigo Descrio Onde Ocorre

Alquota informada (<valor da alquota>) difere da alquota vigente (<valor da alquota vigente>)
208 para o cdigo de servio informado (<cdigo de atividade>). O sistema ir adotar a alquota C,D,E
vigente.
A inscrio municipal do tomador (<Inscrio Municipal do Tomador>) no foi encontrada na
211 C,D,E
base de dados de CCM.
Cidade/UF informada (<cidade do Tomador>)/(<UF do Tomador>) no foi encontrada na base
214 C,D,E
de dados.
RPS j foi convertido individualmente em NF-e atravs do site e no ser processado
216 C,D,E
novamente.
RPS reenviado. A NF-e (<nmero da NF-e>) referente ao RPS (Nmero: <nmero do RPS >,
217 C,D,E
Srie: <sria do RPS >) foi cancelada e uma nova NF-e foi emitida.
O CNPJ informado (<CNPJ>) possui inscrio municipal em So Paulo, porm foi informado
221 C,D,E
endereo de fora do municpio (<cidade/UF>).

1301 NF-e j cancelada em <data de cancelamento>. K

1302 NF-e em duplicidade na mensagem XML enviada. K

1405 No h nenhuma Inscrio Municipal vinculada ao CPF/CNPJ informado. L

5. Arquivos de Exemplos

Para obter exemplos das mensagens XML para todos os pedidos e retornos, acesse:

a) NFS-e emitidas at 22/02/2015

https://nfe.prefeitura.sp.gov.br/ws/exemplos.zip

b) NFS-e emitidas a partir de 23/02/2015

https://nfe.prefeitura.sp.gov.br/ws/exemplosV02.zip

Anexo I

TABELA DE MUNICPIOS

Os campos de cdigos de municpios devem ser informados com a utilizao da Tabela de Municpios
mantida pelo IBGE.