Antecipação de Recebíveis - Proposta

Consulta os recebíveis passiveis de antecipação.

Recebíveis - Consulta os recebíveis passiveis de antecipação.<br/>Permite que seja listado os recebíveis elegíveis.<br/><br/>Funcionalidades do Endpoint:<br/>- Recebíveis: Lista os recebíveis para antecipação.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>client-id</td><td>Texto</td><td>Cliente ID</td><td>Sim</td></tr><tr><td>cpfOperador</td><td>Texto</td><td>CPF do recebedor</td><td>Sim</td></tr><tr><td>convenio_id</td><td>Texto</td><td>Convênio ID</td><td>Sim</td></tr><tr><td>pagina</td><td>Numérico</td><td>Página</td><td>Não</td></tr><tr><td>ordenacao</td><td>Texto</td><td>Ordenação, podendo ser: 'id', 'numeroOperacaoNSU', 'parcela', 'dataTransacao', 'dataVencimentoTransacao' e como padrão dataVencimentoTransacao ASC.</td><td>Não</td></tr><tr><td>direcao_ordenacao</td><td>Texto</td><td>Ordenação, podendo ser: 'ASC', 'DESC'</td><td>Não</td></tr><tr><td>data_vencimento_inicio</td><td>Texto</td><td>Filtro por data: YYYY-MM-DD</td><td>Não</td></tr><tr><td>data_vencimento_final</td><td>Texto</td><td>Filtro por data: YYYY-MM-DD</td><td>Não</td></tr><tr><td>cpf_cnpj_sacado</td><td>Texto</td><td>CPF/CNPJ Sacado 00000000000</td><td>Não</td></tr></tbody></table><br/><br/>Resposta<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>pagina</td><td>Numérico</td><td>Página atual</td></tr><tr><td>paginas</td><td>Numérico</td><td>Total de Páginas</td></tr><tr><td>total</td><td>Numérico</td><td>Total de itens</td></tr><tr><td>por_pagina</td><td>Numérico</td><td>Total de itens por página.</td></tr><tr><td>elegiveis</td><td>Lista</td><td>Lista de itens elegíveis</td></tr></tbody></table>

get/api/v1/credito/antecipacao/recebiveis

Request

Base URL
https://api-clientes.meuk8.com.br
URL
https://api-clientes.meuk8.com.br/api/v1/credito/antecipacao/recebiveis
Auth
HTTP bearer

Query parameters

cpfOperadorstring required

Example:00000000000

convenio_idstring required

Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

paginastring

Example:1

ordenacaostring

Example:dataVencimentoTransacao

direcao_ordenacaostring

Example:ASC

data_vencimento_iniciostring

Example:2025-10-22

data_vencimento_finalstring

Example:2025-10-23

cpf_cnpj_sacadostring

Example:00000000000

Headers

client-idstring uuid required

Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Consulta retornada com sucesso.

messagestring

Example response

{
  "message": "Consulta retornada com sucesso.",
  "data": {
    "elegiveis": [
      {
        "identificacao": "ca8700be-31a8-f011-8e62-000d3a88ee99",
        "tipo": "Titulo",
        "operacao": "ca8700be-31a8-f011-8e62-000d3a88ee99",
        "data_vencimento": "02/11/2025",
        "valor_antecipacao": "4759.82",
        "valor": "4802.08",
        "pagador": "Renato"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.