Regras Tributárias

Visão Geral

O módulo Regras Tributárias gerencia as regras de tributação aplicadas nas operações fiscais da empresa. Permite configurar como os impostos (ICMS, IPI, PIS, COFINS, ISS, etc.) são calculados e aplicados para diferentes combinações de produto, operação e UF de destino.

Endpoints

GET /api/regras-tributarias

Descrição: Lista todas as regras tributárias cadastradas com suporte a paginação e filtros. Autenticação: Obrigatória

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
pagina	integer	Não	Número da página (padrão: 1)
quantidade	integer	Não	Itens por página (padrão: 20)
nome	string	Não	Filtrar por nome da regra
ativo	boolean	Não	Filtrar por status ativo/inativo

Resposta de Sucesso

{
  "dados": [
    {
      "id": "uuid",
      "nome": "Regra ICMS SP",
      "descricao": "ICMS para vendas internas em SP",
      "ativo": true
    }
  ],
  "total": 15,
  "pagina": 1,
  "quantidade": 20
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/regras-tributarias" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/regras-tributarias', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/regras-tributarias',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/regras-tributarias", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/regras-tributarias');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/regras-tributarias",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/regras-tributarias",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

POST /api/regras-tributarias

Descrição: Cria uma nova regra tributária no sistema. Autenticação: Obrigatória

Corpo da Requisição (Request Body)

{
  "nome": "Regra ICMS SP",
  "descricao": "ICMS para vendas internas em SP",
  "cstIcms": "00",
  "aliquotaIcms": 12.0,
  "cstPis": "01",
  "aliquotaPis": 0.65,
  "cstCofins": "01",
  "aliquotaCofins": 3.0,
  "cstIpi": "50",
  "aliquotaIpi": 0.0,
  "ativo": true
}

Resposta de Sucesso

{
  "id": "uuid",
  "nome": "Regra ICMS SP",
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/regras-tributarias" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"nome":"Regra ICMS SP","descricao":"ICMS para vendas internas em SP","cstIcms":"00","aliquotaIcms":12.0,"cstPis":"01","aliquotaPis":0.65,"cstCofins":"01","aliquotaCofins":3.0,"cstIpi":"50","aliquotaIpi":0.0,"ativo":true}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/regras-tributarias', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "nome": "Regra ICMS SP",
  "descricao": "ICMS para vendas internas em SP",
  "cstIcms": "00",
  "aliquotaIcms": 12.0,
  "cstPis": "01",
  "aliquotaPis": 0.65,
  "cstCofins": "01",
  "aliquotaCofins": 3.0,
  "cstIpi": "50",
  "aliquotaIpi": 0.0,
  "ativo": true
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/regras-tributarias',
    headers={'Authorization': 'Bearer {token}'},
    json={'nome': 'Regra ICMS SP', 'descricao': 'ICMS para vendas internas em SP', 'cstIcms': '00', 'aliquotaIcms': 12.0, 'cstPis': '01', 'aliquotaPis': 0.65, 'cstCofins': '01', 'aliquotaCofins': 3.0, 'cstIpi': '50', 'aliquotaIpi': 0.0, 'ativo': True}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"nome":"Regra ICMS SP","descricao":"ICMS para vendas internas em SP","cstIcms":"00","aliquotaIcms":12.0,"cstPis":"01","aliquotaPis":0.65,"cstCofins":"01","aliquotaCofins":3.0,"cstIpi":"50","aliquotaIpi":0.0,"ativo":true}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/regras-tributarias", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/regras-tributarias');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'nome' => 'Regra ICMS SP',
        'descricao' => 'ICMS para vendas internas em SP',
        'cstIcms' => '00',
        'aliquotaIcms' => 12.0,
        'cstPis' => '01',
        'aliquotaPis' => 0.65,
        'cstCofins' => '01',
        'aliquotaCofins' => 3.0,
        'cstIpi' => '50',
        'aliquotaIpi' => 0.0,
        'ativo' => true
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/regras-tributarias",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/regras-tributarias",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"nome\":\"Regra ICMS SP\",\"descricao\":\"ICMS para vendas internas em SP\",\"cstIcms\":\"00\",\"aliquotaIcms\":12.0,\"cstPis\":\"01\",\"aliquotaPis\":0.65,\"cstCofins\":\"01\",\"aliquotaCofins\":3.0,\"cstIpi\":\"50\",\"aliquotaIpi\":0.0,\"ativo\":true}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/regras-tributarias/{id}

Descrição: Retorna os detalhes de uma regra tributária pelo seu identificador único. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da regra tributária

Resposta de Sucesso

{
  "id": "uuid",
  "nome": "Regra ICMS SP",
  "descricao": "ICMS para vendas internas em SP",
  "cstIcms": "00",
  "aliquotaIcms": 12.0,
  "cstPis": "01",
  "aliquotaPis": 0.65,
  "cstCofins": "01",
  "aliquotaCofins": 3.0,
  "cstIpi": "50",
  "aliquotaIpi": 0.0,
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Regra tributária não encontrada

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/regras-tributarias/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/regras-tributarias/{id}', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/regras-tributarias/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/regras-tributarias/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/regras-tributarias/{id}');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — GET /api/regras-tributarias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/regras-tributarias/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

PUT /api/regras-tributarias/{id}

Descrição: Atualiza os dados de uma regra tributária existente. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da regra tributária

Corpo da Requisição (Request Body)

{
  "aliquotaIcms": 18.0,
  "ativo": true
}

Resposta de Sucesso

{
  "id": "uuid",
  "nome": "Regra ICMS SP",
  "aliquotaIcms": 18.0,
  "ativo": true
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado
404	Regra tributária não encontrada

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/regras-tributarias/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"aliquotaIcms":18.0,"ativo":true}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/regras-tributarias/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "aliquotaIcms": 18.0,
  "ativo": true
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/regras-tributarias/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'aliquotaIcms': 18.0, 'ativo': True}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"aliquotaIcms":18.0,"ativo":true}`)
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/regras-tributarias/{id}", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/regras-tributarias/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'aliquotaIcms' => 18.0,
        'ativo' => true
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/regras-tributarias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/regras-tributarias/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"aliquotaIcms\":18.0,\"ativo\":true}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

DELETE /api/regras-tributarias/{id}

Descrição: Remove uma regra tributária do sistema pelo seu identificador. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da regra tributária

Resposta de Sucesso

{
  "mensagem": "Regra tributária removida com sucesso"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Regra tributária não encontrada
409	Regra vinculada a outros registros

Exemplos de Código

cURL

curl -X DELETE "https://api.app.hooked.com.br/api/regras-tributarias/{id}" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/regras-tributarias/{id}', {
  method: 'DELETE',
  headers: { 'Authorization': 'Bearer {token}' }
});
const data = await response.json();

Python

import requests

data = requests.delete(
    'https://api.app.hooked.com.br/api/regras-tributarias/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/regras-tributarias/{id}", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/regras-tributarias/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'DELETE',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — DELETE /api/regras-tributarias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/regras-tributarias/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}