Contas a Pagar e Receber

Visão Geral

O módulo Contas a Pagar e Receber é o coração do controle financeiro do sistema. Gerencia títulos financeiros (parcelas), permitindo consultar, lançar, estornar, gerar boletos e processar retornos bancários. Suporta lançamentos manuais, integração com pedidos e notas fiscais.

Base URL

/api/contas-pagar-receber

---

Endpoints

GET /api/contas-pagar-receber

Descrição: Retorna uma lista paginada de títulos financeiros com filtros avançados por situação, pessoa, período, tipo e muito mais.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
empresaId	integer	query	—	Filtra por empresa
situacao	string	query	—	Situação do título (A = Aberto, B = Baixado, etc.)
tipo	string	query	—	Tipo (R = Receber, P = Pagar)
pessoaId	integer	query	—	Filtra por pessoa (cliente/fornecedor)
pessoaVendedorId	integer	query	—	Filtra por vendedor responsável
documentoId	integer	query	—	Filtra por tipo de documento
contaId	integer	query	—	Filtra por conta bancária
projetoId	integer	query	—	Filtra por projeto
venda	boolean	query	—	true = somente títulos de venda
ativoPassivo	boolean	query	—	Ativo (true) ou Passivo (false)
adiantamento	string	query	—	Filtro por adiantamento
vinculado	string	query	—	Filtra por vínculo
titulosDescontados	string	query	—	Títulos em desconto bancário
origem	integer	query	—	Origem do lançamento
observacao	string	query	—	Pesquisa na observação
tipoPesquisaData	integer	query	—	Tipo de data a pesquisar (1 = Emissão, 2 = Vencimento, 3 = Pagamento)
dataInicial	string (date-time)	query	—	Data inicial do período
dataFinal	string (date-time)	query	—	Data final do período
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": 10,
    "pageSize": 20,
    "totalCount": 198,
    "hasPrevious": false,
    "hasNext": true
  },
  "data": [
    {
      "id": 1,
      "empresaId": 1,
      "pessoaId": 10,
      "pessoaNome": "Cliente Exemplo Ltda",
      "documentoId": 2,
      "documentoDescricao": "Duplicata",
      "historico": "Venda pedido #500",
      "dataEmissao": "2024-01-10T00:00:00",
      "dataVencimento": "2024-02-10T00:00:00",
      "dataPaga": null,
      "numero": "001",
      "parcela": 1,
      "tipo": "R",
      "valor": 3000.00,
      "totalPago": 0,
      "valorDesconto": 0,
      "valorJuros": 0,
      "status": "A",
      "situacaoDescricao": "Aberto",
      "boleto": false,
      "nossoNumero": null,
      "pedidoId": 500,
      "notaFiscalId": null,
      "contaId": 1,
      "contaDescricao": "Conta Principal BB"
    }
  ],
  "summary": null
}

Campos da Resposta — data[]

Campo	Tipo	Descrição
id	integer (int64)	Identificador único do título
empresaId	integer	ID da empresa
pessoaId	integer	ID da pessoa (cliente/fornecedor)
pessoaNome	string	Nome da pessoa
documentoId	integer	ID do tipo de documento
documentoDescricao	string	Descrição do tipo de documento
historico	string	Histórico/descrição do lançamento
dataEmissao	string (date-time)	Data de emissão
dataVencimento	string (date-time)	Data de vencimento
dataPaga	string (date-time)	Data do pagamento/recebimento
numero	string	Número do documento
parcela	integer	Número da parcela (ex: 1, 2, 3). Use quantidadeParcelas para o total
tipo	string	R = Receber, P = Pagar
valor	number (double)	Valor original do título
totalPago	number (double)	Valor total já pago
valorDesconto	number (double)	Desconto aplicado
valorJuros	number (double)	Juros aplicados
status	string	Status (A = Aberto, B = Baixado)
situacaoDescricao	string	Descrição da situação
boleto	boolean	Indica se foi gerado boleto
nossoNumero	string	Nosso número bancário do boleto
pedidoId	integer	ID do pedido de origem
notaFiscalId	integer	ID da nota fiscal vinculada
contaId	integer	ID da conta bancária

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-pagar-receber" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

Descrição: Retorna os dados completos de um título financeiro pelo ID, incluindo referências vinculadas.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
id	integer (int64)	path	✓	ID do título

Resposta de Sucesso 200

Retorna o objeto completo do título com todos os campos descritos na listagem, além de referencias (array de vínculos com outros registros).

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Título não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

---

POST /api/contas-pagar-receber/many

Descrição: Cria múltiplos títulos financeiros em um único lançamento (ex: parcelamento manual).

Corpo da Requisição

O corpo da requisição é um array de objetos ContasPagarReceberViewModel (List<ContasPagarReceberViewModel>). Cada item representa um título financeiro a ser criado.

[
  {
    "empresaId": 1,
    "pessoaId": 10,
    "documentoId": 2,
    "historico": "Parcelamento manual",
    "dataEmissao": "2024-01-10T00:00:00",
    "dataVencimento": "2024-02-10T00:00:00",
    "numero": "001",
    "parcela": 1,
    "tipo": "R",
    "valor": 1000.00,
    "tipoPlanoConta": "R",
    "contaId": 1
  }
]

Campos de cada item (ContasPagarReceberViewModel)

Campo	Tipo	Obrigatório	Regras	Descrição
id	integer (int64)	—		ID do título (gerado pela API)
empresaId	integer (int64)	✓		ID da empresa (obrigatório — sem ele a API retorna 400 com mensagem "Configuração da Empresa não encontrada")
pessoaId	integer (int64)	✓		ID da pessoa (cliente/fornecedor)
pessoaVendedorId	integer (int64)	—	nullable	ID do vendedor associado
documentoId	integer (int64)	—	nullable	ID do tipo de documento
historico	string	✓	mín. 1 caractere	Histórico/descrição do lançamento
dataEmissao	string (date-time)	✓		Data de emissão do título
numero	string	—	nullable	Número do documento
tipo	string	—	nullable	Tipo do título. Valores: "R" = Receber, "P" = Pagar
centroCustoId	integer (int64)	—	nullable	ID do centro de custo
tipoPlanoConta	string	✓	mín. 1 caractere	Tipo do plano de conta
competencia	string (date-time)	—	nullable	Data de competência contábil
numeroDocumentoSerie	string	—	nullable	Série do documento
portador	string	—	nullable	Portador do título
codigoBarraDocumento	string	—	nullable	Código de barras do documento
observacao	string	—	nullable	Observação geral
notaFiscalId	integer (int64)	—	nullable	ID da nota fiscal vinculada
comissao	number (double)	—	nullable	Valor de comissão
pedidoId	integer (int64)	—	nullable	ID do pedido vinculado
adiantamento	boolean	—	nullable	Indica adiantamento
contaId	integer (int64)	—	nullable	ID da conta bancária
parcela	integer (int32)	✓		Número da parcela
documentoPagamentoId	integer (int64)	—	nullable	ID do documento de pagamento
grupoMultiplo	integer (int64)	—	nullable	ID do grupo de parcelas
numeroAss	string	—	nullable	Número associado
numeroBanco	string	—	nullable	Número bancário
bordero	string	—	nullable	Borderô bancário
dataCustodia	string (date-time)	—	nullable	Data de custódia
dataVencimento	string (date-time)	✓		Data de vencimento
dataPaga	string (date-time)	—	nullable	Data efetiva do pagamento
valor	number (double)	✓		Valor da parcela
status	string	—	nullable	Status do título
valorDesconto	number (double)	—	nullable	Valor de desconto
valorJuros	number (double)	—	nullable	Valor de juros
totalPago	number (double)	—	nullable	Total pago no título
original	boolean	—	nullable	Indica título original
observacaoParcela	string	—	nullable	Observação específica da parcela
nossoNumero	string	—	nullable	Nosso número (boleto)
nossoNumeroBase	string	—	nullable	Nosso número base
boleto	boolean	—	nullable	Indica geração de boleto
comissaoGerada	boolean	—	nullable	Indica se a comissão já foi gerada
projetoId	integer (int64)	—	nullable	ID do projeto vinculado
transferenciaId	integer (int64)	—	nullable	ID da transferência vinculada
pagamentoPorComissao	boolean	—	nullable	Indica pagamento por comissão
grupo	integer (int64)	—	nullable	ID do grupo
referencias	array	—	nullable	Referências relacionadas ao título

Resposta de Sucesso 200

Retorna o array de títulos criados com a mesma estrutura do GET /{id}.

Códigos de Erro

Código	Descrição
400	Dados inválidos
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-pagar-receber/many" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '[{"empresaId":1,"pessoaId":10,"documentoId":2,"historico":"Parcelamento manual","dataEmissao":"2024-01-10T00:00:00","dataVencimento":"2024-02-10T00:00:00","numero":"001","parcela":1,"tipo":"R","valor":1000.0,"contaId":1}]'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/many', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
  {
    "empresaId": 1,
    "pessoaId": 10,
    "documentoId": 2,
    "historico": "Parcelamento manual",
    "dataEmissao": "2024-01-10T00:00:00",
    "dataVencimento": "2024-02-10T00:00:00",
    "numero": "001",
    "parcela": 1,
    "tipo": "R",
    "valor": 1000.0,
    "contaId": 1
  }
])
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/many',
    headers={'Authorization': 'Bearer {token}'},
    json=[{'empresaId': 1, 'pessoaId': 10, 'documentoId': 2, 'historico': 'Parcelamento manual', 'dataEmissao': '2024-01-10T00:00:00', 'dataVencimento': '2024-02-10T00:00:00', 'numero': '001', 'parcela': 1, 'tipo': 'R', 'valor': 1000.0, 'contaId': 1}]
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload, _ := json.Marshal([{"empresaId":1,"pessoaId":10,"documentoId":2,"historico":"Parcelamento manual","dataEmissao":"2024-01-10T00:00:00","dataVencimento":"2024-02-10T00:00:00","numero":"001","parcela":1,"tipo":"R","valor":1000.0,"contaId":1}])
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/many", 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-pagar-receber/many');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        [
            'empresaId' => 1,
            'pessoaId' => 10,
            'documentoId' => 2,
            'historico' => 'Parcelamento manual',
            'dataEmissao' => '2024-01-10T00:00:00',
            'dataVencimento' => '2024-02-10T00:00:00',
            'numero' => '001',
            'parcela' => 1,
            'tipo' => 'R',
            'valor' => 1000.0,
            'contaId' => 1
        ]
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/many",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/many",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "[{\"empresaId\":1,\"pessoaId\":10,\"documentoId\":2,\"historico\":\"Parcelamento manual\",\"dataEmissao\":\"2024-01-10T00:00:00\",\"dataVencimento\":\"2024-02-10T00:00:00\",\"numero\":\"001\",\"parcela\":1,\"tipo\":\"R\",\"valor\":1000.0,\"contaId\":1}]",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

PUT /api/contas-pagar-receber/{id}/estornar-parcela

Descrição: Estorna o pagamento de uma parcela específica, revertendo o status para Aberto.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
id	integer (int64)	path	✓	ID da parcela a ser estornada

Resposta de Sucesso 200

Retorna o título atualizado com a mesma estrutura do GET /{id}.

Códigos de Erro

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

Exemplos de Código

cURL

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

JavaScript

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{id}/estornar-parcela", 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-pagar-receber/{id}/estornar-parcela');
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-pagar-receber/{id}/estornar-parcela",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{id}/estornar-parcela",
        "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-pagar-receber/{grupo}/estornar-conta

Descrição: Estorna todas as parcelas de um grupo de títulos (lançamento completo).

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
grupo	integer (int64)	path	✓	Identificador do grupo de parcelas

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Grupo não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/estornar-conta" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/estornar-conta", 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-pagar-receber/{grupo}/estornar-conta');
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-pagar-receber/{grupo}/estornar-conta",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/estornar-conta",
        "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-pagar-receber/{grupo}/gerar-boleto

Descrição: Gera boleto(s) bancário(s) para todas as parcelas do grupo informado.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
grupo	integer (int64)	path	✓	Identificador do grupo de parcelas

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Grupo não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/gerar-boleto" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/gerar-boleto", 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-pagar-receber/{grupo}/gerar-boleto');
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-pagar-receber/{grupo}/gerar-boleto",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{grupo}/gerar-boleto",
        "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-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal

Descrição: Gera boleto vinculado a uma nota fiscal específica.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
notaFiscalId	integer (int64)	path	✓	ID da nota fiscal

Resposta de Sucesso 200

{
  "caminho": "/storage/boletos/boleto_12345.pdf",
  "contaId": 1
}

Campo	Tipo	Descrição
caminho	string	Caminho/URL do arquivo PDF do boleto gerado
contaId	integer	ID da conta bancária utilizada

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Nota fiscal não encontrada
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/contas-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal" \
  -H "Authorization: Bearer {token}"

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal', {
  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-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal", 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-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal');
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-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{notaFiscalId}/gerar-boleto-por-nota-fiscal",
        "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-pagar-receber/{contaId}/enviar-email

Descrição: Envia por e-mail o boleto referente ao título informado.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
contaId	integer (int64)	path	✓	ID do título/parcela

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Título não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/enviar-email" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/enviar-email", 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-pagar-receber/{contaId}/enviar-email');
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-pagar-receber/{contaId}/enviar-email",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/enviar-email",
        "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-pagar-receber/{empresaId}/{contaId}/processar-retorno

Descrição: Processa o arquivo de retorno bancário, baixando automaticamente os títulos liquidados.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
empresaId	integer (int64)	path	✓	ID da empresa
contaId	integer (int64)	path	✓	ID da conta bancária

Códigos de Erro

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

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/contas-pagar-receber/{empresaId}/{contaId}/processar-retorno" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Go

import (
    "io"
    "net/http"
)

req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/contas-pagar-receber/{empresaId}/{contaId}/processar-retorno", 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-pagar-receber/{empresaId}/{contaId}/processar-retorno');
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-pagar-receber/{empresaId}/{contaId}/processar-retorno",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{empresaId}/{contaId}/processar-retorno",
        "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-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}

Descrição: Faz o download do arquivo de retorno bancário associado a um título/conta específica.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
contaId	integer (int64)	path	✓	ID da conta bancária
nomeArquivo	string	path	✓	Nome do arquivo de retorno

Resposta de Sucesso 200

Retorna o arquivo de retorno bancário para download.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Arquivo não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}" \
  -H "Authorization: Bearer {token}" \
  -o arquivo

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}', {
  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/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}',
    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/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}", 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/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}');
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/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{contaId}/recuperar-arquivo/{nomeArquivo}",
        "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-pagar-receber/recuperar-por-grupo/{grupo}

Descrição: Retorna todas as parcelas pertencentes a um grupo de títulos (lançamento parcelado).

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
grupo	integer (int64)	path	✓	Identificador do grupo de parcelas

Resposta de Sucesso 200

Retorna um array de títulos com a mesma estrutura do GET /api/contas-pagar-receber.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Grupo não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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

Descrição: Realiza a baixa (liquidação) de um ou mais títulos financeiros, registrando o recebimento ou pagamento.

Corpo da Requisição

Estrutura conforme o schema ContasPagarReceberInputViewModel.

{
  "tipo": "R",
  "itens": [],
  "parcelas": [],
  "selecionadas": [1, 2, 3]
}

Campo	Tipo	Obrigatório	Regras	Descrição
tipo	string	✓	mín. 1 caractere	Tipo da operação de baixa (ex: P pagar / R receber)
itens	array	—	nullable	Itens auxiliares à baixa
parcelas	array	—	nullable	Parcelas envolvidas na baixa
selecionadas	array	—	nullable	IDs ou itens selecionados para a baixa

Resposta de Sucesso 200

Retorna os títulos atualizados com status de baixado.

Códigos de Erro

Código	Descrição
400	Dados inválidos
401	Token ausente ou inválido
404	Títulos não encontrados
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/contas-pagar-receber/baixar" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"contasPagarReceberIds":[1,2,3],"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":3000.0,"valorDesconto":0,"valorJuros":0,"valorMulta":0,"observacao":"Pagamento via PIX"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/baixar', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "contasPagarReceberIds": [
    1,
    2,
    3
  ],
  "dataPagamento": "2024-01-15T00:00:00",
  "contaBancariaId": 1,
  "valorPago": 3000.0,
  "valorDesconto": 0,
  "valorJuros": 0,
  "valorMulta": 0,
  "observacao": "Pagamento via PIX"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/baixar',
    headers={'Authorization': 'Bearer {token}'},
    json={'contasPagarReceberIds': [1, 2, 3], 'dataPagamento': '2024-01-15T00:00:00', 'contaBancariaId': 1, 'valorPago': 3000.0, 'valorDesconto': 0, 'valorJuros': 0, 'valorMulta': 0, 'observacao': 'Pagamento via PIX'}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload := []byte(`{"contasPagarReceberIds":[1,2,3],"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":3000.0,"valorDesconto":0,"valorJuros":0,"valorMulta":0,"observacao":"Pagamento via PIX"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/baixar", 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-pagar-receber/baixar');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'contasPagarReceberIds' => [
            1,
            2
        ],
        'dataPagamento' => '2024-01-15T00:00:00',
        'contaBancariaId' => 1,
        'valorPago' => 3000.0,
        'valorDesconto' => 0,
        'valorJuros' => 0,
        'valorMulta' => 0,
        'observacao' => 'Pagamento via PIX'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/baixar",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/baixar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"contasPagarReceberIds\":[1,2,3],\"dataPagamento\":\"2024-01-15T00:00:00\",\"contaBancariaId\":1,\"valorPago\":3000.0,\"valorDesconto\":0,\"valorJuros\":0,\"valorMulta\":0,\"observacao\":\"Pagamento via PIX\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/contas-pagar-receber/recuperar-quantidade

Descrição: Retorna a quantidade total de títulos financeiros cadastrados, podendo aplicar filtros por tipo e situação.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
tipo	string	query	—	Tipo do título (R = Receber, P = Pagar)
situacao	string	query	—	Situação (A = Aberto, B = Baixado)

Resposta de Sucesso 200

{
  "quantidade": 198
}

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-pagar-receber/recuperar-quantidade" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Go

import (
    "io"
    "net/http"
)

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

---

POST /api/contas-pagar-receber/salvar-custodia

Descrição: Registra títulos em custódia bancária (desconto de duplicatas), vinculando-os a uma operação de antecipação de recebíveis.

Corpo da Requisição

Estrutura conforme o schema CustodiaViewModel.

{
  "id": 0,
  "bordero": "BORD-2024-001",
  "contaId": 1,
  "itens": [1, 2, 3]
}

Campo	Tipo	Obrigatório	Regras	Descrição
id	integer (int64)	—		ID da custódia (gerado pela API)
bordero	string	✓	mín. 1 caractere	Identificador do borderô bancário
contaId	integer (int64)	✓		ID da conta bancária da operação
itens	array	—	nullable	IDs dos títulos a serem registrados em custódia

Resposta de Sucesso 200

Retorna a confirmação dos títulos registrados em custódia.

Códigos de Erro

Código	Descrição
400	Dados inválidos
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-pagar-receber/salvar-custodia" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"contasPagarReceberIds":[1,2,3],"contaBancariaId":1,"dataOperacao":"2024-01-15T00:00:00","taxaDesconto":2.5,"observacao":"Desconto de duplicatas - Janeiro 2024"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/salvar-custodia', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "contasPagarReceberIds": [
    1,
    2,
    3
  ],
  "contaBancariaId": 1,
  "dataOperacao": "2024-01-15T00:00:00",
  "taxaDesconto": 2.5,
  "observacao": "Desconto de duplicatas - Janeiro 2024"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/salvar-custodia',
    headers={'Authorization': 'Bearer {token}'},
    json={'contasPagarReceberIds': [1, 2, 3], 'contaBancariaId': 1, 'dataOperacao': '2024-01-15T00:00:00', 'taxaDesconto': 2.5, 'observacao': 'Desconto de duplicatas - Janeiro 2024'}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload := []byte(`{"contasPagarReceberIds":[1,2,3],"contaBancariaId":1,"dataOperacao":"2024-01-15T00:00:00","taxaDesconto":2.5,"observacao":"Desconto de duplicatas - Janeiro 2024"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/salvar-custodia", 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-pagar-receber/salvar-custodia');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'contasPagarReceberIds' => [
            1,
            2
        ],
        'contaBancariaId' => 1,
        'dataOperacao' => '2024-01-15T00:00:00',
        'taxaDesconto' => 2.5,
        'observacao' => 'Desconto de duplicatas - Janeiro 2024'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/salvar-custodia",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/salvar-custodia",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"contasPagarReceberIds\":[1,2,3],\"contaBancariaId\":1,\"dataOperacao\":\"2024-01-15T00:00:00\",\"taxaDesconto\":2.5,\"observacao\":\"Desconto de duplicatas - Janeiro 2024\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/contas-pagar-receber/{id}/imprimir-recibo

Descrição: Gera e retorna o recibo de pagamento/recebimento de um título financeiro específico em formato PDF.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
id	integer (int64)	path	✓	ID do título financeiro

Resposta de Sucesso 200

Retorna o arquivo PDF do recibo para download.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Título não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/contas-pagar-receber/{id}/imprimir-recibo" \
  -H "Authorization: Bearer {token}" \
  -o arquivo

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/{id}/imprimir-recibo', {
  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/contas-pagar-receber/{id}/imprimir-recibo',
    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/contas-pagar-receber/{id}/imprimir-recibo", 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/contas-pagar-receber/{id}/imprimir-recibo');
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/contas-pagar-receber/{id}/imprimir-recibo",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/{id}/imprimir-recibo",
        "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-pagar-receber/editar-conta

Descrição: Edita os dados principais de um lançamento (grupo de parcelas) inteiro, como pessoa, documento, histórico e data de emissão.

Corpo da Requisição

Estrutura conforme o schema ContasPagarReceberEditarContaViewModel.

{
  "id": 1,
  "grupo": 100,
  "documentoId": 2,
  "numero": "001"
}

Campo	Tipo	Obrigatório	Regras	Descrição
id	integer (int64)	—		ID do registro a editar
grupo	integer (int64)	✓		Identificador do grupo de parcelas
documentoId	integer (int64)	✓		ID do tipo de documento
numero	string	✓	mín. 1 caractere	Número do documento

Resposta de Sucesso 200

Retorna os títulos do grupo atualizados.

Códigos de Erro

Código	Descrição
400	Dados inválidos
401	Token ausente ou inválido
404	Grupo não encontrado
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-conta" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"grupo":100,"pessoaId":10,"documentoId":2,"historico":"Venda revisada pedido #500","dataEmissao":"2024-01-10T00:00:00","contaId":1,"projetoId":null,"observacao":"Correção de lançamento"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/editar-conta', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "grupo": 100,
  "pessoaId": 10,
  "documentoId": 2,
  "historico": "Venda revisada pedido #500",
  "dataEmissao": "2024-01-10T00:00:00",
  "contaId": 1,
  "projetoId": null,
  "observacao": "Correção de lançamento"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/editar-conta',
    headers={'Authorization': 'Bearer {token}'},
    json={'grupo': 100, 'pessoaId': 10, 'documentoId': 2, 'historico': 'Venda revisada pedido #500', 'dataEmissao': '2024-01-10T00:00:00', 'contaId': 1, 'projetoId': None, 'observacao': 'Correção de lançamento'}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload := []byte(`{"grupo":100,"pessoaId":10,"documentoId":2,"historico":"Venda revisada pedido #500","dataEmissao":"2024-01-10T00:00:00","contaId":1,"projetoId":null,"observacao":"Correção de lançamento"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-conta", 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-pagar-receber/editar-conta');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'grupo' => 100,
        'pessoaId' => 10,
        'documentoId' => 2,
        'historico' => 'Venda revisada pedido #500',
        'dataEmissao' => '2024-01-10T00:00:00',
        'contaId' => 1,
        'projetoId' => null,
        'observacao' => 'Correção de lançamento'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/editar-conta",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-conta",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"grupo\":100,\"pessoaId\":10,\"documentoId\":2,\"historico\":\"Venda revisada pedido #500\",\"dataEmissao\":\"2024-01-10T00:00:00\",\"contaId\":1,\"projetoId\":null,\"observacao\":\"Correção de lançamento\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

POST /api/contas-pagar-receber/editar-parcela

Descrição: Edita os dados de uma parcela individual, como valor, vencimento e número.

Corpo da Requisição

Estrutura conforme o schema ContasPagarReceberEditarParcelaViewModel.

{
  "id": 1,
  "parcela": 1,
  "valor": 1100.00,
  "dataVencimento": "2024-02-15T00:00:00",
  "documentoId": 2
}

Campo	Tipo	Obrigatório	Regras	Descrição
id	integer (int64)	—		ID da parcela a editar
parcela	integer (int32)	✓		Número da parcela
valor	number (double)	✓		Novo valor da parcela
dataVencimento	string (date-time)	✓		Nova data de vencimento
documentoId	integer (int64)	✓		ID do tipo de documento

Resposta de Sucesso 200

Retorna o título atualizado com a mesma estrutura do GET /{id}.

Códigos de Erro

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

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-parcela" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"id":1,"numero":"001","parcela":1,"dataVencimento":"2024-02-15T00:00:00","valor":1100.0,"valorDesconto":0,"observacao":"Prorrogação de vencimento"}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/editar-parcela', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "id": 1,
  "numero": "001",
  "parcela": 1,
  "dataVencimento": "2024-02-15T00:00:00",
  "valor": 1100.0,
  "valorDesconto": 0,
  "observacao": "Prorrogação de vencimento"
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/editar-parcela',
    headers={'Authorization': 'Bearer {token}'},
    json={'id': 1, 'numero': '001', 'parcela': 1, 'dataVencimento': '2024-02-15T00:00:00', 'valor': 1100.0, 'valorDesconto': 0, 'observacao': 'Prorrogação de vencimento'}
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload := []byte(`{"id":1,"numero":"001","parcela":1,"dataVencimento":"2024-02-15T00:00:00","valor":1100.0,"valorDesconto":0,"observacao":"Prorrogação de vencimento"}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-parcela", 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-pagar-receber/editar-parcela');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'id' => 1,
        'numero' => '001',
        'parcela' => 1,
        'dataVencimento' => '2024-02-15T00:00:00',
        'valor' => 1100.0,
        'valorDesconto' => 0,
        'observacao' => 'Prorrogação de vencimento'
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/editar-parcela",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/editar-parcela",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"id\":1,\"numero\":\"001\",\"parcela\":1,\"dataVencimento\":\"2024-02-15T00:00:00\",\"valor\":1100.0,\"valorDesconto\":0,\"observacao\":\"Prorrogação de vencimento\"}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

POST /api/contas-pagar-receber/many-pagar

Descrição: Realiza a baixa em lote de múltiplos títulos, recebendo os IDs das contas a pagar/receber a serem liquidadas.

Corpo da Requisição

O corpo da requisição é um array de inteiros (List<int64>) contendo os IDs das contas a pagar/receber a serem baixadas.

[1, 2, 3]

Campo	Tipo	Obrigatório	Regras	Descrição
(raiz)	array de integer (int64)	✓	mín. 1 elemento	IDs dos títulos a baixar

Resposta de Sucesso 200

Retorna os títulos atualizados após a baixa.

Códigos de Erro

Código	Descrição
400	Dados inválidos
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-pagar-receber/many-pagar" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '[{"contaPagarReceberId":1,"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":1000.0,"valorDesconto":0,"valorJuros":0},{"contaPagarReceberId":2,"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":2000.0,"valorDesconto":50.0,"valorJuros":0}]'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/many-pagar', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
  {
    "contaPagarReceberId": 1,
    "dataPagamento": "2024-01-15T00:00:00",
    "contaBancariaId": 1,
    "valorPago": 1000.0,
    "valorDesconto": 0,
    "valorJuros": 0
  },
  {
    "contaPagarReceberId": 2,
    "dataPagamento": "2024-01-15T00:00:00",
    "contaBancariaId": 1,
    "valorPago": 2000.0,
    "valorDesconto": 50.0,
    "valorJuros": 0
  }
])
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/many-pagar',
    headers={'Authorization': 'Bearer {token}'},
    json=[{'contaPagarReceberId': 1, 'dataPagamento': '2024-01-15T00:00:00', 'contaBancariaId': 1, 'valorPago': 1000.0, 'valorDesconto': 0, 'valorJuros': 0}, {'contaPagarReceberId': 2, 'dataPagamento': '2024-01-15T00:00:00', 'contaBancariaId': 1, 'valorPago': 2000.0, 'valorDesconto': 50.0, 'valorJuros': 0}]
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload, _ := json.Marshal([{"contaPagarReceberId":1,"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":1000.0,"valorDesconto":0,"valorJuros":0},{"contaPagarReceberId":2,"dataPagamento":"2024-01-15T00:00:00","contaBancariaId":1,"valorPago":2000.0,"valorDesconto":50.0,"valorJuros":0}])
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/many-pagar", 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-pagar-receber/many-pagar');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        [
            'contaPagarReceberId' => 1,
            'dataPagamento' => '2024-01-15T00:00:00',
            'contaBancariaId' => 1,
            'valorPago' => 1000.0,
            'valorDesconto' => 0,
            'valorJuros' => 0
        ],
        [
            'contaPagarReceberId' => 2,
            'dataPagamento' => '2024-01-15T00:00:00',
            'contaBancariaId' => 1,
            'valorPago' => 2000.0,
            'valorDesconto' => 50.0,
            'valorJuros' => 0
        ]
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/many-pagar",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/many-pagar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "[{\"contaPagarReceberId\":1,\"dataPagamento\":\"2024-01-15T00:00:00\",\"contaBancariaId\":1,\"valorPago\":1000.0,\"valorDesconto\":0,\"valorJuros\":0},{\"contaPagarReceberId\":2,\"dataPagamento\":\"2024-01-15T00:00:00\",\"contaBancariaId\":1,\"valorPago\":2000.0,\"valorDesconto\":50.0,\"valorJuros\":0}]",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

POST /api/contas-pagar-receber/baixar-descontado

Descrição: Realiza a baixa de títulos que estavam em custódia/desconto bancário, registrando a liquidação pela instituição financeira.

Corpo da Requisição

O corpo da requisição é um array de inteiros (List<int64>) contendo os IDs dos títulos em custódia a serem baixados.

[1, 2, 3]

Campo	Tipo	Obrigatório	Regras	Descrição
(raiz)	array de integer (int64)	✓	mín. 1 elemento	IDs dos títulos em custódia a baixar

Resposta de Sucesso 200

Retorna os títulos atualizados após a baixa.

Códigos de Erro

Código	Descrição
400	Dados inválidos
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-pagar-receber/baixar-descontado" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '[1,2,3]'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/baixar-descontado', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
  1,
  2,
  3
])
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/baixar-descontado',
    headers={'Authorization': 'Bearer {token}'},
    json=[1, 2, 3]
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload, _ := json.Marshal([1,2,3])
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/baixar-descontado", 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-pagar-receber/baixar-descontado');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        1,
        2
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/baixar-descontado",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/baixar-descontado",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "[1,2,3]",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

POST /api/contas-pagar-receber/reembolsar

Descrição: Registra o reembolso de títulos já baixados, revertendo para o status em aberto e gerando um novo lançamento de saída.

Corpo da Requisição

O corpo da requisição é um array de inteiros (List<int64>) contendo os IDs dos títulos a reembolsar.

[1, 2, 3]

Campo	Tipo	Obrigatório	Regras	Descrição
(raiz)	array de integer (int64)	✓	mín. 1 elemento	IDs dos títulos a reembolsar

Resposta de Sucesso 200

Retorna os títulos atualizados após o reembolso.

Códigos de Erro

Código	Descrição
400	Dados inválidos
401	Token ausente ou inválido
404	Títulos não encontrados
500	Erro interno do servidor

Exemplos de Código

cURL

curl -X POST "https://api.app.hooked.com.br/api/contas-pagar-receber/reembolsar" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '[1,2,3]'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/reembolsar', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
  1,
  2,
  3
])
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/reembolsar',
    headers={'Authorization': 'Bearer {token}'},
    json=[1, 2, 3]
).json()

Go

import (
    "bytes"
    "encoding/json"
    "net/http"
)

payload, _ := json.Marshal([1,2,3])
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/contas-pagar-receber/reembolsar", 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-pagar-receber/reembolsar');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        1,
        2
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/contas-pagar-receber/reembolsar",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/reembolsar",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "[1,2,3]",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

---

GET /api/contas-pagar-receber/consulta-valor-vencido/{pessoaId}

Descrição: Consulta o valor total de títulos vencidos e em aberto para uma pessoa (cliente/fornecedor) específica.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
pessoaId	integer (int64)	path	✓	ID da pessoa

Resposta de Sucesso 200

{
  "pessoaId": 10,
  "pessoaNome": "Cliente Exemplo Ltda",
  "valorVencido": 5500.00,
  "quantidadeTitulos": 3
}

Códigos de Erro

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

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/contas-pagar-receber/consulta-valor-vencido/{pessoaId}" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Python

import requests

data = requests.get(
    'https://api.app.hooked.com.br/api/contas-pagar-receber/consulta-valor-vencido/{pessoaId}',
    headers={'Authorization': 'Bearer {token}'}
).json()

Go

import (
    "io"
    "net/http"
)

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

Descrição: Gera um relatório de contas a pagar/receber em formato PDF com base nos filtros informados.

Parâmetros de Query

Nome	Tipo	Local	Obrigatório	Descrição
situacao	string	query	—	Situação do título
documentoId	integer	query	—	ID do tipo de documento
pessoaId	integer	query	—	ID da pessoa
pessoaVendedorId	integer	query	—	ID do vendedor
tipoPesquisaData	integer	query	—	Tipo de data (1 = Emissão, 2 = Vencimento, 3 = Pagamento)
dataInicial	string (date-time)	query	—	Data inicial
dataFinal	string (date-time)	query	—	Data final
venda	boolean	query	—	Somente títulos de venda
ativoPassivo	boolean	query	—	Ativo (true) ou passivo (false)
tipo	string	query	—	Tipo (R = Receber, P = Pagar)
empresaId	integer	query	—	ID da empresa
contaId	integer	query	—	ID da conta bancária
projetoId	integer	query	—	ID do projeto
fromCustodia	boolean	query	—	Somente títulos em custódia

Resposta de Sucesso 200

Retorna o arquivo PDF do relatório para download.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro ao gerar o relatório

Exemplos de Código

cURL

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

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/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/contas-pagar-receber/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/contas-pagar-receber/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/contas-pagar-receber/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/contas-pagar-receber/gerar-relatorio",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/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": {}
}

---

GET /api/contas-pagar-receber/gerar-relatorio-despesa

Descrição: Gera um relatório de despesas (contas a pagar) em formato PDF com base nos filtros informados.

Parâmetros de Query

Nome	Tipo	Local	Obrigatório	Descrição
situacao	string	query	—	Situação do título
documentoId	integer	query	—	ID do tipo de documento
pessoaId	integer	query	—	ID da pessoa
pessoaVendedorId	integer	query	—	ID do vendedor
tipoPesquisaData	integer	query	—	Tipo de data (1 = Emissão, 2 = Vencimento, 3 = Pagamento)
dataInicial	string (date-time)	query	—	Data inicial
dataFinal	string (date-time)	query	—	Data final
venda	boolean	query	—	Somente títulos de venda
ativoPassivo	boolean	query	—	Ativo (true) ou passivo (false)
tipo	string	query	—	Tipo (R = Receber, P = Pagar)
empresaId	integer	query	—	ID da empresa
contaId	integer	query	—	ID da conta bancária
projetoId	integer	query	—	ID do projeto

Resposta de Sucesso 200

Retorna o arquivo PDF do relatório de despesas para download.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro ao gerar o relatório

Exemplos de Código

cURL

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

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/gerar-relatorio-despesa', {
  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/contas-pagar-receber/gerar-relatorio-despesa',
    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/contas-pagar-receber/gerar-relatorio-despesa", 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/contas-pagar-receber/gerar-relatorio-despesa');
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/contas-pagar-receber/gerar-relatorio-despesa",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/gerar-relatorio-despesa",
        "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-pagar-receber/gerar-csv-despesa

Descrição: Exporta os dados de despesas (contas a pagar) em formato CSV para análise em planilhas.

Parâmetros de Query

Nome	Tipo	Local	Obrigatório	Descrição
situacao	string	query	—	Situação do título
documentoId	integer	query	—	ID do tipo de documento
pessoaId	integer	query	—	ID da pessoa
pessoaVendedorId	integer	query	—	ID do vendedor
tipoPesquisaData	integer	query	—	Tipo de data (1 = Emissão, 2 = Vencimento, 3 = Pagamento)
dataInicial	string (date-time)	query	—	Data inicial
dataFinal	string (date-time)	query	—	Data final
venda	boolean	query	—	Somente títulos de venda
ativoPassivo	boolean	query	—	Ativo (true) ou passivo (false)
tipo	string	query	—	Tipo (R = Receber, P = Pagar)
empresaId	integer	query	—	ID da empresa
contaId	integer	query	—	ID da conta bancária
projetoId	integer	query	—	ID do projeto

Resposta de Sucesso 200

Retorna o arquivo CSV das despesas para download com Content-Type: text/csv.

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
500	Erro ao gerar o CSV

Exemplos de Código

cURL

curl -X GET "https://api.app.hooked.com.br/api/contas-pagar-receber/gerar-csv-despesa" \
  -H "Authorization: Bearer {token}" \
  -o arquivo

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/contas-pagar-receber/gerar-csv-despesa', {
  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/contas-pagar-receber/gerar-csv-despesa',
    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/contas-pagar-receber/gerar-csv-despesa", 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/contas-pagar-receber/gerar-csv-despesa');
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/contas-pagar-receber/gerar-csv-despesa",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.app.hooked.com.br/api/contas-pagar-receber/gerar-csv-despesa",
        "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-pagar-receber/recuperar-comissao/{ids}

Descrição: Recupera os dados de comissão associados a um ou mais títulos financeiros, utilizado para cálculo e pagamento de comissões a vendedores.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
ids	string	path	✓	IDs dos títulos separados por vírgula (ex: 1,2,3)

Resposta de Sucesso 200

[
  {
    "contaPagarReceberId": 1,
    "vendedorId": 5,
    "vendedorNome": "Ana Lima",
    "valorComissao": 150.00,
    "percentualComissao": 5.0,
    "status": "pendente"
  }
]

Códigos de Erro

Código	Descrição
401	Token ausente ou inválido
404	Títulos não encontrados
500	Erro interno do servidor

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

Go

import (
    "io"
    "net/http"
)

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