Pular para o conteúdo principal

Inscrições Estaduais

O que é

Este conjunto de APIs permite que sellers configurem e mantenham atualizadas as Inscrições Estaduais (IE) da empresa no módulo de gestão fiscal da plataforma de Fulfillment.

Através dessas APIs, é possível cadastrar ou atualizar as IEs por unidade federativa (UF), informando:

  • O número da inscrição estadual
  • Se ela é utilizada para GNRE (recolhimento de ICMS interestadual via Guia Nacional de Recolhimento de Tributos Estaduais — comum em operações com substituição tributária, DIFAL ou FCP)
  • Comentários adicionais que podem aparecer em observações de NF-e

Essas informações são fundamentais para:

  • Emissão correta de documentos fiscais (NF-e de remessa, entrada/saída de estoque nos CDs)
  • Cálculo automático de tributos estaduais em vendas interestaduais
  • Conformidade fiscal em operações de fulfillment (armazenamento e expedição em centros de distribuição)

Funcionalidades disponíveis

  • Criação de inscrições estaduais (POST) — adiciona novas IEs ou inicia o cadastro
  • Atualização/substituição completa do conjunto de IEs (PUT) — substitui integralmente as inscrições existentes pelo payload enviado

Escopos necessários

ValorDescrição
open:fulfillment-company-state-inscription:writePermite criação e atualizações de inscrições estaduais.

Nota: Para consultar as IEs cadastradas, verifique se há endpoint GET disponível na referência completa da API.

Ambientes

Ambientes disponíveis: Ambientes

Fluxo recomendado

  1. Use POST para cadastrar as IEs iniciais durante o onboarding.
  2. Use PUT para qualquer atualização posterior (correções, adições, remoções ou sincronizações).
  3. Envie sempre o conjunto completo no PUT para evitar inconsistências.