v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

Antecipação de Recebíveis

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>contaOrigem</td><td>Texto</td><td>Conta da qual se origina o pagamento com o digito verificador.</td><td>Sim</td></tr><tr><td>assignorUuid</td><td>Texto</td><td>Convênio ID</td><td>Sim</td></tr><tr><td>page</td><td>Numérico</td><td>Página</td><td>Não</td></tr><tr><td>orderingField</td><td>Texto</td><td>Ordenação, podendo ser: 'id', 'numeroOperacaoNSU', 'parcela', 'dataTransacao', 'dataVencimentoTransacao'.</td><td>Não</td></tr><tr><td>orderingDirection</td><td>Texto</td><td>Ordenação, podendo ser: 'ASC', 'DESC'</td><td>Não</td></tr><tr><td>dueDateDtart</td><td>Texto</td><td>Filtro por data: YYYY-MM-DD</td><td>Não</td></tr><tr><td>dueDateFinish</td><td>Texto</td><td>Filtro por data: YYYY-MM-DD</td><td>Não</td></tr><tr><td>cpfcnpjSacado</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>page</td><td>Numérico</td><td>Página atual</td></tr><tr><td>pages</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>per_page</td><td>Numérico</td><td>Total de itens por página.</td></tr><tr><td>eligible</td><td>Lista</td><td>Lista de itens elegíveis</td></tr></tbody></table>

get/api/v1/credit/anticipation/receivables

Query parameters

contaOrigemstring required

Example:0000000000

cpfOperadorstring required

Example:00000000000

assignorUuidstring required

Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

pagestring

Example:1

orderingFieldstring

Example:dataVencimentoTransacao

orderingDirectionstring

Example:ASC

dueDateStartstring

Example:2025-10-22

dueDateFinishstring

Example:2025-10-23

cpfcnpjSacadostring

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": {
    "eligible": [
      {
        "identification": "ca8700be-31a8-f011-8e62-000d3a88ee99",
        "type": "Titulo",
        "operation_number": "ca8700be-31a8-f011-8e62-000d3a88ee99",
        "due_date": "02/11/2025",
        "anticipation_value": "4759.82",
        "net_value": "4802.08",
        "transaction_value": "4802.08",
        "status": "Elegivel",
        "assignor_name": "Renato",
        "intern_receivable_type": "Boleto Hibrido",
        "intern_settlement_status": "null",
        "financial_movement_number": "null"
      }
    ]
  }
}