Académique Documents
Professionnel Documents
Culture Documents
Verso 1.00
Setembro 2010
Controle de Verses
Verso
0.00
1.00
Data
17/06/2010 SP
20/08/2010 RS/SC/SP
Este documento tem por objetivo a definio das especificaes tcnicas necessrias para a
implementao da Carta de Correo eletrnica CC-e e adequao da Consulta Situao da NF-e
para permitir a consulta dos eventos da NF-e 2G.
O documento ser tratado como um documento independente durante a fase de desenvolvimento do
Web Service para facilitar a sua manuteno e aperfeioamento.
Aps a disponibilizao do Web Service de Registro do Evento Carta de Correo em ambiente de
produo, o documento passar a fazer parte do Manual de Integrao do Contribuinte verso
4.01.
Pg. 2 / 15
4.5
Client NFe
Proc.
nfeConsultaNF
Consulta NF-e
Ret
Retorno
Consulta NF-e
Aplicao NF-e
Campo
EP01 conSitNFe
Ele
Pai
Descrio/Observao
Raiz
EP02 versao
EP01
1-1
1-4
EP03 tpAmb
EP01
1-1
Identificao do Ambiente:
1 Produo / 2 - Homologao
EP04 xServ
EP01
1-1
Servio solicitado
CONSULTAR
EP05 chNFe
EP01
1-1
44
4.5.2
TAG raiz
2
Verso do leiaute
Campo
ER01 retConsSitNFe
Ele
Pai
Raiz -
Descrio/Observao
ER02 versao
ER01
1-1
1-4
ER03 tpAmb
ER01
1-1
ER04 verAplic
ER01
1-1
1-20
Verso do leiaute
Identificao do Ambiente:
1 Produo / 2 Homologao
Verso do Aplicativo que processou a consulta.
A verso deve ser iniciada com a sigla da UF
nos casos de WS prprio ou a sigla SCAN,
Pg. 3 / 15
ER01
1-1
ER06 xMotivo
ER01
1-1
1-255
ER07 cUF
ER01
1-1
EP07a chNFe
ER01
1-1
44
ER08 protNFe
ER01
xml
0-1
ER09 retCancNFe
ER01
xml
0-1
ER10 procEventoNFe
ER01
xml
0-N
4.5.3
Este mtodo ser responsvel por receber as solicitaes referentes consulta de situao de notas
fiscais eletrnicas enviadas para as Secretarias de Fazendas Estaduais. Seu acesso permitido
apenas pela chave nica de identificao da nota fiscal.
O aplicativo do contribuinte envia a solicitao para o Web Service da Secretaria de Fazenda
Estadual. Ao receber a solicitao a aplicao do Portal da Secretaria de Fazenda Estadual
processar a solicitao de consulta, validando a Chave de Acesso da NF-e, e retornar mensagem
contendo a situao atual da NF-e na Base de Dados e todos os protocolos dos eventos existentes
para a NF-e consultada.
Devero ser realizadas as validaes e procedimentos que seguem.
4.5.4
Msg
Efeito
280
Rej.
281
Rej.
Regra de Validao
Obrig.
283
Rej.
Obrig.
286
Rej.
Obrig.
284
Rej.
Obrig.
285
Rej.
Obrig.
282
Rej.
As validaes de A01, A02, A03, A04 e A05 so realizadas pelo protocolo SSL e no precisam ser
implementadas. A validao A06 tambm pode ser realizada pelo protocolo SSL, mas pode falhar se
Pg. 4 / 15
existirem outros certificados digitais de Autoridade Certificadora Raiz que no sejam ICP-Brasil no
repositrio de certificados digitais do servidor de Web Service da SEFAZ.
4.5.5
Msg
Efeito
Obrig.
214
Rej.
Facult.
243
Rej.
Obrig.
108
Rej.
Obrig.
109
Rej.
Regra de Validao
A mensagem ser descartada se o tamanho exceder o limite previsto (500 KB) A aplicao do
contribuinte no poder permitir a gerao de mensagem com tamanho superior a 500 KB. Caso isto
ocorra, a conexo poder ser interrompida sem mensagem de erro se o controle do tamanho da
mensagem for implementado por configuraes do ambiente de rede da SEFAZ (ex.: controle no
firewall). No caso do controle de tamanho ser implementado por aplicativo teremos a devoluo da
mensagem de erro 214.
As unidades federadas que mantm o Web Service disponvel, mesmo quando o servio estiver
paralisado, devero implementar as verificaes 108 e 109. Estas validaes podero ser
dispensadas se o Web Service no ficar disponvel quando o servio estiver paralisado.
4.5.6
Regra de Validao
Aplic.
Msg
Efeito
Facult.
242
Rej.
Obrig.
409
Rej.
Obrig.
410
Rej.
411
Rej.
238
Rej.
239
Rej.
Obrig.
O campo versaoDados contm a verso do Schema XML da mensagem contida na rea de dados
que ser utilizado pelo Web Service.
4.5.7
Msg Efeito
Obrig.
215
Rej.
D01a Em caso de Falha de Schema, verificar se existe a tag raiz esperada Facul.
516
Rej.
Regra de Validao
Pg. 5 / 15
para mensagem
D01b Em caso de Falha de Schema, verificar se existe o atributo versao
para a tag raiz da mensagem
D01c Em caso de Falha de Schema, verificar se o contedo do atributo
versao difere do contedo da versaoDados informado no
SOAPHeader
D01d Verifica a existncia de qualquer namespace diverso do namespace
padro da NF-e (http://www.portalfiscal.inf.br/nfe)
D01e Verifica a existncia de caracteres de edio no incio ou fim da
mensagem ou entre as tags
D02 Verifica o uso de prefixo no namespace
D03 XML utiliza codificao diferente de UTF-8
Facul.
517
Rej.
Facul.
545
Rej.
Facul.
587
Rej.
Facul.
588
Rej.
Obrig.
404
Rej.
Obrig.
402
Rej.
Msg
Efeito
Obrig.
252
Rej.
Obrig.
226
Rej.
J03 Acesso BD NFE (Chave: Ano, CNPJ Emit, Modelo, Srie, Nro): Obrig.
- Verificar se NF-e no existe
217
Rej.
562
Rej.
561
Rej.
4.5.8
Regra de Validao
Final do Processamento
O processamento do pedido de consulta de status de NF-e pode resultar em uma mensagem de erro
ou retornar a situao atual da NF-e consultada.
No caso de localizao da NF-e retornar o cStat com os valores 100-Autorizado o Uso, 101Cancelamento de NF-e Homologado ou 110-Uso Denegado
Pg. 6 / 15
4.8
WS da Fazenda
Web Service :
RecepcaoEvento
Proc.
nfeRecepcaoEvento
Ret
Cliente
Recepo
Aplicao SRE
Retorno
O registro de uma nova Carta de Correo substitui a Carta de Correo anterior, assim a nova Carta
de Correo deve conter todas as correes a serem consideradas.
Processo: sncrono.
Mtodo: nfeRecepcaoEvento
4.8.1
Campo
HP01 envEvento
HP02 versao
Ele
Pai
Raiz
HP01
1-1
1-4
Descrio/Observao
TAG raiz
Verso do leiaute
Pg. 7 / 15
Campo
Ele
Pai
HP03 idLote
HP01
1-1
HP04 evento
HP01
xml
1-20
HP05 versao
HP04
1-1
1-4
HP06 infEvento
HP04
HP07 Id
ID HP06
1-1
54
HP08 cOrgao
HP06
1-1
HP09 tpAmb
HP06
1-1
Identificao do Ambiente:
1 - Produo
2 Homologao
HP10 CNPJ
CE HP06
1-1
14
HP11 CPF
CE HP06
1-1
11
44
1-15
1-1
HP12 chNFe
HP06
1-1
HP13 dhEvento
HP06
1-1
Descrio/Observao
HP14 tpEvento
HP06
1-1
HP15 nSeqEvento
HP06
1-1
1-2
HP16 verEvento
HP06
1-1
1-4
HP17 detEvento
HP06
1-1
HP18 versao
HP17
1-1
HP19 descEvento
HP17
1-1
5-60
Carta de Correo
HP20 xCorrecao
HP17
1-1
151000
HP21 Signature
HP04 XML
4.8.2
Verso do evento
Informaes da carta de correo
Verso da carta de correo
1-1
Campo
HR01 retEnvEvento
Ele
Pai
Raiz
Descrio/Observao
TAG raiz do Resultado do Envio do Evento
HR02 versao
HR01
1-1
1-4
HR03 idLote
HR01
1-1
1-15
HR04 tpAmb
HR01
1-1
HR05 verAplic
HR01
1-1
1-20
HR06 cOrgao
HR01
1-1
Verso do leiaute
Identificador de controle do Lote de envio do Evento.
Nmero seqencial autoincremental nico para identificao
do Lote.
Identificao do Ambiente:
1 Produo / 2 - Homologao
Verso da aplicao que processou o evento.
Cdigo da UF que registrou o Evento. Utilizar 90 para o
Pg. 8 / 15
Ambiente Nacional.
HR07 cStat
HR01
1-1
HR08 xMotivo
HR01
1-1
255
HR09 retEvento
HR01
0-20
HR10 versao
HR09
1-1
1-4
HR11 infEvento
HR09
HR12 Id
ID HR11
0-1
17
HR13 tpAmb
HR11
1-1
Identificao do Ambiente:
1 Produo / 2 Homologao
HR14 verAplic
HR11
1-1
1-20
HR15 cOrgao
HR11
1-1
HR16 cStat
HR11
1-1
HR17 xMotivo
HR11
1-1
255
HR18 chNFe
HR11
0-1
44
HR19 tpEvento
HR11
0-1
HR20 xEvento
HR11
0-1
5-60
HR21 nSeqEvento
HR11
0-1
1-2
HR22 CNPJDest
CE HR11
0-1
14
HR23 CPFDest
CE HR11
0-1
11
1-60
1-1
HR24 emailDest
HR11
0-1
HR25 dhRegEvento
HR11
1-1
HR26 nProt
HR11
0-1
HR27 Signature
HR09 XML
4.8.3
0-1
Verso do leiaute
Grupo de informaes do registro do Evento
15
O WS de Eventos acionado pelo interessado emissor da NF-e que deve enviar mensagem de
registro de evento da Carta de Correo.
O processo de Registro de Eventos recebe eventos em uma estrutura de lotes, que pode conter de 1
a 20 eventos.
4.8.4
Regra de Validao
Crtica
Pg. 9 / 15
Msg
Efeito
Obrig.
280
Rej.
Obrig.
281
Rej.
Obrig.
283
Rej.
Obrig.
286
Rej.
Obrig.
284
Rej.
Obrig.
285
Rej.
Obrig.
282
Rej.
As validaes de A01, A02, A03, A04 e A05 so realizadas pelo protocolo SSL e no precisam ser
implementadas. A validao A06 tambm pode ser realizada pelo protocolo SSL, mas pode falhar se
existirem outros certificados digitais de Autoridade Certificadora Raiz que no sejam ICP-Brasil no
repositrio de certificados digitais do servidor de Web Service do rgo de registro.
4.8.5
Msg
Efeito
Obrig.
214
Rej.
Obrig.
108
Rej.
Obrig.
109
Rej.
Regra de Validao
A mensagem ser descartada se o tamanho exceder o limite previsto (500 KB). A aplicao do
contribuinte no poder permitir a gerao de mensagem com tamanho superior a 500 KB. Caso isto
ocorra, a conexo poder ser interrompida sem retorno da mensagem de erro se o controle do
tamanho da mensagem for implementado por configuraes do ambiente de rede (ex.: controle no
firewall). No caso do controle de tamanho ser implementado por aplicativo teremos a devoluo da
mensagem de erro 214.
Caso o Web Service fique disponvel, mesmo quando o servio estiver paralisado, devero
implementar as verificaes 108 e 109. Estas validaes podero ser dispensadas se o Web Service
no ficar disponvel quando o servio estiver paralisado.
4.8.6
Regra de Validao
Obrig.
242
Rej.
Obrig.
409
Rej.
Obrig.
410
Rej.
Obrig.
411
Rej.
Pg. 10 / 15
Facult.
Obrig.
238
239
Rej.
Rej.
4.8.7
Msg
Efeito
Obrig.
225
Rej.
D01a Em caso de Falha de Schema, verificar se existe a tag raiz esperada para o
lote
D01b Em caso de Falha de Schema, verificar se existe o atributo versao para a
tag raiz da mensagem
D01c Em caso de Falha de Schema, verificar se o contedo do atributo versao
difere do contedo da versaoDados informado no SOAPHeader
D01d Verifica a existncia de qualquer namespace diverso do namespace padro
da NF-e (http://www.portalfiscal.inf.br/nfe)
D01e Verifica a existncia de caracteres de edio no incio ou fim da mensagem
ou entre as tags
D02 Verifica o uso de prefixo no namespace
Facul.
516
Rej.
Facul.
517
Rej.
Facul.
545
Rej.
Facul.
587
Rej.
Facul.
588
Rej.
Obrig.
404
Rej.
Obrig.
402
Rej.
Regra de Validao
Regra de Validao
Pg. 11 / 15
Aplic.
Msg
Efeito
Obrig.
491
Rej.
Obrig.
492
Rej.
Obrig.
493
Rej.
Msg
Efeito
Obrig.
290
Rej.
Obrig.
291
Rej.
Obrig.
292
Rej.
Obrig.
293
Rej.
Obrig.
296
Rej.
Obrig.
294
Rej.
Obrig.
295
Rej.
Regra de Validao
Msg
Efeito
Obrig.
298
Rej.
Obrig.
297
Rej.
213
Rej.
Aplic.
Msg
Efeito
Obrig.
252
Rej.
Obrig.
250
Rej.
Obrig.
489
Rej.
Regra de Validao
Regra de Validao
Pg. 12 / 15
Aplic.
Msg
Efeito
Obrig.
490
Rej.
Obrig.
572
Rej.
Obrig.
Obrig.
Obrig.
494
573
574
Rej.
Rej.
Rej.
Obrig.
575
Rej.
Obrig.
576
Rej.
Obrig.
Obrig.
Obrig.
577
578
579
Rej.
Rej.
Rej.
Aplic.
Msg
Efeito
GA01 Verificar se a NF-e est autorizada (no pode estar cancelada nem denegada)
Obrig.
580
Rej.
Obrig.
501
Rej.
4.8.8
4.8.9
Regra de Validao
4.9
O emissor deve manter o arquivo digital da Carta de Correo com a informao de Registro do
Evento da SEFAZ na forma que segue:
Schema XML: procCCeNFe_v99.99.xsd
Pg. 13 / 15
#
ZR01
ZR02
ZR03
YR04
YR05
YR06
Campo
procEventoNFe
versao
evento
(dados)
retEvento
(dados)
Ele
Pai
Pg. 14 / 15
129
135
136
CDIGO
489
490
491
492
493
494
501
572
573
574
575
576
577
578
579
580
587
588
OBS.:
1. Recomendamos a no utilizao de caracteres especiais ou acentuao nos textos das
mensagens de erro.
2. Recomendamos que o campo xMotivo da mensagem de erro para o cdigo 999 seja informado
com a mensagem de erro do aplicativo ou do sistema que gerou a exceo no prevista.
Pg. 15 / 15