VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

Regras de imposto

Regras que definem quais impostos incidem sobre a venda, por regime tributário, tipo de produto, categoria e NCM.

A venda de produtos no Brasil carrega impostos que variam por quem vende e o que vende. Esta área cuida das regras de imposto da loja: o conjunto de regras que o cálculo de impostos consulta no checkout e na emissão de nota fiscal.

São as rotas do administrador da loja. Cada seller pode ter regras próprias, mas elas ficam em rotas do painel do seller e não aparecem aqui.

Pontos principais
  • Exige o módulo icms-tax ativo e manage_taxes ou manage_settings.
  • O id da regra é um número inteiro.
  • Alíquotas em pontos-base (165 = 1,65%).
  • O PUT substitui a regra inteira, não é parcial.
  • Na criação, apply_* omitido vale false.

Como funciona

Para cada item, a plataforma procura, entre as regras ativas da loja, as que casam com o regime do vendedor, a categoria e o NCM do item (campos vazios casam com qualquer valor). Entre as que casam, vence a de maior priority; no empate, a que não é is_default. A regra decide se incidem ICMS, ISS, IPI, PIS e COFINS e com que alíquota.

SiglaImposto
ICMSImposto estadual sobre circulação de mercadorias.
ISSImposto municipal sobre serviços.
IPIImposto federal sobre produtos industrializados.
PIS e COFINSContribuições federais sobre o faturamento.
ICMS-STSubstituição tributária: o imposto é recolhido antecipadamente.
DIFALDiferencial de alíquota em vendas entre estados.

Conceitos-chave

Regime tributário

simples_nacional, lucro_presumido, lucro_real ou mei. Cada um tributa de um jeito; no Simples Nacional, por exemplo, os impostos já vêm embutidos na guia única do vendedor.

NCM

É a classificação fiscal do produto. Uma regra com ncm_pattern 8517 cobre todo NCM que comece por 8517.

Endpoints

MétodoCaminhoPara que servePágina
GET/api/v1/admin/tax-rulesListar regrasRegras
POST/api/v1/admin/tax-rulesCriar regraRegras
PUT/api/v1/admin/tax-rules/{id}Substituir regraRegras
DELETE/api/v1/admin/tax-rules/{id}Excluir regraRegras

Erros comuns

  • Tratar o PUT como edição parcial. Campos omitidos são zerados.
  • Omitir os apply_* na criação. A regra nasce sem aplicar nenhum imposto.
  • Esperar 404 em regra inexistente. Responde 500 com a explicação em detail.
  • Mexer em regra de seller. Só as regras da loja são editáveis por aqui.

Próximos passos

Regras de imposto
Crie, substitua e exclua regras.
Anterior
Calculadoras de imposto
Próxima
Regras de imposto
Nesta página
  • Como funciona
  • Conceitos-chave
  • Regime tributário
  • NCM
  • Endpoints
  • Erros comuns
  • Próximos passos