API atual/Referência completa/Impostos (ICMS, ISS, IPI)

Alíquotas de IPI

Lista, grava e remove a alíquota de IPI por código NCM.

O NCM é o código de 8 dígitos que classifica o produto na tabela do Mercosul. A alíquota de IPI depende dele. Você pode cadastrar a alíquota para o NCM completo ou para um prefixo (2, 4 ou 6 dígitos): a consulta tenta do mais específico ao mais geral.

Listar alíquotas

GET/api/v1/admin/tax/ipiAdmin

Lista alíquotas de IPI

Parâmetros de consulta

ncmstring

Com ncm, devolve uma alíquota: a do NCM exato ou a do prefixo mais longo cadastrado. Pontos são removidos. Sem alíquota, lista vazia.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/tax/ipi?ncm=6109.10.00" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Alíquotas

json

{
  "rates": [
    {
      "id": 3,
      "ncm_code": "61091000",
      "description": "Camisetas de algodão",
      "rate_bps": 0,
      "is_active": true,
      "created_at": "2026-10-11T12:00:00Z",
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

totalinteger

Quantidade.

ratesarray

Alíquotas.

idinteger

Id.

ncm_codestring

NCM (2, 4, 6 ou 8 dígitos).

descriptionstring

Descrição.

rate_bpsinteger

Alíquota em pontos-base.

is_activeboolean

Ativa.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Gravar uma alíquota

Cria ou, se o ncm_code já existir, atualiza. Sempre responde 201.

POST/api/v1/admin/tax/ipiAdmin

Grava uma alíquota de IPI

Corpo da requisição

ncm_codestringobrigatório

NCM ou prefixo.

descriptionstring

Descrição.

rate_bpsintegerobrigatório

Alíquota de 0 a 10000.

is_activebooleanpadrão: true

Padrão true.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/tax/ipi" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ncm_code": "61091000",
    "description": "Camisetas de algodão",
    "rate_bps": 0
  }'

Resposta

201Alíquota gravada

json

{
  "id": 3,
  "ncm_code": "61091000",
  "description": "Camisetas de algodão",
  "rate_bps": 0,
  "is_active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

idinteger

Id.

ncm_codestring

NCM (2, 4, 6 ou 8 dígitos).

descriptionstring

Descrição.

rate_bpsinteger

Alíquota em pontos-base.

is_activeboolean

Ativa.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros

Status	Quando	Corpo de exemplo
400	`ncm_code` ausente ou `rate_bps` fora de 0 a 10000.	`{"error":"ncm_code is required"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Remover uma alíquota

DELETE/api/v1/admin/tax/ipi/{id}Admin

Remove uma alíquota de IPI

Parâmetros de caminho

idintegerobrigatório

Id numérico da alíquota.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/admin/tax/ipi/3" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Removida

json

{
  "status": "deleted"
}

Erros

Status	Quando	Corpo de exemplo
400	`id` não numérico.	`{"error":"invalid id"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Veja também

Impostos

API atual/Referência completa/Impostos (ICMS, ISS, IPI)

Alíquotas de IPI

Lista, grava e remove a alíquota de IPI por código NCM.

Listar alíquotas

GET/api/v1/admin/tax/ipiAdmin

Lista alíquotas de IPI

Parâmetros de consulta

ncmstring

Com ncm, devolve uma alíquota: a do NCM exato ou a do prefixo mais longo cadastrado. Pontos são removidos. Sem alíquota, lista vazia.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/tax/ipi?ncm=6109.10.00" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Alíquotas

json

{
  "rates": [
    {
      "id": 3,
      "ncm_code": "61091000",
      "description": "Camisetas de algodão",
      "rate_bps": 0,
      "is_active": true,
      "created_at": "2026-10-11T12:00:00Z",
      "updated_at": "2026-10-11T12:00:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

totalinteger

Quantidade.

ratesarray

Alíquotas.

idinteger

Id.

ncm_codestring

NCM (2, 4, 6 ou 8 dígitos).

descriptionstring

Descrição.

rate_bpsinteger

Alíquota em pontos-base.

is_activeboolean

Ativa.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros

Status	Quando	Corpo de exemplo
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Gravar uma alíquota

Cria ou, se o ncm_code já existir, atualiza. Sempre responde 201.

POST/api/v1/admin/tax/ipiAdmin

Grava uma alíquota de IPI

Corpo da requisição

ncm_codestringobrigatório

NCM ou prefixo.

descriptionstring

Descrição.

rate_bpsintegerobrigatório

Alíquota de 0 a 10000.

is_activebooleanpadrão: true

Padrão true.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/admin/tax/ipi" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ncm_code": "61091000",
    "description": "Camisetas de algodão",
    "rate_bps": 0
  }'

Resposta

201Alíquota gravada

json

{
  "id": 3,
  "ncm_code": "61091000",
  "description": "Camisetas de algodão",
  "rate_bps": 0,
  "is_active": true,
  "created_at": "2026-10-11T12:00:00Z",
  "updated_at": "2026-10-11T12:00:00Z"
}

Campos da resposta

idinteger

Id.

ncm_codestring

NCM (2, 4, 6 ou 8 dígitos).

descriptionstring

Descrição.

rate_bpsinteger

Alíquota em pontos-base.

is_activeboolean

Ativa.

created_atstring

Criação.

updated_atstring

Última alteração.

Erros

Status	Quando	Corpo de exemplo
400	`ncm_code` ausente ou `rate_bps` fora de 0 a 10000.	`{"error":"ncm_code is required"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Remover uma alíquota

DELETE/api/v1/admin/tax/ipi/{id}Admin

Remove uma alíquota de IPI

Parâmetros de caminho

idintegerobrigatório

Id numérico da alíquota.

Exemplo de requisição

bash

curl -X DELETE "$BASE_URL/api/v1/admin/tax/ipi/3" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Removida

json

{
  "status": "deleted"
}

Erros

Status	Quando	Corpo de exemplo
400	`id` não numérico.	`{"error":"invalid id"}`
401	Sem token ou token inválido.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_taxes` nem `manage_settings`.	`{"error":"insufficient privileges","privilege_required_any":["manage_taxes","manage_settings"]}`
403	O módulo `icms-tax` está desligado na loja.	`{"error":"module_disabled","module":"icms-tax"}`

Veja também

Impostos