Ir para o conteúdo

8.7. Consultar Execuções do Ciclo

Histórico paginado dos ciclos de antecipação automática de um cedente.

É por aqui que se descobre por que um determinado dia não gerou contrato — e de onde veio a agenda que originou os contratos que foram gerados.

O ciclo rodar e não contratar é um desfecho normal

Agenda vazia, total abaixo do valor mínimo configurado, nenhuma UR elegível: em todos esses casos o ciclo executa, não gera contrato e registra o motivo. Não é erro. O campo motivoNaoContratacao diz qual foi o caso.

Consultar Execuções do Ciclo

Método URL
GET https://BASE_URL/public/api/v1/cedentes/{idEmpresa}/antecipacao-automatica/execucoes

Path Params

Campo Tipo Descrição
idEmpresa Número Identificador da empresa cedente.

🔍 Filtros (query string)

Parâmetro Tipo Obrigatório Descrição
idOperacao Número Não Filtra uma operação.
dataInicial Texto Não Considera ciclos a partir desta data, no formato YYYY-MM-DD.
dataFinal Texto Não Considera ciclos até esta data, no formato YYYY-MM-DD.
status Número Não Filtra pelo desfecho do ciclo. Ver 8.8.
origemAgenda Número Não Filtra pela origem da agenda. Ver 8.8.

📄 Paginação

Parâmetro Tipo Obrigatório Padrão Descrição
indicePagina Número Não 1 Página desejada do resultado.
tamanhoDaPagina Número Não 20 Quantidade de registros por página. Máximo de 100.
Response Body — 200 OK
{
  "registros": [
    {
      "data": "2026-09-22",
      "idOperacao": 1,
      "origemAgenda": 1,
      "status": 2,
      "identificadorContrato": "534D8AAE-61E4-4264-9D15-715B9E1F1D51",
      "valorContratado": 18422.15,
      "taxaAplicada": 1.9900,
      "quantidadeUrs": 37,
      "motivoNaoContratacao": null
    },
    {
      "data": "2026-09-19",
      "idOperacao": 1,
      "origemAgenda": 2,
      "status": 3,
      "identificadorContrato": null,
      "valorContratado": null,
      "taxaAplicada": null,
      "quantidadeUrs": 0,
      "motivoNaoContratacao": 2
    }
  ],
  "paginacao": {
    "paginaAtual": 1,
    "paginaTotal": 1,
    "paginaQuantidadeRegistro": 2,
    "quantidadeRegistros": 2,
    "temPaginaAnterior": false,
    "temProximaPagina": false
  },
  "mensagem": "Execuções listadas com sucesso!"
}

Detalhamento dos Campos

🔹 registros

Campo Tipo Descrição
data Texto Data do ciclo, no formato YYYY-MM-DD.
idOperacao Número Operação em que o ciclo rodou.
origemAgenda Número 1 agenda BATCH, 2 agenda ONLINE. Ver 8.8.
status Número Desfecho do ciclo. Ver 8.8.
identificadorContrato Texto GUID do contrato gerado. null quando não houve contrato. Use-o nos endpoints de contrato da API de recebíveis de cartão.
valorContratado Decimal Valor efetivamente contratado. null quando não houve contrato.
taxaAplicada Decimal Deságio aplicado no contrato. null quando não houve contrato.
quantidadeUrs Número Quantidade de unidades de recebíveis cedidas no contrato.
motivoNaoContratacao Número Por que não houve contrato. null quando houve. Ver 8.8.

🔹 paginacao

Campo Tipo Descrição
paginaAtual Número Página retornada nesta resposta.
paginaTotal Número Total de páginas disponíveis com os filtros informados.
paginaQuantidadeRegistro Número Quantidade de registros nesta página.
quantidadeRegistros Número Total de registros que atendem aos filtros.
temPaginaAnterior Booleano Indica se existe página anterior.
temProximaPagina Booleano Indica se existe próxima página.

Do ciclo ao contrato

Com o identificadorContrato em mãos, consulte os detalhes e as URs em Detalhes do contrato. Para listar todos os contratos do cedente de uma vez, inclusive os que não vieram do ciclo automático, use Listar contratos. O mesmo identificador chega em contrato.identificador no webhook de contratos — é por ele que se cruza a notificação com a execução que a originou.

Erros

Status Quando acontece
400 Parâmetro de paginação fora do intervalo permitido.
401 Token ausente, expirado ou sem permissão de acesso à API pública.
403 Grupo econômico não habilitado para antecipação automática.
404 Cedente não encontrado.