Ir para o conteúdo

2.2. Vincular Duplicatas na Simulação

🔗 Endpoint

Método URL
POST /public/api/v1/duplicata-escritural/simulacoes/{identificadorSimulacao}/vincular

🧾 Descrição

Vincula duplicatas específicas a uma simulação existente, selecionando-as para a operação de contratação. Apenas as duplicatas vinculadas serão consideradas ao criar o contrato a partir desta simulação.


🧾 Parâmetros de URL

Parâmetro Tipo Local Obrigatório Descrição
identificadorSimulacao string Path Sim GUID da simulação

📤 Requisição

📋 Payload (JSON)

{
  "identificadoresDuplicatas": [
    "7D121577-3C5A-494D-B052-291D9E100D0D",
    "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
  ]
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
identificadoresDuplicatas string[] Sim Lista de GUIDs das duplicatas a vincular na simulação

🧪 Exemplo de cURL

curl -X POST https://api.vehub.com.br/public/api/v1/duplicata-escritural/simulacoes/534D8AAE-61E4-4264-9D15-715B9E1F1D51/vincular \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "identificadoresDuplicatas": [
      "7D121577-3C5A-494D-B052-291D9E100D0D",
      "A1B2C3D4-E5F6-7890-ABCD-EF1234567890"
    ]
  }'

📥 Responses

✅ 200 OK

{
  "mensagem": "Duplicatas vinculadas à simulação com sucesso!",
  "identificador": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
  "identificadorProcessamento": null
}

✅ 202 Accepted

{
  "mensagem": "Vínculo de duplicatas recebido e será processado 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": [
    "Simulação não encontrada.",
    "Uma ou mais duplicatas informadas não pertencem a esta simulação."
  ]
}

🕒 Observações

  • Os GUIDs das duplicatas devem ser os identificadorExterno retornados pela consulta da simulação (7.2. Consultar Simulação).
  • Após vincular as duplicatas, use 3.1. Criar Contrato para efetivar a operação.
  • Quando o retorno for 202 Accepted, o processamento ocorrerá de forma assíncrona.