6.2. Solicitar Informações Gerais do Sacado¶

🔗 Endpoint¶

Método	URL
	`/public/api/v1/duplicata-escritural/sacados/solicitar-informacoes-gerais`

🧾 Descrição¶

Solicita informações gerais sobre as duplicatas vinculadas a um sacado. Permite filtrar por CPF/CNPJ, situação de pagamento e períodos de emissão ou vencimento. O resultado é retornado de forma assíncrona via WebHook.

📤 Requisição¶

📋 Payload (JSON)¶

{
  "cpfOuCnpjSacado": "98765432000155",
  "situacaoPagamentoDuplicata": "Pendente",
  "periodoEmissaoDuplicata": {
    "dataInicio": "2025-01-01",
    "dataFim": "2025-12-31"
  },
  "periodoVencimentoDuplicata": {
    "dataInicio": "2025-01-01",
    "dataFim": "2025-12-31"
  }
}

🧾 Detalhamento dos Campos¶

Campo	Tipo	Obrigatório	Descrição
cpfOuCnpjSacado	string	Não	CPF ou CNPJ do sacado para filtro (somente números)
situacaoPagamentoDuplicata	string	Não	Situação de pagamento para filtro
periodoEmissaoDuplicata	object	Não	Período de emissão das duplicatas
periodoVencimentoDuplicata	object	Não	Período de vencimento das duplicatas

🔹 periodoEmissaoDuplicata / periodoVencimentoDuplicata¶

Campo	Tipo	Obrigatório	Descrição
dataInicio	string	Não	Data de início do período (YYYY-MM-DD)
dataFim	string	Não	Data de fim do período (YYYY-MM-DD)

🧪 Exemplo de cURL¶

curl -X POST https://api.vehub.com.br/public/api/v1/duplicata-escritural/sacados/solicitar-informacoes-gerais \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "cpfOuCnpjSacado": "98765432000155",
    "periodoVencimentoDuplicata": {
      "dataInicio": "2025-09-01",
      "dataFim": "2025-12-31"
    }
  }'

📥 Responses¶

✅ 200 OK¶

{
  "mensagem": "Solicitação de informações gerais registrada com sucesso!"
}

✅ 202 Accepted¶

{
  "mensagem": "Solicitação recebida e será processada em breve.",
  "identificadorProcessamento": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
}

❌ 400 Bad Request¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Período de vencimento inválido: dataFim deve ser maior ou igual a dataInicio."
  ]
}

🕒 Observações¶

Todos os campos são opcionais, permitindo uma consulta ampla ou filtrada conforme necessário.
O resultado da consulta é retornado de forma assíncrona via WebHook.
Quando o retorno for 202 Accepted, o processamento ocorrerá de forma assíncrona.