Condições de Pagamento

Visão Geral

O módulo Condições de Pagamento gerencia as condições de pagamento disponíveis no sistema, como parcelamentos, prazos e intervalos entre parcelas. São utilizadas em pedidos, notas fiscais e contas a pagar/receber.

Base URL

/api/condicoes-pagamento

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

Endpoints

GET /api/condicoes-pagamento

Descrição: Retorna a lista completa de condições de pagamento cadastradas.

Parâmetros

Nenhum parâmetro de query.

Resposta de Sucesso `200`

[
  {
    "id": 1,
    "descricao": "À Vista",
    "origem": "M",
    "quantidadeParcelas": 1,
    "diasEntreParcelas": null,
    "diasPrimeiraParcela": 0
  },
  {
    "id": 2,
    "descricao": "30/60/90 dias",
    "origem": "M",
    "quantidadeParcelas": 3,
    "diasEntreParcelas": 30,
    "diasPrimeiraParcela": 30
  }
]

Campos da Resposta

Campo	Tipo	Obrigatório	Descrição
`id`	integer (int64)	—	Identificador único
`descricao`	string	✓	Descrição da condição (máx. 100 chars)
`origem`	string	✓	Origem da condição (`M` = Manual, etc.)
`quantidadeParcelas`	integer	—	Número de parcelas
`diasEntreParcelas`	integer	—	Dias entre cada parcela
`diasPrimeiraParcela`	integer	—	Dias para o vencimento da primeira parcela

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/condicoes-pagamento" \
  -H "Authorization: Bearer {token}"

JavaScript

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

Python

import requests

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

import (
    "io"
    "net/http"
)

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

Descrição: Cria uma nova condição de pagamento.

Corpo da Requisição

{
  "descricao": "30/60/90 dias",
  "origem": "M",
  "quantidadeParcelas": 3,
  "diasEntreParcelas": 30,
  "diasPrimeiraParcela": 30
}

Campo	Tipo	Obrigatório	Regras	Descrição
`descricao`	string	✓	mín. 1, máx. 100 chars	Descrição da condição
`origem`	string	✓	mín. 1 caractere	Origem (`M` = Manual)
`quantidadeParcelas`	integer	—	—	Número de parcelas
`diasEntreParcelas`	integer	—	—	Dias entre parcelas
`diasPrimeiraParcela`	integer	—	—	Dias para a 1ª parcela

Resposta de Sucesso `200`

{
  "id": 3,
  "descricao": "30/60/90 dias",
  "origem": "M",
  "quantidadeParcelas": 3,
  "diasEntreParcelas": 30,
  "diasPrimeiraParcela": 30
}

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/condicoes-pagamento" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"descricao":"30/60/90 dias","origem":"M","quantidadeParcelas":3,"diasEntreParcelas":30,"diasPrimeiraParcela":30}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/condicoes-pagamento', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "descricao": "30/60/90 dias",
  "origem": "M",
  "quantidadeParcelas": 3,
  "diasEntreParcelas": 30,
  "diasPrimeiraParcela": 30
})
});
const data = await response.json();

Python

import requests

data = requests.post(
    'https://api.app.hooked.com.br/api/condicoes-pagamento',
    headers={'Authorization': 'Bearer {token}'},
    json={'descricao': '30/60/90 dias', 'origem': 'M', 'quantidadeParcelas': 3, 'diasEntreParcelas': 30, 'diasPrimeiraParcela': 30}
).json()

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

payload := []byte(`{"descricao":"30/60/90 dias","origem":"M","quantidadeParcelas":3,"diasEntreParcelas":30,"diasPrimeiraParcela":30}`)
req, _ := http.NewRequest("POST", "https://api.app.hooked.com.br/api/condicoes-pagamento", 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/condicoes-pagamento');
curl_setopt_array($ch, [
    CURLOPT_POST           => true,
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'descricao' => '30/60/90 dias',
        'origem' => 'M',
        'quantidadeParcelas' => 3,
        'diasEntreParcelas' => 30,
        'diasPrimeiraParcela' => 30
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — POST /api/condicoes-pagamento",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.app.hooked.com.br/api/condicoes-pagamento",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"descricao\":\"30/60/90 dias\",\"origem\":\"M\",\"quantidadeParcelas\":3,\"diasEntreParcelas\":30,\"diasPrimeiraParcela\":30}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

GET /api/condicoes-pagamento/{id}

Descrição: Retorna os dados de uma condição de pagamento específica pelo ID.

Parâmetros

Nome	Tipo	Local	Obrigatório	Descrição
`id`	integer (int64)	path	✓	ID da condição de pagamento

Resposta de Sucesso `200`

{
  "id": 1,
  "descricao": "À Vista",
  "origem": "M",
  "quantidadeParcelas": 1,
  "diasEntreParcelas": null,
  "diasPrimeiraParcela": 0
}

Códigos de Erro

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

Exemplos de Código

cURL

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

JavaScript

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

Python

import requests

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

import (
    "io"
    "net/http"
)

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

Descrição: Atualiza uma condição de pagamento existente.

Parâmetros

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

Corpo da Requisição

{
  "id": 1,
  "descricao": "À Vista (atualizado)",
  "origem": "M",
  "quantidadeParcelas": 1,
  "diasEntreParcelas": null,
  "diasPrimeiraParcela": 0
}

Resposta de Sucesso `200`

Retorna o objeto atualizado com a mesma estrutura do POST.

Códigos de Erro

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

Exemplos de Código

cURL

curl -X PUT "https://api.app.hooked.com.br/api/condicoes-pagamento/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"id":1,"descricao":"À Vista (atualizado)","origem":"M","quantidadeParcelas":1,"diasEntreParcelas":null,"diasPrimeiraParcela":0}'

JavaScript

const response = await fetch('https://api.app.hooked.com.br/api/condicoes-pagamento/{id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer {token}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "id": 1,
  "descricao": "À Vista (atualizado)",
  "origem": "M",
  "quantidadeParcelas": 1,
  "diasEntreParcelas": null,
  "diasPrimeiraParcela": 0
})
});
const data = await response.json();

Python

import requests

data = requests.put(
    'https://api.app.hooked.com.br/api/condicoes-pagamento/{id}',
    headers={'Authorization': 'Bearer {token}'},
    json={'id': 1, 'descricao': 'À Vista (atualizado)', 'origem': 'M', 'quantidadeParcelas': 1, 'diasEntreParcelas': None, 'diasPrimeiraParcela': 0}
).json()

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

payload, _ := json.Marshal({"id":1,"descricao":"À Vista (atualizado)","origem":"M","quantidadeParcelas":1,"diasEntreParcelas":null,"diasPrimeiraParcela":0})
req, _ := http.NewRequest("PUT", "https://api.app.hooked.com.br/api/condicoes-pagamento/{id}", bytes.NewBuffer(payload))
req.Header.Set("Authorization", "Bearer {token}")
req.Header.Set("Content-Type", "application/json")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

PHP

$ch = curl_init('https://api.app.hooked.com.br/api/condicoes-pagamento/{id}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'PUT',
    CURLOPT_HTTPHEADER     => ['Authorization: Bearer {token}', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'id' => 1,
        'descricao' => 'À Vista (atualizado)',
        'origem' => 'M',
        'quantidadeParcelas' => 1,
        'diasEntreParcelas' => null,
        'diasPrimeiraParcela' => 0
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);
curl_close($ch);

n8n

{
  "name": "Hooked API — PUT /api/condicoes-pagamento/{id}",
  "nodes": [
    {
      "parameters": {
        "method": "PUT",
        "url": "https://api.app.hooked.com.br/api/condicoes-pagamento/{id}",
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "Authorization",
              "value": "Bearer SEU_TOKEN_AQUI"
            }
          ]
        },
        "sendBody": true,
        "contentType": "json",
        "specifyBody": "json",
        "jsonBody": "{\"id\":1,\"descricao\":\"À Vista (atualizado)\",\"origem\":\"M\",\"quantidadeParcelas\":1,\"diasEntreParcelas\":null,\"diasPrimeiraParcela\":0}",
        "options": {}
      },
      "id": "node-1",
      "name": "HTTP Request",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        250,
        300
      ]
    }
  ],
  "connections": {},
  "pinData": {}
}

DELETE /api/condicoes-pagamento/{id}

Descrição: Remove uma condição de pagamento pelo ID.

Parâmetros

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

Resposta de Sucesso `200`

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

Códigos de Erro

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

Exemplos de Código

cURL

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

JavaScript

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

import (
    "io"
    "net/http"
)

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

Visão Geral

Base URL

Endpoints

Parâmetros

Resposta de Sucesso 200

Campos da Resposta

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

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`

Resposta de Sucesso `200`