Skip to main content
POST
Inserir Previsão de Contas a Pagar
Para lançamento recorrente envie lancamentoRecorrente, frequencia e numeroDeParcelas; para lançamento único use lancamentoUnico.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Body

application/json

Previsão (lançamento previsto/recorrente) de Contas a Pagar. Usada na inclusão (POST) e nas respostas de consulta. Na inclusão o id é ignorado e gerado automaticamente.

codigoDaFilial
integer<int16>
required

Código da Filial. Deve ser uma Filial válida da empresa.

Example:

1

codigoDoFornecedor
integer<int32>
required

Código do Fornecedor. Deve ser um Fornecedor válido da empresa.

Example:

1523

codigoDoItemDeLancamento
string | null
required

Código da Categoria (Item de Lançamento) do movimento.

historico
string | null
required

Histórico/descrição do lançamento previsto.

Example:

"Aluguel da matriz"

id
number<decimal>

Id da previsão. Ignorado e gerado automaticamente na inclusão (POST).

Example:

42

lancamentoRecorrente
boolean

Indica previsão recorrente, que gera um título a cada parcela.

lancamentoUnico
boolean

Indica previsão de parcela única.

lancamentoFinalizado
boolean

Indica que a previsão já gerou todas as parcelas previstas.

frequencia
string | null

Código da frequência da previsão: U (única), M (mensal), W (semanal), Q (quinzenal), B (bimestral), T (trimestral), S (semestral) ou A (anual). Na inclusão também aceita a descrição (ex.: Mensal).

Example:

"M"

numeroDeParcelas
integer<int16>

Quantidade total de parcelas previstas.

Example:

12

numeroDaProximaParcela
integer<int16>

Número da próxima parcela a ser gerada.

Example:

3

diasAntesDoProximoVencimento
integer<int16>

Quantos dias antes do vencimento o título é gerado. Padrão de 30 dias quando não informado.

Example:

30

dataDoProximoVencimento
string<date-time> | null

Data de vencimento da próxima parcela.

Example:

"2026-08-10T00:00:00"

periodoDeCompetencia
string<date-time> | null

Período de competência do lançamento.

descricaoDoItemDeLancamento
string | null
quantidade
number<double>

Quantidade usada no cálculo do valor do lançamento.

Example:

1

valorUnitario
number<double>

Valor unitário usado no cálculo do valor do lançamento.

Example:

1500.5

valorDoLancamento
number<double>

Valor previsto de cada parcela.

Example:

1500.5

codigoDoCentroDeCusto
string | null

Código do Centro de Custo do movimento.

codigoDaContaCorrente
integer<int16> | null

Código da Conta Corrente usada na geração do título.

codigoDaCarteira
integer<int16> | null

Código da Carteira de cobrança, quando aplicável.

codigoDoProjeto
integer<int32> | null

Código do Projeto; quando informado deve ser um Projeto válido da empresa.

codigoDaClassificacaoAuxiliar
integer<int32> | null

Código da Classificação Auxiliar do movimento.

tipoChavePix
string | null

Tipo da Chave PIX usada no pagamento (ex.: CPF, CNPJ, E-mail, Telefone, Aleatória).

chavePix
string | null
codigoDoTipoDeDocumento
integer<int16> | null

Código do Tipo de Documento do título gerado.

codigoDaFormaDePagamento
integer<int16> | null

Código da Forma de Pagamento do título gerado.

numeroDoDocumento
string | null

Número do documento do título gerado.

numeroDaNFe
number | null

Número da NF-e vinculada à previsão, quando aplicável.

observacao
string | null
tags
string[] | null
ativo
boolean

Indica se a previsão está ativa. Padrão true na inclusão.

Example:

true

Response

Previsão inserida com sucesso.

success
boolean
Example:

true

data
object

Previsão (lançamento previsto/recorrente) de Contas a Pagar. Usada na inclusão (POST) e nas respostas de consulta. Na inclusão o id é ignorado e gerado automaticamente.