dwh_failed_invoice (v1.0.0)

Produzido quando a geração de nota fiscal falha. Este evento é exportado para o data warehouse para fins de análises e monitoramento.

Event

Info

PubSub topic: ordr-data-warehouse

Detalhes

Este evento é publicado quando uma solicitação de geração de nota fiscal falha. Contém informações sobre a tentativa de nota fiscal falhada incluindo detalhes do pedido, informações de erro e a solicitação que foi enviada para a Avalara.

Quando este evento é produzido?

Este evento é produzido quando:

  • A geração de nota fiscal falha devido a erros de validação (ex: CEP inválido)
  • A geração de nota fiscal falha devido a erros da API Avalara
  • A geração de nota fiscal falha devido a dados fiscais faltando
  • Qualquer outro erro ocorre durante o processo de geração de nota fiscal

Estrutura do Payload do Evento

O payload do evento contém:

  • Nome do Evento: Identificador do tipo de evento (dwh_failed_invoice)
  • Informações do Pedido: ID do pedido e ID do Hub
  • Informações da Nota Fiscal: Chave de acesso da nota fiscal e número da nota fiscal (se disponível)
  • Dados da Solicitação: O JSON completo da solicitação que foi enviada para a Avalara
  • Informações de Erro: Código de erro e mensagem de erro descrevendo a falha

Campos Principais

  • event_name: Identificador do tipo de evento (dwh_failed_invoice)
  • order_id: Identificador único do pedido
  • hub_id: Identificador do hub onde o pedido foi atendido
  • invoice_access_key: Chave de acesso da nota fiscal (se a nota fiscal foi parcialmente criada)
  • invoice_number: Número da nota fiscal (se a nota fiscal foi parcialmente criada)
  • request_json: JSON completo da solicitação que foi enviada para a Avalara
  • error_code: Código de erro da Avalara ou código de erro interno
  • error_message: Mensagem de erro legível descrevendo a falha

Tipos de Erro

Cenários de erro comuns:

  1. Erros de Validação: Endereço do cliente inválido, dados fiscais faltando, formato de CEP inválido
  2. Erros da API Avalara: Serviço indisponível, falhas de autenticação, limitação de taxa
  3. Erros de Dados: Dados fiscais do hub faltando, dados fiscais do produto faltando, códigos fiscais inválidos
  4. Erros de Sistema: Falhas de banco de dados, problemas de rede, erros de timeout

Fluxo de Processamento

  1. Solicitação de geração de nota fiscal é recebida
  2. Serviço tenta gerar nota fiscal via API Avalara
  3. Se a geração falhar, erro é capturado
  4. Evento de nota fiscal falhada é publicado no canal ordr-data-warehouse
  5. Data warehouse processa o evento para análises e monitoramento

Casos de Uso

  • Análises: Acompanhar taxas de falha de geração de notas fiscais
  • Monitoramento: Alertar sobre altas taxas de falha
  • Depuração: Investigar casos específicos de falha
  • Relatórios: Gerar relatórios sobre problemas de geração de notas fiscais

Eventos Relacionados

  • invoice_generation: O evento original que acionou a tentativa de geração de nota fiscal

Payload

8 properties
event_name string
required

Event type identifier

Allowed values: dwh_failed_invoice
order_id string <uuid>
required

Unique identifier for the order

hub_id string
required

Hub identifier where the order was fulfilled

invoice_access_key string

Invoice access key (if invoice was partially created)

Match pattern: ^[0-9]{44}$
invoice_number string

Invoice number (if invoice was partially created)

Match pattern: ^[0-9]{9}$
request_json string
required

Complete JSON request that was sent to Avalara

error_code string
required

Error code from Avalara or internal error code

error_message string
required

Human-readable error message describing the failure

Edit this page