Ir para o conteúdo

8.4. Consultar Configuração Vigente

Retorna a configuração de antecipação automática de um cedente, por operação, junto com o resultado do último ciclo executado.

Use este endpoint para conferir o que está valendo antes de alterar qualquer coisa, e para descobrir rapidamente se o ciclo do dia rodou e o que ele produziu.

Consultar Configuração Vigente

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

Path Params

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

Query Params

Campo Tipo Obrigatório Descrição
idOperacao Número Não Filtra uma operação. Omitido, retorna todas as operações vinculadas ao cedente.
Response Body — 200 OK
{
  "idEmpresa": 4821,
  "documento": "12345678000195",
  "operacoes": [
    {
      "idOperacao": 1,
      "habilitada": true,
      "taxa": 1.9900,
      "valorMinimo": 500.00,
      "valorMaximo": 250000.00,
      "percentualMaximoValorLivre": 80.00,
      "arranjos": ["MCC", "VCC"],
      "credenciadoras": [
        { "id": 12, "nome": "CREDENCIADORA EXEMPLO", "cnpj": "10293847560110" }
      ],
      "horarioCiclo": "09:00",
      "limitesOperacao": {
        "percentualMaximoValorLivre": 100.00,
        "percentualMaximoValorConstituido": 90.00
      },
      "ultimaExecucao": {
        "data": "2026-09-22T12:01:44Z",
        "origemAgenda": 1,
        "status": 2,
        "valorContratado": 18422.15,
        "motivoNaoContratacao": null
      }
    }
  ]
}

Detalhamento dos Campos

🔹 operacoes

Campo Tipo Descrição
idOperacao Número Identificador da operação.
habilitada Booleano Indica se o ciclo automático está ativo para este par cedente × operação.
taxa Decimal Deságio do vínculo. null quando ainda não foi definida — nesse caso o cedente não é elegível ao ciclo.
valorMinimo Decimal Piso por ciclo configurado no vínculo. null significa sem piso.
valorMaximo Decimal Teto por ciclo configurado no vínculo. null significa sem teto.
percentualMaximoValorLivre Decimal Limite próprio do vínculo para o percentual do valor livre de cada UR. null significa sem limite próprio — vale só o da operação.
arranjos Lista Siglas dos arranjos considerados. Lista vazia significa todos. A seleção é do cedente e vale para todas as operações dele.
credenciadoras Lista Credenciadoras consideradas, com id, nome e cnpj. Lista vazia significa todas as habilitadas na operação. A seleção é do cedente e vale para todas as operações dele.
horarioCiclo Texto Horário em que o ciclo roda, no formato HH:mm. Definido na operação, não editável por esta API. null quando a operação não tem horário.
limitesOperacao Objeto Limites da operação, só para leitura. Ver limitesOperacao.
ultimaExecucao Objeto Resultado do último ciclo. null quando nenhum ciclo rodou ainda.

🔹 limitesOperacao

Definidos na operação pelo time de implantação; não são editáveis por esta API. 100 significa sem limite.

Campo Tipo Descrição
percentualMaximoValorLivre Decimal Percentual máximo do valor livre de cada UR que o ciclo pode tomar na operação. O ciclo aplica o menor entre este e o percentualMaximoValorLivre do vínculo.
percentualMaximoValorConstituido Decimal Percentual máximo do valor constituído da UR.

🔹 ultimaExecucao

Campo Tipo Descrição
data Texto Data e hora UTC do ciclo, no formato ISO 8601.
origemAgenda Número De onde veio a agenda usada. Ver 8.8. Status e Enumerações.
status Número Desfecho do ciclo. Ver 8.8. Status e Enumerações.
valorContratado Decimal Valor efetivamente contratado. null quando o ciclo não gerou contrato.
motivoNaoContratacao Número Por que não houve contrato. null quando houve. Ver 8.8.

Para o histórico completo, não só o último ciclo

ultimaExecucao mostra apenas o ciclo mais recente. O histórico paginado, com filtros por data e status, está em 8.7. Consultar Execuções do Ciclo.

Erros

Status Quando acontece
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, ou operação informada sem vínculo com ele.