5.6. Garantias¶

Gerencia as garantias vinculadas a uma Nota Comercial. Garantias podem ser aditadas, consultadas e excluídas enquanto a NC estiver em status Em Digitação.

Listar Garantias da NC¶

🔗 Endpoint¶

Método	URL
	/public/v1/nota-comercial/{id}/garantias

🔹 Path Parameter¶

🧪 Exemplo de cURL¶

curl -X GET https://api.vehub.com.br/public/v1/nota-comercial/100/garantias \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Response — 200 OK¶

[
  {
    "id": 5,
    "idTipoGarantia": 1,
    "tipoGarantia": "Cessão Fiduciária",
    "descricao": "Cessão fiduciária de recebíveis de cartão de crédito",
    "documentos": [
      {
        "id": 20,
        "nomeArquivo": "cessao-fiduciaria.pdf"
      }
    ]
  }
]

Detalhamento dos Campos — []¶

Adicionar Garantia¶

🔗 Endpoint¶

Método	URL
	/public/v1/nota-comercial/{id}/garantias

🧾 Descrição¶

Adiciona uma garantia à NC. O envio é realizado como multipart/form-data para permitir o upload do documento comprobatório.

Os campos adicionais (empresa ou pessoas) variam conforme o tipo de garantia: - Garantias com Pessoa Física (ex: Fiador PF): preencher pessoas[] - Garantias com Pessoa Jurídica (ex: Fiador PJ): preencher empresa - Garantias sem vinculação de pessoa (ex: Cessão Fiduciária, Hipoteca): omitir ambos

📋 Payload (multipart/form-data)¶

Campos adicionais para Fiador — Pessoa Jurídica¶

Campos adicionais para Fiador — Pessoa Física¶

🧪 Exemplo de cURL — Cessão Fiduciária¶

curl -X POST https://api.vehub.com.br/public/v1/nota-comercial/100/garantias \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -F "idTipoGarantia=1" \
  -F "descricao=Cessão fiduciária de recebíveis de cartão" \
  -F "arquivo=@/caminho/para/cessao.pdf"

📥 Response — 201 Created¶

{
  "mensagem": "Garantia adicionada com sucesso.",
  "id": 5
}

Excluir Garantia¶

🔗 Endpoint¶

Método	URL
	/public/v1/nota-comercial/{id}/garantias/{idGarantia}

🔹 Path Parameters¶

📥 Response — 200 OK¶

{
  "mensagem": "Garantia removida com sucesso."
}

❌ Erros Comuns¶

400 Bad Request¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'idTipoGarantia' é obrigatório.",
    "A Nota Comercial não está em status que permita alteração de garantias."
  ]
}