Antecipação de Recebíveis - Proposta

Geração de Propostas

Antecipação de Recebíveis - Geração de Propostas.<br/>Permite que seja criado propostas de antecipações de recebíveis.<br/><br/>Funcionalidades do Endpoint:<br/>- Proposta: Gera propostas com base em recebíveis selecionados.<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>cpfOperador</td><td>Texto</td><td>CPF do recebedor</td><td>Sim</td></tr><tr><td>recebiveis</td><td>Lista</td><td>Lista de recebíveis, ex: [12555-1, 13555-1]. Valor capturado no retorno do endpoint 'GET /api/v1/credito/antecipacao/recebiveis', coluna Identificacao.</td><td>Sim</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>nome_convenio</td><td>Texto</td><td>Nome</td></tr><tr><td>uuid</td><td>Texto</td><td>Identificador</td></tr><tr><td>convenio_id</td><td>Texto</td><td>Convênio</td></tr><tr><td>status</td><td>Texto</td><td>Status</td></tr><tr><td>tipo</td><td>Numérico</td><td>Tipo</td></tr><tr><td>tem_boleto</td><td>Boolean</td><td>Se tem Boleto habilitado</td></tr><tr><td>tem_pix</td><td>Boolean</td><td>Se tem Pix habilitado</td></tr><tr><td>tem_cartao</td><td>Boolean</td><td>Se tem Cartão de Crédito habilitado</td></tr><tr><td>taxa</td><td>Numérico</td><td>Taxa</td></tr><tr><td>valor_cobranca</td><td>Numérico</td><td>Valor da Cobrança</td></tr><tr><td>total_antecipacao</td><td>Numérico</td><td>Total de Antecipação</td></tr><tr><td>total_liberado</td><td>Numérico</td><td>Total Liberado</td></tr><tr><td>total_recebiveis</td><td>Numérico</td><td>Total de 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>Criado por</td></tr><tr><td>data_criacao</td><td>Texto</td><td>Data de Criação</td></tr><tr><td>data_expiracao</td><td>Texto</td><td>Data de Expiração</td></tr><tr><td>data_aceite</td><td>Texto</td><td>Data de Aceite</td></tr><tr><td>data_cancelamento</td><td>Texto</td><td>Data de Cancelamento</td></tr></tbody></table>

post/api/v1/credito/antecipacao/proposta

Request

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

Headers

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

Client ID enviado no Header

Request body

cpfOperadorstring
recebiveisstring[]

Example request

{
  "cpfOperador": "00000000000",
  "recebiveis": [
    "01835704-bdc2-48a7-ae4d-0cdc85a402a8-1"
  ]
}

Response

Proposta enviada com sucesso.

messagestring

Example response

{
  "message": "Proposta enviada 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.