Ir para o conteúdo

8.3. Desabilitar Antecipação Automática

Desliga o ciclo de antecipação automática de um cedente em uma operação.

Desabilitar não apaga nada

O cedente, o vínculo com a operação, a taxa e os valores configurados permanecem. Também permanece a configuração de pesquisa automática comum, se houver. O que para é apenas a geração automática de contratos: nenhum ciclo novo será executado para esse par cedente × operação.

Contratos já gerados seguem seu curso

Desabilitar não cancela contratos existentes, nem interrompe a atualização diária das URs já contratadas. Para cancelar um contrato, use Cancelar contrato.


Desabilitar Antecipação Automática

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

Path Params

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

Request Body

Campo Tipo Obrigatório Descrição
idOperacao Número Sim Operação em que o ciclo será desligado.
Request Body
{
  "idOperacao": 1
}
Response Body — 200 OK
{
  "idEmpresa": 4821,
  "idOperacao": 1,
  "habilitada": false,
  "desabilitadaEm": "2026-09-22T12:03:11Z"
}

Detalhamento da resposta

Campo Tipo Descrição
idEmpresa Número Identificador da empresa cedente.
idOperacao Número Operação afetada.
habilitada Booleano Sempre false após a operação.
desabilitadaEm Texto Data e hora UTC em que o ciclo foi desligado, no formato ISO 8601.

É idempotente

Desabilitar um ciclo que já estava desabilitado retorna 200 normalmente, com habilitada: false. A chamada pode ser repetida sem efeito colateral.

Erros

Status Quando acontece
400 idOperacao ausente ou inválido.
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 ou operação não encontrados, ou sem vínculo entre eles.