item_tax.updated (v1.0.0)

Produzido quando o status de prontidão fiscal de um produto muda. Este evento é publicado sempre que dados fiscais de itens são atualizados e o status de prontidão fiscal (pronto/não pronto) muda.

Event

Info

PubSub topic: bravalara-item-tax-out

Detalhes

Este evento é publicado quando os dados fiscais de um produto são atualizados e seu status de prontidão fiscal muda. A prontidão fiscal indica se um produto possui todas as informações fiscais necessárias para gerar notas fiscais.

Quando este evento é produzido?

Este evento é produzido quando:

  • Dados fiscais do produto são importados ou atualizados via mutation GraphQL importProductData
  • O status de prontidão fiscal muda de pronto para não pronto, ou vice-versa
  • A prontidão fiscal é determinada pela presença de: Código HS, Origem, Conta de Ativo, Conta de Despesa e Conta de Receita

Estrutura do Payload do Evento

O payload do evento contém:

  • Nome do Evento: Identificador do tipo de evento (item_tax)
  • Informações do Produto: ID do item, SKU (itemCode), ID externo
  • Dados Fiscais: Todos os campos relacionados a impostos incluindo Código HS, tipo de receita PIS/COFINS, CEST, código EX, Origem
  • Informações de Conta: IDs das contas de Ativo, Despesa e Receita
  • Status de Prontidão Fiscal: Flag booleana indicando se o produto está pronto para geração de nota fiscal
  • Timestamp de Atualização: Quando os dados fiscais foram atualizados pela última vez

Campos Principais

  • eventName: Identificador do tipo de evento (item_tax)
  • id: ID interno do item do Netsuite
  • itemCode: SKU do produto
  • externalId: ID externo do produto (ID BTLR)
  • isReady: Booleano indicando se o produto possui todos os dados fiscais necessários
  • hsCode: Código HS (NCM) para classificação fiscal
  • piscofinsRevenueType: Código do tipo de receita PIS/COFINS
  • source: Código de origem fiscal
  • cest: Código CEST (se aplicável)
  • ex: Código EX (se aplicável)
  • assetAccount: ID da conta de ativo
  • expenseAccount: ID da conta de despesa
  • incomeAccount: ID da conta de receita
  • updatedAt: Timestamp da atualização

Critérios de Prontidão Fiscal

Um produto é considerado fiscalmente pronto quando todos os seguintes estão presentes:

  • Código HS (NCM)
  • Origem (Tax Origin)
  • Conta de Ativo
  • Conta de Despesa
  • Conta de Receita

Fluxo de Processamento

  1. Dados fiscais do produto são importados/atualizados via API GraphQL
  2. Serviço verifica se o status de prontidão fiscal mudou
  3. Se o status mudou, evento é publicado no canal bravalara-item-tax-out
  4. Serviços downstream podem consumir este evento para atualizar seu status de prontidão fiscal

Casos de Uso

  • Serviço de Catálogo: Atualizar status de prontidão fiscal do produto
  • Serviço de Pedidos: Validar produtos antes de permitir geração de nota fiscal
  • Análises: Acompanhar métricas de prontidão fiscal entre produtos

Payload

14 properties
eventName string
required

Event type identifier

Allowed values: item_tax
id integer
required

Internal item ID from Netsuite

Minimum: 1
itemCode stringnull

Product SKU

piscofinsRevenueType stringnull

PIS/COFINS revenue type code

Match pattern: ^[0-9]{2}$
hsCode stringnull

HS Code (NCM) for tax classification

cest stringnull

CEST code (if applicable)

externalId stringnull

External product ID (BTLR ID)

source stringnull

Tax origin code

assetAccount integernull

Asset account ID

Minimum: 1
expenseAccount integernull

Expense account ID

Minimum: 1
incomeAccount integernull

Income account ID

Minimum: 1
ex stringnull

EX code (if applicable)

updatedAt string <date-time>
required

Timestamp when the tax data was last updated

isReady boolean
required

Indicates if the product has all required tax data for invoice generation

Edit this page