Contas · API Hooked

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

Todos os endpoints requerem autenticação via Bearer Token:
Authorization: Bearer {token}

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

Nome	Tipo	Local	Obrigatório	Descrição
`descricao`	string	query	—	Filtra contas pela descrição
`property`	string	query	—	Campo pelo qual ordenar
`orderBy`	string	query	—	Direção: `asc` ou `desc`
`pageNumber`	integer	query	—	Número da página (padrão: `1`)
`pageSize`	integer	query	—	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[]`

Campo	Tipo	Obrigatório	Descrição
`id`	integer (int64)	—	Identificador único da conta
`descricao`	string	✓	Descrição/nome da conta
`bancoId`	integer (int64)	✓	ID do banco vinculado
`agencia`	string	✓	Número da agência
`agenciaDigito`	string	✓	Dígito da agência
`numeroConta`	string	✓	Número da conta
`numeroContaDigito`	string	✓	Dígito da conta
`nossoNumeroAtual`	integer	✓	Próximo número para boletos
`carteira`	string	—	Código da carteira de cobrança
`convenio`	string	—	Número do convênio bancário
`especie`	string	—	Espécie do documento
`mensagem`	string	—	Mensagem impressa no boleto
`instrucao1`	string	—	Instrução 1 para o banco
`instrucao2`	string	—	Instrução 2 para o banco
`layout`	integer	—	Layout do arquivo de remessa

Códigos de Erro

Código	Descrição
`401`	Token ausente ou inválido
`500`	Erro 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()

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

{
  "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%"
}

Campo	Tipo	Obrigatório	Descrição
`descricao`	string	✓	Descrição da conta
`bancoId`	integer (int64)	✓	ID do banco
`agencia`	string	✓	Número da agência
`agenciaDigito`	string	✓	Dígito da agência
`numeroConta`	string	✓	Número da conta
`numeroContaDigito`	string	✓	Dígito da conta
`nossoNumeroAtual`	integer	✓	Próximo número de boleto

Resposta de Sucesso `200`

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

Códigos de Erro

Código	Descrição
`400`	Dados inválidos — campos obrigatórios ausentes
`401`	Token ausente ou inválido
`500`	Erro 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()

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

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (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ódigo	Descrição
`401`	Token ausente ou inválido
`404`	Conta não encontrada
`500`	Erro 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()

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

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (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ódigo	Descrição
`400`	Dados inválidos
`401`	Token ausente ou inválido
`404`	Conta não encontrada
`500`	Erro 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()

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

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (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ódigo	Descrição
`401`	Token ausente ou inválido
`404`	Conta não encontrada
`500`	Erro 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()

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ódigo	Descrição
`401`	Token ausente ou inválido
`500`	Erro 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()

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": {}
}

Visão Geral

Base URL

Endpoints

Parâmetros

Resposta de Sucesso 200

Campos da Resposta — data[]

Códigos de Erro

Exemplos de Código

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Corpo da Requisição

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Parâmetros

Resposta de Sucesso 200

Códigos de Erro

Exemplos de Código

Resposta de Sucesso `200`

Campos da Resposta — `data[]`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`