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, StatusPagamento.
  • Com StatusPagamento = 1 (pago), DataPagamento, FormaPagamentoId e Valor maior que zero também são obrigatórios.
  • ProfissionalOuFornecedorDocumento é obrigatório quando a categoria exige profissional ou fornecedor.
  • Só a data é considerada nos campos de data; a hora é descartada.
  • 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 (opcional, padrão false): Se true, todas as parcelas são automaticamente marcadas como pagas na data de vencimento (requer FormaPagamentoId e não aceita DataPagamento).
  • Sem ConsiderarRecorrenciaPagaNaDataVencimento, só a primeira parcela pode nascer paga (quando DataPagamento é enviada); as demais nascem não pagas.

A resposta traz a primeira parcela criada. O formaPagamentoId da resposta é o id da forma de pagamento base
do Trinks, diferente do id de GET /v1/formaspagamentos enviado no request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

O id de GET /v1/lancamentos/categorias. Define se o lançamento é receita ou despesa

date-time | null

Obrigatória quando StatusPagamento = 1. Só a data é usada

date-time
required

A partir de 01/01/2010. Só a data é usada

date-time | null

Omitida, assume a DataVencimento

string | null
double
required

Em reais. Maior que zero quando StatusPagamento = 1

int32
required

1 = Pago, 2 = Não Pago

string | null

CPF ou CNPJ, com ou sem pontuação, de profissional ativo ou fornecedor do estabelecimento. Obrigatório quando a
categoria exige

int32 | null

O id de GET /v1/formaspagamentos. Obrigatório quando StatusPagamento = 1

recorrencia
object
Headers
string
required
Responses

Errors

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json