v1

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

Ajustar número de parcelas de uma recorrência (estender ou reduzir)

Permite ajustar o número total de parcelas de uma recorrência existente, estendendo (criando novas parcelas futuras) ou reduzindo (removendo parcelas futuras).

Estender recorrência (aumentar parcelas):

  • Informe um valor de NovoNumeroDeParcelas maior que o número atual.
  • O sistema cria novas parcelas futuras automaticamente, mantendo o padrão da recorrência (tipo, intervalo, competência).
  • Exemplo: Recorrência de 6 parcelas → ajustar para 10 parcelas = cria 4 novas parcelas futuras.

Reduzir recorrência (diminuir parcelas):

  • Informe um valor de NovoNumeroDeParcelas menor que o número atual.
  • O sistema remove parcelas futuras (DataVencimento > hoje), mesmo se estiverem marcadas como pagas.
  • Exemplo: Recorrência de 12 parcelas → ajustar para 8 parcelas = remove as 4 últimas parcelas, independente do status do pagamento.

Limites:

  • Mensalmente: Máximo 12 parcelas
  • Quinzenalmente: Máximo 24 parcelas
  • Semanalmente: Máximo 52 parcelas
  • Duração total: Não pode ultrapassar 365 dias
  • Mínimo: 2 parcelas (recorrências com menos de 2 parcelas não fazem sentido)

Validações:

  • NovoNumeroDeParcelas deve respeitar os limites do tipo de recorrência.
patch/v1/lancamentos/recorrencias/{recorrenciaId}/ajustarparcelas

Path parameters

recorrenciaIdinteger required

Headers

estabelecimentoIdstring required

Request body

novoNumeroDeParcelasinteger required

Novo numero de parcelas (Mensalmente: até 12, Quinzenalmente: até 24, Semanalmente: até 52). A duracao total nao pode ultrapassar 365 dias.

Response

No Content