Ir para o conteúdo

5.5. Listar Minutas

🔗 Endpoint

Método URL
GET /public/v1/nota-comercial/{id}/minutas/disponiveis

🧾 Descrição

Retorna a lista de minutas (modelos de contrato) disponíveis para seleção em uma Nota Comercial específica. As minutas são filtradas com base no financiador vinculado àquela NC, garantindo que apenas os modelos compatíveis com a operação sejam exibidos.

Cada minuta representa um modelo de documento que será utilizado na escrituração.

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único da NC

🧪 Exemplo de cURL

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

📥 Responses

✅ 200 OK

[
  {
    "id": 1,
    "nome": "Minuta Padrão — Nota Comercial"
  },
  {
    "id": 2,
    "nome": "Minuta com Garantia Real"
  }
]
Campo Tipo Descrição
id integer Identificador da minuta
nome string Nome descritivo da minuta

Vincular Minuta à NC

🔗 Endpoint

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

🧾 Descrição

Vincula uma ou mais minutas a uma Nota Comercial existente. A NC deve estar com status Em Digitação para aceitar minutas.

🔹 Path Parameter

Parâmetro Tipo Descrição
id integer Identificador único da NC

📋 Payload (JSON)

{
  "documentos": [
    {
      "idTipoDocumento": 1,
      "idEmpresaDocumento": 10
    }
  ]
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
documentos array Sim Lista de documentos/minutas a vincular
documentos[].idTipoDocumento integer Sim ID do tipo de documento (retornado em /minutas)
documentos[].idEmpresaDocumento integer Sim ID do documento da empresa ao qual a minuta será associada

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/v1/nota-comercial/100/minutas \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "documentos": [
      { "idTipoDocumento": 1, "idEmpresaDocumento": 10 }
    ]
  }'

📥 Response — 200 OK

{
  "mensagem": "Minuta(s) vinculada(s) com sucesso."
}

❌ Erros Comuns

400 Bad Request

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