Sign in

v1

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

Criar lançamento (simples ou recorrente)

Cria um novo lançamento financeiro (receita ou despesa), com suporte a lançamentos recorrentes.

Lançamento simples:

  • Preencha os campos obrigatórios: Categoria, DataVencimento, Valor, StatusPagamento.
  • Omita o objeto "Recorrencia" no request.

Lançamento recorrente: Informe o objeto "Recorrencia" com:

  • TipoRecorrencia (obrigatório):
    • 1 = Mensalmente (máximo 12 parcelas)
    • 2 = Quinzenalmente (máximo 24 parcelas)
    • 3 = Semanalmente (máximo 52 parcelas)
  • NumeroDeParcelas (obrigatório): Mínimo 2, máximo conforme tipo. Duração total não pode ultrapassar 365 dias.
  • FormaDeAplicarCompetencia (obrigatório): Define como a data de competência é aplicada nas parcelas (1, 2 ou 3).
  • ConsiderarRecorrenciaPagaNaDataVencimento (obrigatório): Se true, todas as parcelas são automaticamente marcadas como pagas na data de vencimento (requer FormaPagamentoId).
post/v1/lancamentos

Headers

estabelecimentoIdstring required

Request body

categoriainteger required
dataPagamentostring date-time nullable
dataVencimentostring date-time required
dataCompetenciastring date-time nullable
descricaostring nullable
valornumber double required
statusPagamentointeger required

1 = Pago, 2 = Não Pago

profissionalOuFornecedorDocumentostring nullable
formaPagamentoIdinteger nullable

Response

Created

idinteger
tipointeger
tipoNomestring nullable
categoriainteger
categoriaNomestring nullable
grupointeger
grupoNomestring nullable
dataPagamentostring date-time nullable
dataVencimentostring date-time
dataCompetenciastring date-time nullable
descricaostring nullable
valornumber double
statusPagamentointeger
statusPagamentoNomestring nullable
profissionalOuFornecedorDocumentostring nullable
profissionalOuFornecedorNomestring nullable
formaPagamentoIdinteger nullable
formaPagamentoNomestring nullable
dataCriacaostring date-time
dataAtualizacaostring date-time
ativoboolean