v1

latestOpenAPI 3.0.12026-08-046010593.8 KB
Financeiro > Lançamentos

Inativar lançamento (simples ou recorrente)

Marca um lançamento financeiro como inativo (soft delete). O lançamento não é removido permanentemente do banco de dados e pode ser consultado usando o filtro apenasAtivos=false.

Inativação de lançamento simples:

  • Omita o request body ou envie InativarEsteERecorrentesFuturos=false.
  • Inativa apenas o lançamento especificado.

Inativação de lançamento recorrente (operação em lote): Envie no request body:

  • InativarEsteERecorrentesFuturos (opcional):
    • true: Inativa o lançamento atual e todas as parcelas futuras da recorrência (DataVencimento >= data do lançamento atual).
    • false ou omitido: Inativa apenas o lançamento atual.

Validações:

  • Lançamentos já inativos não podem ser inativados novamente.
  • Apenas categorias que permitem exclusão podem ser inativadas.
  • Se o lançamento não pertence a uma recorrência e você informar InativarEsteERecorrentesFuturos=true, a validação retornará erro.
patch/v1/lancamentos/{lancamentoId}/inativar

Path parameters

lancamentoIdinteger required

Headers

estabelecimentoIdstring required

Request body

inativarEsteERecorrentesFuturosboolean nullable

Response

No Content