Web Service - NFeRecepcaoEvento - Parte Geral
Conteúdo técnico da Visão Geral da NF-e ABI, versão 1.00 e, quando indicado, do Anexo I - Leiaute e Regras de Validação, versão 1.00. O MOC Online é material de apoio e não substitui os documentos oficiais.
Função: serviço destinado à recepção de mensagem de Evento da NF-e ABI.
Processo: síncrono.
Método: nfeRecepcaoEvento.
1. Leiaute da Mensagem de Entrada - Parte Geral
O Web Service de Registro de Evento possui uma interface genérica, complementada por uma área específica para cada tipo de evento. A tabela apresenta a parte geral da mensagem de entrada.
Schema XML: eventoNFeABI_v1.00.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor | Tam | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| P01 | evento | G | - | xml | 1-1 | - | TAG raiz |
| P02 | versao | A | P01 | N | 1-1 | 2v2 | Versão do leiaute do evento |
| P03 | infEvento | G | P01 | - | 1-1 | - | Grupo de informações do registro do Evento |
| P04 | Id | ID | P03 | C | 1-1 | 55 | Identificador da TAG a ser assinada, formado por “ID” + tpEvento + Chave da NF-e + nSeqEvento |
| P05 | cOrgao | E | P03 | N | 1-1 | 2 | Código do órgão de recepção do Evento, conforme Tabela do IBGE ou: 91=Ambiente Nacional Informar o código da UF para este evento. |
| P06 | tpAmb | E | P03 | N | 1-1 | 1 | Identificação do Ambiente: 1=Produção/2=Homologação |
| P07 | CNPJ | CE | P03 | C | 1-1 | 14 | CNPJ do autor do evento |
| P08 | CPF | CE | P03 | C | 1-1 | 11 | CPF do autor do evento |
| P09 | chNFeABI | E | P03 | C | 1-1 | 44 | Chave de Acesso da NF-e à qual o evento será vinculado |
| P10 | dhEvento | E | P03 | D | 1-1 | - | Data e hora do evento no formato AAAA- MMDDThh:mm:ssTZD (UTC – Universal Coordinated Time) |
| P11 | tpEvento | E | P03 | N | 1-1 | 6 | Código do evento |
| P12 | nSeqEvento | E | P03 | N | 1-1 | 1-3 | Sequencial do evento para o mesmo tipo de evento. Informar o valor “1” para este evento. |
| P13 | verEvento | E | P03 | N | 1-1 | 2v2 | Versão do grupo de detalhe do evento. |
| P17 | detEvento | G | P03 | 1-1 | - | Detalhes do evento. Inserir neste local o XML específico do tipo de evento (ex: cancelamento, carta correção, registro de passagem). | |
| P91 | Signature | G | P01 | xml | 1-1 | - | Assinatura Digital do documento XML, a assinatura deverá ser aplicada no elemento infEvento |
2. Leiaute da Mensagem de Retorno - Parte Geral
Retorno: Estrutura XML com a mensagem do resultado da transmissão.
Schema XML: retEventoNFeABI_v1.00.xsd.
| # | Campo | Ele | Pai | Tipo | Ocorr | Tam | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| R01 | retEventoNFeABI | Raiz | - | - | - | - | TAG raiz da mensagem de retorno |
| R02 | versao | A | R01 | N | 1-1 | 2v2 | Versão do leiaute |
| R03 | infEvento | G | R01 | 1-1 | - | Grupo de informações do registro do Evento | |
| R04 | Id | ID | R03 | C | 0-1 | 17 | Identificador da TAG a ser assinada, somente deve ser informado se o órgão de registro assinar a resposta. No caso de assinatura, preencher com o número do protocolo, precedido pela literal “ID” |
| R05 | tpAmb | E | R03 | N | 1-1 | 1 | Idem a mensagem de entrada. |
| R06 | verAplic | E | R03 | C | 1-1 | 1-20 | Versão da aplicação que registrou o Evento, utilizar literal que permita a identificação do órgão, como a sigla da UF ou do órgão. |
| R07 | cOrgao | E | R03 | N | 1-1 | 2 | Idem a mensagem de entrada. |
| R08 | cStat | E | R03 | N | 1-1 | 3 | Código do status da resposta |
| R09 | xMotivo | E | R03 | C | 1-1 | 1-255 | Descrição do status da resposta. |
| R10 | chNFeABI | E | R03 | C | 0-1 | 44 | Idem a mensagem de entrada. |
| R11 | tpEvento | E | R03 | N | 0-1 | 6 | Código do evento |
| R12 | xEvento | E | R03 | C | 0-1 | 5-60 | Descrição do resultado do processamento do evento |
| R13 | nSeqEvento | E | R03 | N | 0-1 | 1-3 | Idem a mensagem de entrada. |
| R14 | dhRegEvento | E | R03 | D | 1-1 | - | Data e hora de registro do evento no formato AAAA- MMDDTHH:MM:SSTZD (formato UTC). Se o evento for rejeitado informar a data e hora de recebimento do evento. |
| R15 | nProt | E | R03 | N | 0-1 | 15 | Número do Protocolo do Evento |
| R99 | Signature | G | R09 | R01 | 0-1 | - | Assinatura Digital do documento XML, a assinatura deverá ser aplicada no elemento infEvento. A decisão de assinar a mensagem fica a critério da UF. |
3. Descrição do Processo de Web Service
O Web Service de Eventos é acionado pelo interessado emissor da NF-e ABI, que deve enviar mensagem de registro de evento.
4. Regras de Validação Genéricas para Todos os Eventos
Serão aplicadas as regras de validação genéricas.
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão (protocolo TLS) |
| B | Validação Inicial da Mensagem no Web Service |
| D | Validação da Área de Dados |
| E | Validação do Certificado Digital de Assinatura |
| F | Validação da Assinatura Digital |
A validação do Schema XML é realizada em toda mensagem de entrada. Como uma parte da mensagem é variável, pode ocorrer falha de Schema XML na parte específica, identificada posteriormente. As regras específicas de cada evento são tratadas nas seções próprias.
| # | Regra de Validação | Aplic. | Msg | Efeito | Descrição Erro |
|---|---|---|---|---|---|
| P07-10 | Atributo “Id” não corresponde à concatenação dos campos do evento (“ID” + tpEvento + chNFe + nSeqEvento) (*1) | Obrig. | 572 | Rej. | Rejeição: Erro Atributo ID do evento não corresponde a concatenação dos campos (“ID” + tpEvento + chNFe + nSeqEvento) |
| P08-10 | Código do órgão de recepção do Evento diverge do definido para este evento (*1) | Obrig. | 250 | Rej. | Rejeição: UF diverge da UF autorizadora |
| P09-10 | Tipo do ambiente difere do ambiente do Web Service (*1) | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento |
| P10-10 | Se informado CNPJ do Autor do Evento: • CNPJ inválido (zeros, nulo ou DV inválido) (*1) |
Obrig. | 489 | Rej. | Rejeição: CNPJ informado inválido (DV ou zeros) |
| P11-10 | Se informado o CPF do Autor do evento: • CPF inválido (zeros, nulo ou DV inválido) (*1) |
Obrig. | 490 | Rej. | Rejeição: CPF informado inválido (DV ou zeros) |
| P11-20 | Se informado o CPF do Autor do evento: • Evento não disponível para Autor tipo pessoa física |
Obrig. | 408 | Rej. | Rejeição: Evento não disponível para Autor pessoa física |
| P12-10 | Validação da Chave de Acesso (tag:chNFe): • Dígito verificador inválido (*1) |
Obrig. | 236 | Rej. | Rejeição: Chave de Acesso com dígito verificador inválido |
| P12-14 | • Código UF inválido (*1) | Obrig. | 614 | Rej. | Rejeição: Chave de Acesso inválida (Código UF inválido) |
| P12-18 | • Ano < 06 ou Ano maior que Ano corrente (*1) | Obrig. | 615 | Rej. | Rejeição: Chave de Acesso inválida (Ano < 06 ou Ano maior que Ano corrente) |
| P12-22 | • Mês = 0 ou Mês > 12 (*1) | Obrig. | 616 | Rej. | Rejeição: Chave de Acesso inválida (Mês < 1 ou Mês > 12) |
| P12-26 | • CNPJ/CPF zerado ou dígito inválido (*1) | Obrig. | 617 | Rej. | Rejeição: Chave de Acesso inválida (CNPJ/CPF zerado ou dígito inválido) |
| P12-30 | • Modelo diferente de 77 (*1) | Obrig. | 618 | Rej. | Rejeição: Chave de Acesso inválida (modelo diferente de 77) |
| P12-34 | • Número NF = 0 (*1) | Obrig. | 619 | Rej. | Rejeição: Chave de Acesso inválida (número NF = 0) |
| P12-40 | • UF da Chave de Acesso diverge da UF Autorizadora | Obrig. | 249 | Rej. | Rejeição: UF da Chave de Acesso diverge da UF autorizadora |
| P12-44 | • CNPJ/CPF do Autor diverge do CNPJ/CPF da Chave de Acesso | Obrig. | 574 | Rej. | Rejeição: Autor do evento diverge do emissor da NF-e |
| P13-10 | Data do evento maior que a data de processamento (aceitar tolerância de até 5 minutos) (*1) | Obrig. | 578 | Rej. | Rejeição: A data do evento não pode ser maior que a data do processamento |
| *** Banco de Dados: Emitente | |||||
| 1P10-10 | Acesso ao Cadastro de Contribuintes (Chave: CNPJ do Autor): • Verificar se Emitente não autorizado a emitir NF-e ABI |
Obrig. | 203 | Rej. | Rejeição: Emissor não habilitado para emissão de NF-e ABI |
| 1P10-20 | • Verificar situação fiscal do emitente | Obrig. | 240 | Rej. | Rejeição: Irregularidade fiscal do emitente |
| *** Banco de Dados: Evento | |||||
| 3P15-10 | Acesso BD de Eventos (Chave: Chave de Acesso, tpEvento, nSeqEvento): • Duplicidade do evento (tpEvento + chNFe + nSeqEvento) (*1) |
Obrig. | 573 | Rej. | Rejeição: Duplicidade de Evento |
*1: Validações genéricas do Registro de Evento.
5. Final do Processamento
O processamento pode resultar em:
- Rejeição: por algum problema que comprometa o processamento;
- Processamento: o XML foi processado (
cStat=128) e a validação de cada evento poderá resultar em:- Rejeição: o evento será descartado, com retorno do código do status do motivo da rejeição;
- Recebido pelo Sistema de Registro de Eventos, com vinculação do evento na NF-e ABI: o evento será armazenado com a vinculação à respectiva NF-e ABI (
cStat=135); - Recebido pelo Sistema de Registro de Eventos - vinculação prejudicada: o evento será armazenado, mas a vinculação fica prejudicada pela inexistência da NF-e no momento do recebimento (
cStat=136).
A resposta pode ser assinada; nesse caso, deve ser preenchido o atributo Id. O atributo é opcional e não deve ser informado se a resposta não for assinada. A orientação vale para todos os tipos de evento.
6. Armazenamento e Disponibilização do Evento
O arquivo digital do Evento, com a respectiva informação do Registro de Evento, deve ser mantido pelo emissor e disponibilizado para o destinatário.
Schema XML: procEventoNFeABI_v1.00.xsd.
| # | Campo | Ele | Pai | Tipo | Ocor. | Tam. | Dec. | Descrição/Observação |
|---|---|---|---|---|---|---|---|---|
| ZR01 | procEventoNFeABI | Raiz | - | - | - | - | - | TAG raiz |
| ZR02 | versao | A | ZR01 | N | 1-1 | 1-4 | 2 | |
| ZR02a | ipTransmissor | A | ZR01 | C | 0-1 | 7-15 | ||
| ZR02b | nPortaCon | A | ZR01 | C | 0-1 | 1-5 | ||
| ZR02c | dhConexao | A | ZR01 | D | 0-1 | - | ||
| ZR03 | eventoNFeABI | G | ZR01 | - | 1-1 | - | - | |
| YR04 | (dados) | - | - | - | - | - | - | Dados do Evento (mensagem de entrada) |
| YR05 | retEventoNFeABI | G | ZR01 | - | 1-1 | - | - | |
| YR06 | (dados) | - | - | - | - | - | - | Dados do registro do Evento (mensagem de saída) |