Академический Документы
Профессиональный Документы
Культура Документы
Eletrnica de
Servios
Manual de Utilizao
Web Service
Verso 2.4.1
pg. 2
Manual de Utilizao
Web Service
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
pg. 3
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 e/ou tomadoras 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
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 Eletrnica. Esta interface destinasse 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 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 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 os prestadores de servios consultarem as NF-e emitidas por ele.
2.5. CONSULTA DE NF-E RECEBIDAS
Esta interface possibilita aos tomadores e/ou prestadores de servios consultarem as NF-e que tiverem
sido emitidas para ele, 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
ele.
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.
pg. 5
pg. 6
3. ARQUITETURA DE COMUNICAO
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:
pg. 7
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).
pg. 8
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.
DESCRIO
Web Services
Internet
Protocolo Internet
pg. 10
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:
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.
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.
de
Pedido
de
Envio
de
Lote
de
pg. 12
RPS
(arquivo
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.
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:
DESCRIO
SUBSTITUIR POR
>
Sinal de maior
>
<
Sinal de menor
<
&
E-comercial
&
Aspas
"
Sinal de apstrofe
'
pg. 14
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.
pg. 15
tpCidade
TIPO
BASE
TAMANHO
DEC
OBSERVAO
O cdigo informado dever
pertencer Tabela de Municpios
(do IBGE) disponibilizada pela
Prefeitura de So Paulo.
TIPO
BASE
TAMANHO
DEC
OBSERVAO
Exemplo:
tpAliquota
3-5
5% - 0.05
2,5% - 0.025
1,75% - 0.0175
tpAssinatura
tpAssinaturaCancelamento
Base64
Binary
Assinatura Digital de
Base64
Binary
Cancelamento de NF-e.
DESCRIO
TIPO
BASE
TAMANHO
Bairro do endereo
0-30
Bairro
CEP do endereo
7-8
CEP
NOME DO TIPO
tpBairro
tpCEP
tpCidade
tpCNPJ
14
tpCodigoServico
tpCodigoEvento
Cdigos de Servio
Cdigo do Evento
4-5
3-4
DEC
pg. 16
OBSERVAO
tpCodigoVerificacao
tpComplementoEndereco
Complemento do Endereo
0-30
tpCPF
Nmero no Cadastro de
Pessoas Fsicas
11
tpDescricaoEvento
Descrio do Evento
0-300
Descrio correspondente ao
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
0-2000
tpEmail
0-75
tpInscricaoEstadual
Inscrio Estadual
1-19
tpInscricaoMunicipal
Inscrio Municipal
DESCRIO
TIPO
BASE
TAMANHO
Endereo
0-50
tpNumero
Nmero
1-12
tpNumeroEndereco
Nmero do Endereo
0-10
NOME DO TIPO
tpLogradouro
DEC
pg. 17
OBSERVAO
tpQuantidade
Tipo Quantidade
1-15
tpRazaoSocial
0-75
tpSerieRPS
1-5
Srie do RPS
tpStatusNFe
Status da NF-e
Status da NF-e:
N Normal;
C Cancelada
tpSucesso
tpTempoProcessamento
Tempo de processamento
(segundos).
1-15
tpTipoLogradouro
Tipo de endereo.
0-3
tpTipoRPS
Tipo do RPS.
DESCRIO
NOME DO TIPO
TIPO
BASE
TAMANHO
DEC
pg. 18
OBSERVAO
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
T Tributado em So Paulo
Sigla da UF do endereo.
Sigla da UF do endereo.
Tipo utilizado para valores com
15 dgitos, sendo 13 de corpo e 2
decimais.
tpValor
Valores
0-15
Exemplo:
R$ 500,85 500.85
R$ 826,00 826
O contedo deste campo indica a
verso do Schema XML utilizado.
Exemplo:
tpVersao
Verso
1-3
Verso 1 1
Verso 10 10
Verso 100 100
Exemplo:
tpPercentualCargaTributari
a
5% - 0.05
2,5% - 0.025
1,75% - 0.0175
tpFonteCargaTributaria
0-10
Exemplo: IBPT
pg. 19
pg. 20
tpNFe
Tipo que representa uma NF-e
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
Assinatura
tpAssinatura
0-1
ChaveNFe
tpChaveNFe
1-1
DataEmissaoNFe
dateTime
1-1
NumeroLote
tpNumero
0-1
ChaveRPS
tpChaveRPS
0-1
tabela tpChaveRPS).
TipoRPS
tpTipoRPS
0-1
Tipo do RPS.
DataEmissaoRPS
date
0-1
CPFCNPJPrestador
tpCPFCNPJ
1-1
CPF/CNPJ do prestador.
RazaoSocialPrestador
tpRazaoSocial
1-1
EnderecoPrestador
tpEndereco
1-1
Endereo do prestador.
pg. 21
EmailPrestador
tpEmail
0-1
E-mail do prestador.
StatusNFe
tpStatusNFe
1-1
Status da NF-e.
DataCancelamento
date
0-1
TributacaoNFe
tpTributacaoNFe
1-1
OpcaoSimples
tpOpcaoSimples
1-1
NumeroGuia
tpNumero
0-1
DataQuitacaoGuia
Date
0-1
ValorServicos
tpValor
1-1
ValorDeducoes
tpValor
0-1
ValorPIS
tpValor
0-1
ValorCOFINS
tpValor
0-1
ValorINSS
tpValor
0-1
ValorIR
tpValor
0-1
ValorCSLL
tpValor
0-1
CodigoServico
tpCodigo
1-1
AliquotaServicos
tpAliquota
1-1
ValorISS
tpValor
1-1
ValorCredito
tpValor
1-1
ISSRetido
Boolean
1-1
CPFCNPJTomador
tpCPFCNPJ
0-1
CPF/CNPJ do tomador.
InscricaoMunicipalTomador
tpInscricaoMunicipal
0-1
InscricaoEstadualTomador
tpInscricaoEstadual
0-1
RazaoSocialTomador
tpRazaoSocial
0-1
EnderecoTomador
tpEndereco
0-1
Endereo do tomador.
EmailTomador
tpEmail
0-1
E-mail do tomador.
CPFCNPJIntermediario
tpCPFCNPJ
0-1
CPF/CNPJ do intermedirio
InscricaoMunicipalIntermediario
tpInscricaoMunicipal
0-1
ISSRetidoIntermediario
Boolean
0-1
EmailIntermediario
tpEmail
0-1
E-mail do intermedirio
ValorCargaTributaria
tpValor
0-1
PercentualCargaTributaria
tpPercentualCargaTributaria
0-1
FonteCargaTributaria
tpFonteCargaTributaria
0-1
CodigoCEI
tpNumero
0-1
MatriculaObra
tpNumero
0-1
MunicipioPrestacao
tpCidade
0-1
Discriminacao
tpDiscriminacao
1-1
pg. 22
TpRPS
Tipo que representa RPS
Nome do Elemento
Tipo do Elemento
Ocorrncia
Descrio
Assinatura
tpAssinatura
1-1
ChaveRPS
tpChaveRPS
1-1
TipoRPS
tpTipoRPS
1-1
Tipo do RPS.
DataEmissao
date
1-1
StatusRPS
tpStatusNFe
1-1
Status do RPS.
TributacaoRPS
tpTributacaoNFe
1-1
ValorServicos
tpValor
1-1
ValorDeducoes
tpValor
1-1
ValorPIS
tpValor
0-1
ValorCOFINS
tpValor
0-1
ValorINSS
tpValor
0-1
ValorIR
tpValor
0-1
ValorCSLL
tpValor
0-1
CodigoServico
tpCodigo
1-1
AliquotaServicos
tpAliquota
1-1
ISSRetido
Boolean
1-1
Item 4.3.2).
Chave de identificao do RPS (ver detalhes na tabela
tpChaveRPS).
tpCPFCNPJ
0-1
InscricaoMunicipalTomador
tpInscricaoMunicipal
0-1
InscricaoEstadualTomador
tpInscricaoEstadual
0-1
RazaoSocialTomador
tpRazaoSocial
0-1
EnderecoTomador
tpEndereco
0-1
Endereo do tomador.
EmailTomador
tpEmail
0-1
E-mail do tomador.
CPFCNPJIntermediario
tpCPFCNPJ
0-1
InscricaoMunicipalIntermediario
tpInscricaoMunicipal
0-1
ISSRetidoIntermediario
Boolean
0-1
EmailIntermediario
tpEmail
0-1
E-mail do intermedirio
Discriminacao
tpDiscriminacao
1-1
pg. 23
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:
Descrio dos nomes e abreviaes utilizadas no cabealho das tabelas que representam 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;
pg. 24
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:
pg. 25
#
1
Informao
Inscrio
Municipal
Contedo
do
Prestador
Srie do RPS
Nmero do RPS
Status do RPS
ISS Retido
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
Valor das Dedues do RPS, incluindo os centavos (sem ponto decimal e sem
pg. 26
11
Cdigo
do
Servio
Prestado
Indicador de CPF/CNPJ do
Tomador
12
CPF/CNPJ do Tomador
13
Indicador de CPF/CNPJ do
Intermedirio
14
CPF/CNPJ
Intermedirio
do
15
...
<ChaveRPS>
<InscricaoPrestador>31000000</InscricaoPrestador>
<SerieRPS>OL03</SerieRPS>
<NumeroRPS>1</NumeroRPS>
</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>
pg. 27
<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
pg. 28
Retorno:
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:
pg. 29
pg. 30
Pedido:
Retorno:
pg. 31
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.
I.
II.
III.
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.
Mtodo: ConsultaNFe
O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:
V.
Pedido:
pg. 32
pg. 33
Retorno:
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
P1
Cabecalho
Versao
CPFCNPJRemet
ente
Descrio
TAG de grupo das
informaes do
cabealho.
Verso do XML
Schema Utilizado.
CPF/CNPJ do
Remetente
autorizado a enviar a
mensagem XML.
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
Observao
pg. 34
PedidoConsultaNFePeriodo.xsd*
#
Campo
Descrio
Ele
Pai
Tipo
Ocorr.
P1
tpCPFCNPJ
1-1
Observao
Para consulta de
NF-e Recebidas:
CPFCNPJ
Informe o CPF/CNPJ
do tomador da NF-e.
Para consulta de
NF-e Emitidas:
Informe o CNPJ do
emissor da NF-e.
Para consulta de
NF-e Recebidas:
Informe a Inscrio
Inscricao
Municipal do
Tomador.
Para consulta de
NF-e Emitidas:
P1
tpInscricaoMunicipal
0-1
Informe a Inscrio
Municipal do
Prestador. Neste tipo
de consulta o
preenchimento deste
campo se torna
obrigatrio.
dtInicio
dtFim
NumeroPagina **
P2
Signature
ATENO 1: Este
campo s dever ser
preenchido com a
inscrio de
contribuintes
estabelecidos no
municpio de So
Paulo
(CCM).
Data incio da
consulta.
P1
1-1
P1
1-1
Nmero da pgina
consultada
P1
tpNumero
1-1
Default = 1
1-1
Signature o
elemento raiz de uma
assinatura XML. Este
elemento descrito no
arquivo xmldsigcoreschema_v01.xsd
Assinatura digital da
mensagem XML.
SignatureType
pg. 35
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 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 por tanto 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.
Abaixo, fluxo de funcionamento baseado no exemplo descrito:
IV.
V.
pg. 36
Pedido:
Retorno:
I.
Descrio: Este mtodo responsvel por atender aos pedidos de consulta de NF-e Emitidas.
II.
Mtodo: ConsultaNFeEmitidas
III.
IV.
V.
pg. 37
Pedido:
Retorno:
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:
pg. 38
PedidoConsultaLote.xsd*
#
Campo
P1
Cabecalho
Versao
P2
Descrio
TAG de grupo das
informaes do
cabealho.
Verso do XML
Schema Utilizado.
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
CNPJRemetente
CNPJ do Remetente
autorizado a enviar a
mensagem XML.
P1
tpCPFCNPJ
1-1
NumeroLote
P1
tpNumero
1-1
Signature
Assinatura digital da
mensagem XML.
SignatureType
1-1
Observao
Signature o
elemento raiz de uma
assinatura XML. Este
elemento descrito no
arquivo xmldsigcoreschema_v01.xsd
IV.
V.
Pedido:
Retorno:
pg. 39
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
P1
Cabecalho
Versao
P2
Descrio
TAG de grupo das
informaes do
cabealho.
Verso do XML
Schema Utilizado.
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
CNPJRemetente
CNPJ do
Remetente
autorizado a enviar
a mensagem XML.
NumeroLote
Nmero do Lote a
ser consultado.
P1
tpNumero
0-1
InscricaoPrestador
Inscrio municipal
do prestador de
servios que gerou
o lote a ser
consultado.
P1
tpInscricaoMunicipal
1-1
Signature
Assinatura digital
da mensagem
XML.
SignatureType
1-1
Observao
Caso no seja
informado o nmero do
lote, sero retornadas
informaes do ltimo
lote gerador de NF-e.
Signature o
elemento raiz de uma
assinatura XML. Este
elemento descrito no
arquivo xmldsigcoreschema_v01.xsd
IV.
pg. 40
Campo
P1
Cabecalho
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpSucesso
1-1
P1
tpInformacoesLote
0-1
Alerta
Informaes sobre a
ocorrncia de eventos
geradores de alertas durante
o processamento da
mensagem XML.
tpEvento
0-N
Erro
Informaes sobre a
ocorrncia de eventos
geradores de erros durante o
processamento da
mensagem XML.
tpEvento
0-N
Versao
Sucesso
InformacoesLote
P2
P3
Descrio
TAG de grupo das
informaes do cabealho.
Verso do XML
Schema Utilizado.
Pedido:
Retorno:
Observao
pg. 41
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
P1
Cabecalho
Versao
Descrio
TAG de grupo das
informaes do
cabealho.
Verso do XML
Schema Utilizado.
CNPJ do Remetente
CNPJRemetent
autorizado a enviar a
e
mensagem XML
Transacao
Informe se as NF-e a
serem canceladas
faro parte de uma
mesma transao.
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
P1
tpCPFCNPJ
1-1
P1
Boolean
0-1
Observao
P2
Detalhe
ChaveNFe
Chave da NF-e.
P2
tpChaveNFe
1-1
P2
tpAssinaturaCa
ncelamento
1-1
Assinatura de
AssinaturaCanc
Cancelamento da
elamento
NF-e.
P3
Signature
Assinatura digital da
mensagem XML.
1-50
SignatureType
1-1
pg. 42
Observao 1: Transao
Se ocorrerem eventos de erro de validao dos dados do cabealho do pedido de cancelamento de NFe, 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
Nmero da NF-e
Contedo
Inscrio Municipal do Prestador com 8 posies (dgitos). Completar com
zeros esquerda caso seja necessrio.
Nmero da NF-e com 12 posies (dgitos). Completar com zeros
esquerda caso seja necessrio.
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.
pg. 43
RetornoCancelamentoNFe.xsd*
#
Campo
Descrio
Ele
Pai
Tipo
Ocorr.
P1
Cabecalho
1-1
P1
tpVersao
1-1
Status do cancelamento.
P1
tpSucesso
1-1
tpEvento
0-N
tpEvento
0-N
Versao
Sucesso
Verso do XML
Schema Utilizado.
P2
Alerta
P3
Erro
Observao
Pedido:
Retorno:
pg. 44
I.
II.
III.
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.
Mtodo: ConsultaCNPJ
O parmetro MensagemXML (ver item 4.3.1) dever ser preenchido conforme tabela a seguir:
PedidoConsultaCNPJ.xsd*
#
Campo
P1
Cabecalho
Versao
P2
P3
Descrio
TAG de grupo das
informaes do
cabealho.
Verso do XML
Schema Utilizado.
Ele
Pai
Tipo
Ocorr.
1-1
P1
tpVersao
1-1
CNPJRemetente
CNPJ do Remetente
autorizado a enviar a
mensagem XML
P1
tpCPFCNPJ
1-1
CNPJContribuinte
CNPJ do contribuinte
que se deseja
consultar.
tpCPFCNPJ
1-1
Signature
Assinatura digital da
mensagem XML.
SignatureType
1-1
IV.
Observao
Signature o elemento
raiz de uma assinatura
XML. Este elemento
descrito no arquivo
xmldsigcoreschema_v01.xsd
pg. 45
RetornoConsultaCNPJ.xsd*
#
Campo
Descrio
Ele
Pai
Tipo
Ocorr.
P1
Cabecalho
1-1
P1
tpVersao
1-1
Status do cancelamento.
P1
tpSucesso
1-1
tpEvento
0-N
tpEvento
0-N
Versao
Sucesso
Verso do XML
Schema Utilizado.
P2
Alerta
P3
Erro
P4
Detalhe
P4
tpInscricaoMuni
cipal
1-1
P4
Boolean
1-1
Observao
0-N
V.
Pedido:
Retorno:
pg. 46
VALIDAO DO SCHEMA;
VERIFICAO DO CERTIFICADO/ASSINATURA;
Envio de RPS;
Envio de Lote de RPS;
Teste de Envio de Lote de RPS;
Consulta de NF-e;
Consulta de NF-e Recebidas;
Consulta de NF-e Emitidas;
Consulta de Lote;
Consulta de Informaes de Lote;
Cancelamento de NF-e;
Consulta de CNPJ.
4.4.1. Erros
Descrio
Onde Ocorre
1001
1002
1050
1051
1052
1053
1054
1055
1056
1057
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
206
Tipo de tributao invlido. Para mais informaes consulte o item 14.20 da seo de
perguntas e respostas.
C,D,E
207
Data de Emisso do RPS no est compreendida entre <data inicio de emisso do lote> e
<data fim de emisso do lote> conforme especificado no cabealho da mensagem XML.
209
D,E
C,D,E
Cdigo
Descrio
pg. 47
Onde Ocorre
215
RPS em duplicidade na mensagem XML enviada. RPS: <Nmero do RPS> Srie: <Srie do
RPS>.
218
RPS no poder ser enviado novamente, pois est includo em Guia de Recolhimento.
C,D,E
219
C,D,E
220
C,D,E
301
C,D,E
302
C,D,E
303
C,D,E
304
C,D,E
305
C,D,E
306
C,D,E
308
C,D,E
309
C,D,E
310
C,D,E
311
C,D,E
312
C,D,E
313
C,D,E
314
C,D,E
315
C,D,E
317
C,D,E
318
C,D,E
320
C,D,E
321
Apenas Notas com tributao no municpio ou fora do municpio podem sofrer reteno de ISS.
C,D,E
322
C,D,E
323
C,D,E
324
C,D,E
338
RPS no poder ser enviado novamente. A NFS-e ({0}) no pde ser cancelada
C,D,E
342
C,D,E
D,E
343
505
C,D,E
506
C,D,E
508
O cdigo de servio ({0}) no permite que o ISS seja retido pelo Intermedirio.
C,D,E
509
C,D,E
511
informado.
513
C,D,E
514
C,D,E
Cdigo
Descrio
pg. 48
Onde Ocorre
516
C,D,E
519
Para NFS-e sem identificao do intermedirio, a NFS-e dever ser emitida sem reteno ou
com reteno pelo tomador.
C,D,E
1100
O CNPJ do usurio autorizado a enviar a mensagem XML no confere com o CNPJ usado na
comunicao.
C,D,E,F,G,H,I,J,K,L
1101
C,D,E,F,G,H,I,J,K,L
1102
C,D,E,F,G,H,I,J,K,L
1105
Lote no encontrado.
I,J
1106
NF-e no encontrada.
1107
1108
1109
CPF/CNPJ invlido.
1201
S permitido o envio de RPS emitidos por um nico Prestador de Servios (mesma inscrio
municipal).
D,E
1202
D,E
1203
D,E
1204
Valor Total de Servios no confere com o enviado (<somatrio do valor dos servios
presentes no arquivo>).
D,E
1205
Valor Total de Deduo no confere com o enviado (<somatrio do valor das dedues
presentes no arquivo>).
D,E
1206
C,D,E
1207
C,D,E
1212
C,D,E
1213
C,D,E
1222
C,D,E
1223
C,D,E
1225
C,D,E
1227
C,D,E
1228
C,D,E
1232
C,D,E
1233
C,D,E
1234
C,D,E
C,D,E,H,I,J
C,D,E
C,D,E,G,H,L
1303
1304
1305
1306
1401
S permitido consultar NF-e emitidas por um nico Prestador de Servios (mesma inscrio
municipal).
Cdigo
Descrio
pg. 49
Onde Ocorre
1402
G,H
1403
G,H
1404
1418
J
C,D,E
4.4.2. Alertas
Tabela de Alertas
Cdigo
Descrio
Onde Ocorre
208
Alquota informada (<valor da alquota>) difere da alquota vigente (<valor da alquota vigente>)
para o cdigo de servio informado (<cdigo de atividade>). O sistema ir adotar a alquota
vigente.
C,D,E
211
C,D,E
214
C,D,E
216
C,D,E
217
RPS reenviado. A NF-e (<nmero da NF-e>) referente ao RPS (Nmero: <nmero do RPS >,
Srie: <sria do RPS >) foi cancelada e uma nova NF-e foi emitida.
C,D,E
221
O CNPJ informado (<CNPJ>) possui inscrio municipal em So Paulo, porm foi informado
endereo de fora do municpio (<cidade/UF>).
C,D,E
1301
1302
1405
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
pg. 50
Anexo I
TABELA DE MUNICPIOS
Os campos de cdigos de municpios devem ser informados com a utilizao da Tabela de Municpios
mantida pelo IBGE.