API Hooked

API Hooked

  • Documentação
  • Buscar
  • Changelog

›Financeiro

Comece por aqui

  • Primeiros Passos
  • Postman — importar e testar
  • Integração com IA
  • Paginação
  • Changelog

Autenticação

  • Acessos

Financeiro

  • Bancos
  • Contas
  • Contas a Pagar e Receber
  • Condições de Pagamento
  • Formas de Pagamento
  • Transferências
  • Comissões
  • Preços
  • Tabelas de Preços

Fiscal

  • Notas Fiscais
  • Tributações
  • Regras Tributárias
  • Naturezas de Operação
  • SPEDs Fiscais
  • IBPTs

Estoque

  • Estoques
  • Produtos e Serviços
  • Grades
  • Unidades
  • Marcas
  • Fichas Técnicas
  • Tabelas de Produtos

Vendas & Pedidos

  • Pedidos
  • Romaneios
  • Remessas
  • Manifestos

Produção

  • Ordens de Produção
  • Ordens de Produção — Itens
  • Apontamentos de Produção

Cadastros

  • Pessoas
  • Cidades
  • Países
  • Cargos
  • Grupos
  • Subgrupos
  • Categorias
  • Classificações
  • Classificações Comerciais
  • Centros de Custos
  • Centros de Custos Categorias
  • Setores

Documentos & Arquivos

  • Documentos
  • Arquivos
  • Imagens
  • Etiquetas
  • Modelos
  • Mensagens

Configurações

  • Configurações
  • Webhooks
  • Operações

Outros

  • Dashboard
  • Projetos
  • Veículos
  • Tipos de Contas
  • Sobre

Contas

Visão Geral

O módulo Contas gerencia o cadastro de contas bancárias da empresa, incluindo agência, número da conta, configurações de carteira de cobrança e parâmetros de remessa. É utilizado na geração de boletos e arquivos de remessa bancária.

Base URL

/api/contas

Endpoints

GET /api/contas

Descrição: Retorna uma lista paginada de contas bancárias cadastradas. Suporta filtro por descrição e ordenação.

Parâmetros

NomeTipoLocalObrigatórioDescrição
descricaostringquery—Filtra contas pela descrição
propertystringquery—Campo pelo qual ordenar
orderBystringquery—Direção: asc ou desc
pageNumberintegerquery—Número da página (padrão: 1)
pageSizeintegerquery—Registros por página (padrão: 20)

Resposta de Sucesso 200

{
  "pagination": {
    "currentPage": 1,
    "totalPages": 1,
    "pageSize": 20,
    "totalCount": 3,
    "hasPrevious": false,
    "hasNext": false
  },
  "data": [
    {
      "id": 1,
      "descricao": "Conta Principal BB",
      "bancoId": 1,
      "agencia": "1234",
      "agenciaDigito": "5",
      "numeroConta": "00012345",
      "numeroContaDigito": "6",
      "nossoNumeroAtual": 1000,
      "digitoVerificadorAgenciaConta": null,
      "convenio": "123456",
      "codigoCedente": null,
      "codigoTransmissao": null,
      "modalidade": null,
      "carteira": "17",
      "especie": "DM",
      "mensagem": "Pagável em qualquer banco",
      "instrucao1": "Após o vencimento cobrar multa de 2%",
      "instrucao2": null,
      "layout": 1,
      "tipoCarteira": 1,
      "tipoDocumento": null
    }
  ],
  "summary": null
}

Campos da Resposta — data[]

CampoTipoObrigatórioDescrição
idinteger (int64)—Identificador único da conta
descricaostring✓Descrição/nome da conta
bancoIdinteger (int64)✓ID do banco vinculado
agenciastring✓Número da agência
agenciaDigitostring✓Dígito da agência
numeroContastring✓Número da conta
numeroContaDigitostring✓Dígito da conta
nossoNumeroAtualinteger✓Próximo número para boletos
carteirastring—Código da carteira de cobrança
conveniostring—Número do convênio bancário
especiestring—Espécie do documento
mensagemstring—Mensagem impressa no boleto
instrucao1string—Instrução 1 para o banco
instrucao2string—Instrução 2 para o banco
layoutinteger—Layout do arquivo de remessa

Códigos de Erro

CódigoDescrição
401Token ausente ou inválido
500Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

Descrição: Cria uma nova conta bancária no sistema.

Corpo da Requisição

{
  "empresaId": 1,
  "descricao": "Conta Principal BB",
  "bancoId": 1,
  "agencia": "1234",
  "agenciaDigito": "5",
  "numeroConta": "00012345",
  "numeroContaDigito": "6",
  "nossoNumeroAtual": 1000,
  "carteira": "17",
  "convenio": "123456",
  "especie": "DM",
  "mensagem": "Pagável em qualquer banco",
  "instrucao1": "Após o vencimento cobrar multa de 2%"
}
CampoTipoObrigatórioRegrasDescrição
empresaIdinteger (int64)✓—ID da empresa
descricaostring✓mín. 1 caractereDescrição da conta
bancoIdinteger (int64)✓—ID do banco
agenciastring✓mín. 1 caractereNúmero da agência
agenciaDigitostring✓mín. 1 caractereDígito da agência
numeroContastring✓mín. 1 caractereNúmero da conta
numeroContaDigitostring✓mín. 1 caractereDígito da conta
nossoNumeroAtualinteger (int32)✓—Próximo número de boleto
digitoVerificadorAgenciaContastring——Dígito verificador agência/conta
conveniostring——Convênio bancário
codigoCedentestring——Código do cedente
codigoTransmissaostring——Código de transmissão
modalidadestring——Modalidade de cobrança
responEmissaointeger (int32)——Responsável pela emissão
tipoCarteirainteger (int32)——Tipo da carteira
tipoDocumentointeger (int32)——Tipo do documento
caracTitulointeger (int32)——Característica do título
layoutRemessainteger (int32)——Layout da remessa
numeroArquivointeger (int32)——Número do arquivo
carteirastring——Carteira
especiestring——Espécie do título
especieModstring——Espécie modificada
mensagemstring——Mensagem do boleto
instrucao1string——Instrução 1 do boleto
instrucao2string——Instrução 2 do boleto
aceiteinteger (int32)——Indicação de aceite
tipoOcorrenciainteger (int32)——Tipo de ocorrência
tipoImpressaointeger (int32)——Tipo de impressão
codigoMorastring——Código de mora
tipoDescontointeger (int32)——Tipo de desconto
tipoDesconto2integer (int32)——Tipo de desconto 2
valorIOFnumber (double)——Valor de IOF
valorOutrasDespesasnumber (double)——Valor de outras despesas
multaAposDiasVencimentointeger (int32)——Dias após vencimento para multa
multaValorFixointeger (int32)——Valor fixo da multa
percentualMultanumber (double)——Percentual da multa
gerarProtestoboolean——Gerar protesto
tipoDiasProtestointeger (int32)——Tipo de dias para protesto
protestoAposDiasVencimentointeger (int32)——Dias após vencimento para protesto
valorMoraJurosnumber (double)——Valor de mora/juros
moraJurosAposDiasVencimentointeger (int32)——Dias após vencimento para mora/juros
codigoMoraJurosinteger (int32)——Código de mora/juros
valorDescontonumber (double)——Valor de desconto
descontoAposDiasVencimentointeger (int32)——Dias após vencimento para desconto
valorAbatimentonumber (double)——Valor de abatimento
abatimentoAposDiasVencimentointeger (int32)——Dias após vencimento para abatimento
operacaoContastring——Operação da conta
digitoCedentestring——Dígito do cedente
variacaoCarteiraPadraostring——Variação padrão da carteira
utilizaIntermediadorboolean——Utiliza intermediador
sacadoNomestring——Nome do sacado
sacadoCnpjCpfDistring——CNPJ/CPF/DI do sacado
sacadoEnderecostring——Endereço do sacado
sacadoBairrostring——Bairro do sacado
sacadoNumerostring——Número do sacado
sacadoCepstring——CEP do sacado
sacadoCidadeIdinteger (int64)——ID da cidade do sacado
sacadoComplementostring——Complemento do sacado
sacadoTelefonestring——Telefone do sacado

Resposta de Sucesso 200

Retorna o objeto criado com a mesma estrutura do GET /api/contas.

Códigos de Erro

CódigoDescrição
400Dados inválidos — campos obrigatórios ausentes
401Token ausente ou inválido
500Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/contas" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"descricao":"Conta Principal BB","bancoId":1,"agencia":"1234","agenciaDigito":"5","numeroConta":"00012345","numeroContaDigito":"6","nossoNumeroAtual":1000,"carteira":"17","convenio":"123456","especie":"DM","mensagem":"Pagável em qualquer banco","instrucao1":"Após o vencimento cobrar multa de 2%"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "descricao": "Conta Principal BB",
  "bancoId": 1,
  "agencia": "1234",
  "agenciaDigito": "5",
  "numeroConta": "00012345",
  "numeroContaDigito": "6",
  "nossoNumeroAtual": 1000,
  "carteira": "17",
  "convenio": "123456",
  "especie": "DM",
  "mensagem": "Pagável em qualquer banco",
  "instrucao1": "Após o vencimento cobrar multa de 2%"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas',
    headers={'Authorization': 'Bearer {token}'},
    json={'descricao': 'Conta Principal BB', 'bancoId': 1, 'agencia': '1234', 'agenciaDigito': '5', 'numeroConta': '00012345', 'numeroContaDigito': '6', 'nossoNumeroAtual': 1000, 'carteira': '17', 'convenio': '123456', 'especie': 'DM', 'mensagem': 'Pagável em qualquer banco', 'instrucao1': 'Após o vencimento cobrar multa de 2%'}
).json()

Go

import (
    "bytes"
    "net/http"
)

payload := []byte(`{"descricao":"Conta Principal BB","bancoId":1,"agencia":"1234","agenciaDigito":"5","numeroConta":"00012345","numeroContaDigito":"6","nossoNumeroAtual":1000,"carteira":"17","convenio":"123456","especie":"DM","mensagem":"Pagável em qualquer banco","instrucao1":"Após o vencimento cobrar multa de 2%"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas", 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/contas');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'descricao' => 'Conta Principal BB',
        'bancoId' => 1,
        'agencia' => '1234',
        'agenciaDigito' => '5',
        'numeroConta' => '00012345',
        'numeroContaDigito' => '6',
        'nossoNumeroAtual' => 1000,
        'carteira' => '17',
        'convenio' => '123456',
        'especie' => 'DM',
        'mensagem' => 'Pagável em qualquer banco',
        'instrucao1' => 'Após o vencimento cobrar multa de 2%'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"descricao\":\"Conta Principal BB\",\"bancoId\":1,\"agencia\":\"1234\",\"agenciaDigito\":\"5\",\"numeroConta\":\"00012345\",\"numeroContaDigito\":\"6\",\"nossoNumeroAtual\":1000,\"carteira\":\"17\",\"convenio\":\"123456\",\"especie\":\"DM\",\"mensagem\":\"Pagável em qualquer banco\",\"instrucao1\":\"Após o vencimento cobrar multa de 2%\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/contas/{id}

Descrição: Retorna os dados de uma conta bancária específica pelo ID.

Parâmetros

NomeTipoLocalObrigatórioDescrição
idinteger (int64)path✓ID da conta

Resposta de Sucesso 200

Retorna o objeto com a mesma estrutura do GET /api/contas.

Códigos de Erro

CódigoDescrição
401Token ausente ou inválido
404Conta não encontrada
500Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

Descrição: Atualiza os dados de uma conta bancária existente.

Parâmetros

NomeTipoLocalObrigatórioDescrição
idinteger (int64)path✓ID da conta a ser atualizada

Corpo da Requisição

Mesma estrutura do POST /api/contas, incluindo o campo id.

Resposta de Sucesso 200

Retorna o objeto atualizado com a mesma estrutura do GET /api/contas.

Códigos de Erro

CódigoDescrição
400Dados inválidos
401Token ausente ou inválido
404Conta não encontrada
500Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

DELETE /api/contas/{id}

Descrição: Remove uma conta bancária do sistema pelo ID.

Parâmetros

NomeTipoLocalObrigatórioDescrição
idinteger (int64)path✓ID da conta a ser removida

Resposta de Sucesso 200

Retorna o objeto removido com a mesma estrutura do GET /api/contas/{id}.

Códigos de Erro

CódigoDescrição
401Token ausente ou inválido
404Conta não encontrada
500Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Go

import (
    "io"
    "net/http"
)

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

Descrição: Retorna a quantidade total de contas bancárias cadastradas no sistema para a empresa autenticada.

Parâmetros

Nenhum parâmetro obrigatório.

Resposta de Sucesso 200

{
  "quantidade": 5
}

Códigos de Erro

CódigoDescrição
401Token ausente ou inválido
500Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("GET", "https://api.app.hooked.com.br/api/contas/recuperar-quantidade", 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/contas/recuperar-quantidade');
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/contas/recuperar-quantidade",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas/recuperar-quantidade",
        "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": {}
}
← BancosContas a Pagar e Receber →
  • Visão Geral
  • Base URL
  • Endpoints
Hooked Sistemas Ltda

O ERP que se ajusta ao seu negócio.

CNPJ: 41.696.403/0001-02

Produto
ProdutoCadastre-seLogin
A Hooked
Quem somosFale conoscoCadastre-se
Empresas
Planos e preçosControle de Ponto
Contato
+55 49 9114-1678[email protected]Instagram
© Copyright 2026 Hooked Sistemas - Todos os Direitos Reservados.