Transferências

Visão Geral

O módulo Transferências gerencia as transferências financeiras entre contas cadastradas no sistema (conta corrente, caixa, poupança, etc.). Permite registrar, consultar e gerar relatórios de movimentações entre contas da empresa.

Endpoints

GET /api/transferencias

Descrição: Lista todas as transferências realizadas 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)
contaOrigemId	string	Não	Filtrar por conta de origem
contaDestinoId	string	Não	Filtrar por conta de destino
dataInicio	string (date)	Não	Data inicial do período
dataFim	string (date)	Não	Data final do período

Resposta de Sucesso

{
  "dados": [
    {
      "id": "uuid",
      "contaOrigemId": "uuid",
      "contaOrigemNome": "Caixa",
      "contaDestinoId": "uuid",
      "contaDestinoNome": "Banco do Brasil CC",
      "valor": 5000.00,
      "data": "2024-01-15",
      "descricao": "Depósito de caixa"
    }
  ],
  "total": 25,
  "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/transferencias" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/transferencias", 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/transferencias');
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/transferencias",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/transferencias",
        "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/transferencias

Descrição: Registra uma nova transferência entre duas contas do sistema. Autenticação: Obrigatória

Corpo da Requisição (Request Body)

{
  "contaOrigemId": "uuid",
  "contaDestinoId": "uuid",
  "valor": 5000.00,
  "data": "2024-01-15",
  "descricao": "Depósito de caixa na conta corrente",
  "observacoes": "Referente ao fechamento do dia 14/01"
}

Resposta de Sucesso

{
  "id": "uuid",
  "contaOrigemId": "uuid",
  "contaDestinoId": "uuid",
  "valor": 5000.00,
  "data": "2024-01-15"
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos ou contas iguais
401	Não autorizado
404	Conta de origem ou destino não encontrada
422	Saldo insuficiente na conta de origem

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/transferencias" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"contaOrigemId":"uuid","contaDestinoId":"uuid","valor":5000.0,"data":"2024-01-15","descricao":"Depósito de caixa na conta corrente","observacoes":"Referente ao fechamento do dia 14/01"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/transferencias', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "contaOrigemId": "uuid",
  "contaDestinoId": "uuid",
  "valor": 5000.0,
  "data": "2024-01-15",
  "descricao": "Depósito de caixa na conta corrente",
  "observacoes": "Referente ao fechamento do dia 14/01"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/transferencias',
    headers={'Authorization': 'Bearer {token}'},
    json={'contaOrigemId': 'uuid', 'contaDestinoId': 'uuid', 'valor': 5000.0, 'data': '2024-01-15', 'descricao': 'Depósito de caixa na conta corrente', 'observacoes': 'Referente ao fechamento do dia 14/01'}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"contaOrigemId":"uuid","contaDestinoId":"uuid","valor":5000.0,"data":"2024-01-15","descricao":"Depósito de caixa na conta corrente","observacoes":"Referente ao fechamento do dia 14/01"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/transferencias", 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/transferencias');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'contaOrigemId' => 'uuid',
        'contaDestinoId' => 'uuid',
        'valor' => 5000.0,
        'data' => '2024-01-15',
        'descricao' => 'Depósito de caixa na conta corrente',
        'observacoes' => 'Referente ao fechamento do dia 14/01'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/transferencias",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/transferencias",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"contaOrigemId\":\"uuid\",\"contaDestinoId\":\"uuid\",\"valor\":5000.0,\"data\":\"2024-01-15\",\"descricao\":\"Depósito de caixa na conta corrente\",\"observacoes\":\"Referente ao fechamento do dia 14/01\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/transferencias/{id}

Descrição: Retorna os detalhes de uma transferência 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 transferência

Resposta de Sucesso

{
  "id": "uuid",
  "contaOrigemId": "uuid",
  "contaOrigemNome": "Caixa",
  "contaDestinoId": "uuid",
  "contaDestinoNome": "Banco do Brasil CC",
  "valor": 5000.00,
  "data": "2024-01-15",
  "descricao": "Depósito de caixa na conta corrente",
  "observacoes": "Referente ao fechamento do dia 14/01"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Transferência não encontrada

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/transferencias/{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/transferencias/{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/transferencias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/transferencias/{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/transferencias/{id}

Descrição: Atualiza os dados de uma transferência existente. Autenticação: Obrigatória

Parâmetros de Path

Parâmetro	Tipo	Obrigatório	Descrição
id	string (uuid)	Sim	Identificador único da transferência

Corpo da Requisição (Request Body)

{
  "descricao": "Depósito de caixa - corrigido",
  "observacoes": "Ajuste de valor"
}

Resposta de Sucesso

{
  "id": "uuid",
  "descricao": "Depósito de caixa - corrigido",
  "valor": 5000.00
}

Códigos de Erro Comuns

Código	Descrição
400	Dados inválidos
401	Não autorizado
404	Transferência não encontrada

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/transferencias/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"descricao":"Depósito de caixa - corrigido","observacoes":"Ajuste de valor"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/transferencias/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "descricao": "Depósito de caixa - corrigido",
  "observacoes": "Ajuste de valor"
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/transferencias/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'descricao': 'Depósito de caixa - corrigido', 'observacoes': 'Ajuste de valor'}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"descricao":"Depósito de caixa - corrigido","observacoes":"Ajuste de valor"}`)
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/transferencias/{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/transferencias/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'descricao' => 'Depósito de caixa - corrigido',
        'observacoes' => 'Ajuste de valor'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/transferencias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/transferencias/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"descricao\":\"Depósito de caixa - corrigido\",\"observacoes\":\"Ajuste de valor\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

DELETE /api/transferencias/{id}

Descrição: Remove uma transferência 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 transferência

Resposta de Sucesso

{
  "mensagem": "Transferência removida com sucesso"
}

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
404	Transferência não encontrada

Exemplos de Código

cURL

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

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/transferencias/{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/transferencias/{id}',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("DELETE", "https://api.app.hooked.com.br/api/transferencias/{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/transferencias/{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/transferencias/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "DELETE",
        "url": "https://api.app.hooked.com.br/api/transferencias/{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": {}
}

---

GET /api/transferencias/gerar-relatorio

Descrição: Gera um relatório de transferências em formato para download. Autenticação: Obrigatória

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
dataInicio	string (date)	Não	Data inicial do período
dataFim	string (date)	Não	Data final do período
contaOrigemId	string	Não	Filtrar por conta de origem
formato	string	Não	Formato: pdf ou xlsx

Resposta de Sucesso

Retorna o arquivo de relatório para download com o Content-Type adequado.

Códigos de Erro Comuns

Código	Descrição
401	Não autorizado
500	Erro ao gerar o relatório

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/transferencias/gerar-relatorio" \
  -H "Authorization: Bearer {token}" \
  -o arquivo

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/transferencias/gerar-relatorio', {
  headers: { 'Authorization': 'Bearer {token}' }
});
const blob = await response.blob();
// Node.js: use response.buffer() e salve com fs.writeFile

Python

import requests

response = requests.get(
    'https://api.app.hooked.com.br/api/transferencias/gerar-relatorio',
    headers={'Authorization': 'Bearer {token}'},
)
with open('arquivo', 'wb') as f:
    f.write(response.content)

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/transferencias/gerar-relatorio", nil)
req.Header.Set("Authorization", "Bearer {token}")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
arquivo, _ := os.Create("arquivo")
defer arquivo.Close()
io.Copy(arquivo, resp.Body)

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/transferencias/gerar-relatorio');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}'],
    CURLOPT_RETURNTRANSFER => true,
]);
$arquivo = curl_exec($ch);
curl_close($ch);
file_put_contents('arquivo', $arquivo);

n8n

{
  "name": "Hooked API — GET /api/transferencias/gerar-relatorio",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/transferencias/gerar-relatorio",
        "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": {}
}