Sistema de Registro de Eventos - Parte Geral
Esta página consolida a parte geral do Sistema de Registro de Eventos do BP-e conforme o MOC BP-e - Padrões Técnicos v.1.00b e as atualizações oficiais posteriores para BP-e TM e BP-e TA.
- Função: recepção de mensagem de evento de BP-e.
- Processo: síncrono.
- Método:
bpeRecepcaoEvento. - Parâmetro da mensagem da área de dados: XML sem compactação.
1. Leiaute da Mensagem de Entrada
Entrada: estrutura XML para o registro de evento.
Schema XML: eventoBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DP01 | eventoBPe | Raiz | - | - | - | - | TAG raiz. |
| DP02 | versao | A | FP01 | N | 1-1 | 2v2 | Versão do leiaute. |
| DP03 | infEvento | G | FP01 | - | 1-1 | - | Grupo de informações do registro de eventos. |
| DP04 | Id | ID | FP03 | C | 1-1 | 54 | Identificador da TAG a ser assinada: “ID” + tpEvento + chave do BP-e + nSeqEvento. |
| DP05 | cOrgao | E | FP03 | N | 1-1 | 2 | Código do órgão de recepção do evento. Utilizar a Tabela do IBGE estendida. |
| DP06 | tpAmb | E | FP03 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| DP07 | CNPJ | E | FP03 | C | 1-1 | 14 | CNPJ do autor do evento. |
| DP08 | chBPe | E | FP03 | N | 1-1 | 44 | Chave de Acesso do BP-e vinculado ao evento. |
| DP09 | dhEvento | E | FP03 | D | 1-1 | - | Data e hora do evento. Formato: AAAA-MM-DDTHH:MM:SS TZD. |
| DP10 | tpEvento | E | FP03 | N | 1-1 | 6 | Tipo do evento. |
| DP11 | nSeqEvento | E | FP03 | N | 1-1 | 1-2 | Sequencial do evento para o mesmo tipo. Para a maioria dos eventos será 1; quando houver mais de um, o autor deve numerar sequencialmente. |
| DP12 | detEvento | G | FP03 | - | 1-1 | - | Informações do evento específico. |
| DP13 | versaoEvento | A | FP12 | N | 1-1 | 2v2 | Versão do leiaute específico do evento. |
| DP14 | any | E | FP12 | XML | 1-1 | - | XML específico do tipo de evento. |
| DP15 | Signature | G | FP01 | XML | 1-1 | - | Assinatura XML do grupo identificado pelo atributo “Id”. |
2. Leiaute da Mensagem de Retorno
Retorno: estrutura XML com o resultado do pedido de evento.
Schema XML: retEventoBPe_v9.99.xsd.
| # | Campo | Ele. | Pai | Tipo | Ocor. | Tam. | Descrição/Observação |
|---|---|---|---|---|---|---|---|
| DR01 | retEventoBPe | Raiz | - | - | - | - | TAG raiz do resultado do envio do evento. |
| DR02 | versao | A | DR01 | N | 1-1 | 1-4 | Versão do leiaute. |
| DR03 | infEvento | G | DR01 | - | 1-1 | - | Grupo de informações do registro do evento. |
| DR04 | Id | ID | DR03 | C | 0-1 | 17 | Identificador informado quando o órgão de registro assinar a resposta; número do protocolo precedido de “ID”. |
| DR05 | tpAmb | E | DR03 | N | 1-1 | 1 | Identificação do ambiente: 1 - Produção; 2 - Homologação. |
| DR06 | verAplic | E | DR03 | C | 1-1 | 1-20 | Versão da aplicação que registrou o evento. |
| DR07 | cOrgao | E | DR03 | N | 1-1 | 2 | Código da UF que registrou o evento. |
| DR08 | cStat | E | DR03 | N | 1-1 | 3-4 | Código do status da resposta. |
| DR09 | xMotivo | E | DR03 | C | 1-1 | 1-255 | Descrição do status da resposta. |
| DR10 | chBPe | E | DR03 | N | 0-1 | 44 | Chave de Acesso do BP-e vinculado ao evento. |
| DR11 | tpEvento | E | DR03 | N | 0-1 | 6 | Código do tipo do evento. |
| DR12 | xEvento | E | DR03 | C | 0-1 | 5-60 | Descrição do evento. |
| DR13 | nSeqEvento | E | DR03 | N | 0-1 | 1-2 | Sequencial do evento para o mesmo tipo. |
| DR14 | dhRegEvento | E | DR03 | D | 0-1 | - | Data e hora do registro do evento. |
| DR15 | nProt | E | DR15 | N | 0-1 | 15 | Número do protocolo de registro do evento. |
| DR16 | Signature | G | DR01 | XML | 0-1 | - | Assinatura digital da resposta, aplicada no elemento infEvento, a critério do Ambiente Autorizador. |
Os campos posteriores a xMotivo são obrigatórios quando o evento for homologado com cStat 134, 135 ou 136. Os campos dhRegEvento e nProt não são preenchidos em caso de erro.
3. Descrição do Processo de Web Service
O serviço recebe solicitações de registro de eventos de BP-e. O interessado — emissor ou órgão público — envia a mensagem; o Ambiente Autorizador processa a solicitação e devolve o resultado ao transmissor.
4. Regras de Validação Básicas do Serviço
| Grupo | Descrição |
|---|---|
| A | Validação do Certificado de Transmissão no protocolo TLS. |
| B | Validação inicial da mensagem no Web Service. |
| C | Validação da área de dados da mensagem. |
| D | Validação do Certificado de Assinatura. |
| E | Validações da Assinatura Digital. |
5. Validação das Regras de Negócio do Serviço de Registro de Eventos
| # | Regra de Validação | Aplic. | cStat | Efeito | Mensagem |
|---|---|---|---|---|---|
| I01 | Tipo do ambiente difere do ambiente do Web Service. | Obrig. | 252 | Rej. | Rejeição: Ambiente informado diverge do Ambiente de recebimento. |
| I02 | Verificar se o código do órgão de recepção do evento diverge do solicitado. | Obrig. | 226 | Rej. | Rejeição: Código da UF do Emitente diverge da UF autorizadora. |
| I04 | Validar CNPJ do autor do evento quanto ao dígito verificador ou zeros. | Obrig. | 627 | Rej. | Rejeição: CNPJ do autor do evento inválido. |
| I05 | Validar se o atributo Id corresponde à concatenação “ID” + tpEvento + chBPe + nSeqEvento. | Obrig. | 628 | Rej. | Rejeição: Erro Atributo ID do evento não corresponde à concatenação dos campos. |
| I06 | Verificar se o tpEvento é válido. | Obrig. | 629 | Rej. | Rejeição: O tpEvento informado inválido. |
| I07 | Verificar o Schema da parte específica do evento. Observação: utilizar tpEvento e versaoEvento para identificar o Schema. | Obrig. | 630 | Rej. | Rejeição: Falha no Schema XML específico para o evento. |
| I08 | Validar a Chave de Acesso, considerando CNPJ, ano, mês, modelo 63, número, tipo de emissão, UF e DV. | Obrig. | 236 | Rej. | Rejeição: Chave de Acesso inválida. [Motivo: XXXXXXXXX] |
| I16 | Verificar duplicidade do evento pela composição cOrgao + tpEvento + chBPe + nSeqEvento. | Obrig. | 631 | Rej. | Rejeição: Duplicidade de evento. [nProt:999999999999999][dhRegEvento: AAAA-MM-DDTHH:MM:SS TZD] |
| I17 | Em evento do emissor, verificar se o CNPJ do autor difere do CNPJ da Chave de Acesso do BP-e. | Obrig. | 632 | Rej. | Rejeição: O autor do evento diverge do emissor do BP-e. |
| I18 | Em evento do Fisco, RFB ou outros órgãos, verificar se o CNPJ do autor consta na tabela de órgãos autorizados. | Obrig. | 633 | Rej. | Rejeição: O autor do evento não é um órgão autorizado a gerar o evento. |
| I19 | Se o evento exige BP-e, acessar a base pela chave CNPJ do emitente, modelo, série e número e verificar se o documento existe. | Obrig. | 217 | Rej. | Rejeição: BP-e não consta na base de dados da SEFAZ. |
| I20 | Se o BP-e existir, verificar se a Chave de Acesso difere da existente na base de dados. | Obrig. | 600 | Rej. | Rejeição: Chave de Acesso difere da existente em BD. |
| I20a | Se o BP-e for do tipo 4 - Transporte Metropolitano, não aceitar eventos de Não Embarque, Substituição, Excesso de Bagagem, Fornecimento não realizado e Ajuste de BP-e TA. | Obrig. | 703 | Rej. | Rejeição: Tipo de evento inválido para BP-e TM. |
| I20b | Se o modal do BP-e for 2 - Transporte Aéreo, não aceitar eventos de Excesso de Bagagem e Alteração de Poltrona. | Obrig. | 708 | Rej. | Rejeição: Tipo de evento inválido para BP-e TA. |
| I20c | Se o modal do BP-e for diferente de 2 - Transporte Aéreo, não aceitar eventos de Fornecimento não realizado e Ajuste de BP-e TA. | Obrig. | 709 | Rej. | Rejeição: Tipo de evento inválido para BP-e e BP-e TM. |
| I21 | A data do evento não pode ser menor que a data de emissão do BP-e, se existir. Tolerar diferença máxima de 5 minutos. | Obrig. | 634 | Rej. | Rejeição: A data do evento não pode ser menor que a data de emissão do BP-e. |
| I22 | A data do evento não pode ser menor que a data de autorização do BP-e, se existir. Tolerar diferença máxima de 5 minutos. | Obrig. | 637 | Rej. | Rejeição: A data do evento não pode ser menor que a data de autorização do BP-e. |
| I23 | A data do evento não pode ser maior que a data de processamento, considerando a hora local do emissor. Tolerar diferença máxima de 5 minutos. | Obrig. | 635 | Rej. | Rejeição: A data do evento não pode ser maior que a data do processamento. |
6. Processamento das Validações Específicas
As validações específicas são definidas na parte correspondente a cada evento. O evento de cancelamento é apresentado na página própria deste MOC Online.
7. Final do Processamento do Evento
| Resultado | Tratamento |
|---|---|
| Rejeição | O evento é descartado, com retorno do código do status do motivo da rejeição. |
| cStat 135 | Evento recebido e armazenado com vinculação ao respectivo BP-e. |
| cStat 136 | Evento recebido e armazenado, mas a vinculação ao BP-e fica prejudicada pela inexistência do documento no momento do recebimento. |
| cStat 134 | Evento recebido e vinculado a BP-e com situação diferente de autorizado, retornando alerta com a situação do documento. |
O Ambiente Autorizador deve compartilhar os eventos autorizados no Sistema de Registro de Eventos com os órgãos interessados.