Este endpoint permite remover um parcelamento existente quando ele ainda atende às regras necessárias para exclusão.

A remoção pode ser utilizada quando um parcelamento foi criado por engano ou quando não deve mais permanecer disponível para pagamento antes que sua liquidação seja iniciada.

Regras para remoção

A remoção somente é permitida para parcelamentos que:

• possuem cobranças com status aguardando pagamento ou vencidas;
• não possuem processo de antecipação em andamento;
• não possuem processo de negativação associado.

Caso qualquer uma dessas condições não seja atendida, a solicitação será recusada.

Parâmetro utilizado

Este endpoint recebe o identificador único (id) do parcelamento que será removido.

Certifique-se de utilizar o identificador correto, pois a operação é aplicada diretamente ao parcelamento informado.

Funcionamento da remoção

Quando a remoção é concluída com sucesso, o parcelamento deixa de existir e não poderá mais ser utilizado nas operações da API ou consultado como um parcelamento ativo.

Essa operação é definitiva e não existe um endpoint para restaurar um parcelamento removido.

Boas práticas

Antes de solicitar a remoção, recomenda-se:

• consultar o parcelamento para confirmar seu estado atual;
• verificar se não existe processo de antecipação vinculado;
• verificar se não existe processo de negativação em andamento;
• confirmar que a exclusão realmente é necessária, já que a operação é irreversível.

Essas validações ajudam a evitar tentativas recusadas e exclusões indevidas.

Exemplo de cenário

Um cenário comum é a criação de um parcelamento incorreto por uma integração, antes que qualquer processo operacional relacionado seja iniciado.

Nessa situação, a aplicação pode remover o parcelamento e, se necessário, criar um novo com as informações corretas.

Impacto operacional

A remoção do parcelamento pode impactar processos internos da aplicação que armazenam referências para esse recurso.

Após a exclusão, recomenda-se atualizar o estado do parcelamento no sistema de origem para evitar tentativas de consulta ou operação sobre um recurso que não existe mais.

Como a operação é definitiva, ela deve ser utilizada com cautela em ambientes de produção.

Conteúdos relacionados

Caso sua integração utilize outros recursos relacionados ao ciclo de vida do parcelamento, consulte também:

• Consulta de parcelamentos;
• Criação de parcelamentos;
• Antecipação de recebíveis;
• Negativação de cobranças.