Antecipação de Recebíveis - Proposta

Consulta as propostas criadas.

Propostas - Consulta as propostas criadas para a conta.<br/>Permite que seja listado as propostas.<br/><br/>Funcionalidades do Endpoint:<br/>- Propostas: Lista as propostas de antecipação.<br/><br/>Possíveis status do recebível:<br/>        ° PropostaCriada - Proposta Criada<br/>        ° TermoGerado - Termo Gerado<br/>        ° PropostaEfetivada - Proposta Efetivada<br/>        ° FinanceiroLiberado - Financeiro Liberado<br/>        ° PropostaCancelada - Proposta Cancelada<br/>        ° PropostaExpirada - Proposta Expirada<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>status</td><td>Texto</td><td>Filtro por status, sendo eles: PropostaCriada, TermoGerado, PropostaEfetivada, FinanceiroLiberado, PropostaCancelada e PropostaExpirada </td><td>Não</td></tr></tbody></table><br><br><strong>Resposta</strong><br><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>nome_convenio</td><td>Texto</td><td>Nome do Convênio</td></tr><tr><td>uuid</td><td>Texto</td><td>UUID da Proposta</td></tr><tr><td>convenio_id</td><td>Texto</td><td>Identificador do Convênio</td></tr><tr><td>status</td><td>Texto</td><td>Status da Proposta</td></tr><tr><td>tipo</td><td>Inteiro</td><td>Tipo da Operação</td></tr><tr><td>tem_boleto</td><td>Booleano</td><td>Indica se possui boleto</td></tr><tr><td>tem_pix</td><td>Booleano</td><td>Indica se possui Pix</td></tr><tr><td>tem_cartao</td><td>Booleano</td><td>Indica se possui cartão</td></tr><tr><td>taxa</td><td>Decimal</td><td>Taxa aplicada à operação</td></tr><tr><td>valor_cobranca</td><td>Decimal</td><td>Valor da cobrança</td></tr><tr><td>total_antecipacao</td><td>Decimal</td><td>Valor total da antecipação</td></tr><tr><td>total_liberado</td><td>Decimal</td><td>Valor total liberado</td></tr><tr><td>total_recebiveis</td><td>Decimal</td><td>Valor total dos recebíveis</td></tr><tr><td>numero_operacao</td><td>Texto</td><td>Número da operação</td></tr><tr><td>criado_por</td><td>Texto</td><td>Usuário responsável pela criação</td></tr><tr><td>data_criacao</td><td>Texto</td><td>Data de criação do registro</td></tr><tr><td>data_expiracao</td><td>Texto</td><td>Data de expiração da proposta</td></tr><tr><td>data_aceite</td><td>Texto</td><td>Data de aceite da proposta</td></tr><tr><td>data_cancelamento</td><td>Texto</td><td>Data de cancelamento da proposta</td></tr></tbody></table>

get/api/v1/credito/antecipacao/propostas

Request

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

Query parameters

statusstring
Example:anticipation_created

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Response

Propostas filtradas com sucesso.

messagestring

Example response

{
  "message": "Propostas filtradas com sucesso.",
  "data": [
    {
      "nome_convenio": "Pay",
      "uuid": "7964a0b1-fc2e-4721-96cd-195ce94c29b",
      "convenio_id": "7964a0b1-fc2e-4721-96cd-195ce94c29b1",
      "status": "PropostaCriada",
      "criado_por": "Jhon",
      "data_criacao": "2025-10-01 11:39:14",
      "data_expiracao": "2025-10-01 11:39:14",
      "data_aceite": "2025-10-01 11:39:14",
      "data_cancelamento": "2025-10-01 11:39:14"
    }
  ]
}

Changes

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