--- title: 3.3. Consultar Contrato url: https://docs.vehub.com.br/API/VeFlow%20-%20Duplicata%20Escritural/3.%20Contratos/v1/3.3.%20Consultar%20Contrato/ --- # 3.3. Consultar Contrato ## 🔗 Endpoint | Método | URL | |------------------------------------------------------|-----| | ![GET](https://img.shields.io/badge/GET-brightgreen) | `/public/api/v1/duplicata-escritural/contratos/{identificadorContrato}` | --- ## 🧾 Descrição Consulta os detalhes de um contrato de duplicata escritural previamente criado. Retorna os dados do contrato, totais financeiros e a lista paginada de duplicatas vinculadas. --- ## 🧾 Parâmetros | Parâmetro | Tipo | Local | Obrigatório | Descrição | |------------------------|---------|-------|-------------|-----------| | identificadorContrato | string | Path | Sim | GUID do contrato a ser consultado | | indicePagina | integer | Query | Não | Índice da página (padrão: 1) | | tamanhoDaPagina | integer | Query | Não | Quantidade de registros por página (padrão: 10) | --- ## 🧪 Exemplo de cURL ```bash curl -X GET "https://api.vehub.com.br/public/api/v1/duplicata-escritural/contratos/5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6?indicePagina=1&tamanhoDaPagina=10" \ -H "Authorization: Bearer {seu_token}" \ -H "GrupoEconomico: {seu_grupo_economico}" \ ``` --- ## 📥 Response ### ✅ 200 OK ```json { "identificador": "5174568D-9FFE-4C10-9FC2-B0F4E7F8D1B6", "contrato": { "identificadorInteroperabilidade": ["A1B2C3D4-E5F6-7890-ABCD-EF1234567890"], "dataAssinatura": "2025-09-10", "dataVencimento": "2025-12-10", "cnpj": "12345678000199", "status": 1 }, "totais": { "taxa": 1.25, "nominal": 50000.00, "desconto": 625.00, "aquisicao": 49375.00 }, "duplicatas": { "registros": [ { "identificador": "7D121577-3C5A-494D-B052-291D9E100D0D", "dataVencimento": "2025-10-15", "valorNominal": 5000.00, "valorDesconto": 62.50, "valorAquisicao": 4937.50 } ], "paginacao": { "paginaAtual": 1, "paginaTotal": 1, "paginaQuantidadeRegistro": 10, "quantidadeRegistros": 1, "temPaginaAnterior": false, "temProximaPagina": false }, "mensagem": null } } ``` --- ## 🧾 Detalhamento dos Campos ### 🔹 contrato | Campo | Tipo | Descrição | |---------------------------------|----------|-----------| | identificadorInteroperabilidade | string[] | GUIDs de interoperabilidade entre registradoras | | dataAssinatura | string | Data de assinatura do contrato (YYYY-MM-DD) | | dataVencimento | string | Data de vencimento do contrato (YYYY-MM-DD) | | cnpj | string | CNPJ do cedente | | status | integer | Status atual do contrato (ver tabela abaixo) | ### 🔢 StatusContrato | Código | Significado | |--------|-------------| | 1 | Ativo | | 2 | Erro | | 3 | Em Processamento | | 4 | Baixado | --- ### 🔹 totais | Campo | Tipo | Descrição | |-----------|--------|-----------| | taxa | number | Taxa aplicada na operação | | nominal | number | Valor total nominal das duplicatas | | desconto | number | Soma dos deságios aplicados | | aquisicao | number | Valor líquido a ser recebido | --- ### 🔹 duplicatas.registros | Campo | Tipo | Descrição | |----------------|--------|-----------| | identificador | string | GUID da duplicata | | dataVencimento | string | Data de vencimento da duplicata (YYYY-MM-DD) | | valorNominal | number | Valor nominal da duplicata | | valorDesconto | number | Valor do deságio aplicado | | valorAquisicao | number | Valor líquido após desconto | --- ### 🔹 duplicatas.paginacao | Campo | Tipo | Descrição | |--------------------------|---------|-----------| | paginaAtual | integer | Número da página atual | | paginaTotal | integer | Total de páginas disponíveis | | paginaQuantidadeRegistro | integer | Tamanho da página configurado | | quantidadeRegistros | integer | Total de registros encontrados | | temPaginaAnterior | boolean | Indica se existe página anterior | | temProximaPagina | boolean | Indica se existe próxima página | --- ## 🕒 Observações - Use os parâmetros `indicePagina` e `tamanhoDaPagina` para navegar pelas duplicatas do contrato. - O campo `status` do contrato indica a situação atual do contrato no ciclo de vida da duplicata escritural.