Skip to main content
PUT
Alterar lançamento de Contas a Pagar
PUT substitui o registro inteiro — envie todos os campos, não apenas os alterados.

Authorizations

Authorization
string
header
required

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

Body

application/json

Lançamento de Contas a Pagar. Usado tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na inclusão, os campos de chave (codigoDoExercicio, numeroDaTransacao, sequenciaDaTransacao) são ignorados e gerados automaticamente; na alteração, eles são obrigatórios para identificar o lançamento.

codigoDaFilial
integer<int16>
required

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

Example:

1

codigoDoFornecedor
integer<int32> | null
required

Código do Fornecedor. Obrigatório e deve ser um Fornecedor válido cadastrado na empresa.

Example:

501

codigoDoItemDeLancamento
string | null
required

Código da Categoria (Item de Lançamento) de despesa. Obrigatório e deve ser uma Categoria de despesa válida da Filial informada.

Example:

"DESP-ALUGUEL"

historico
string | null
required

Histórico do lançamento. Obrigatório.

Example:

"Aluguel do escritório - Julho/2026"

codigoDoCentroDeCusto
string | null
required

Código do Centro de Custo. Obrigatório e deve ser um Centro de Custo válido da empresa.

Example:

"ADM"

codigoDaContaCorrente
integer<int16> | null
required

Código da Conta Corrente. Obrigatório e deve ser uma Conta Corrente válida da Filial informada.

Example:

1

codigoDoExercicio
integer<int16>

Código do Exercício. Obrigatório apenas na alteração (PUT); ignorado e gerado automaticamente na inclusão (POST).

Example:

2026

numeroDaTransacao
number

Número da Transação. Obrigatório apenas na alteração (PUT); ignorado e gerado automaticamente na inclusão (POST).

Example:

123456

sequenciaDaTransacao
integer<int32>

Sequência da Transação. Obrigatório apenas na alteração (PUT); ignorado e gerado automaticamente na inclusão (POST).

Example:

1

sequenciaDaTransacaoPai
integer<int32> | null

Sequência da Transação pai, quando este lançamento é um desdobramento (acréscimo, desconto, juros ou multa) de outro.

codigoDoCliente
integer<int32> | null

Código do Cliente, usado apenas em cenários específicos de Contas a Pagar vinculadas a devoluções/estornos de Cliente.

numeroDoPedidoDeCompra
number | null

Número do Pedido de Compra vinculado ao lançamento, quando aplicável.

codigoDoTipoDeDocumento
integer<int16> | null

Código do Tipo de Documento (ex.: Nota Fiscal, Boleto, Recibo).

numeroDoDocumento
string | null
Example:

"12345"

serieDoDocumento
string | null
Example:

"1"

dataDeEmissao
string<date-time> | null
Example:

"2026-07-01T00:00:00"

dataDeVencimento
string<date-time> | null
Example:

"2026-08-05T00:00:00"

dataDePagamento
string<date-time> | null

Data de Pagamento. Quando informada (e válida), o lançamento é baixado automaticamente na inclusão/alteração.

Example:

null

valorDoLancamento
number<double>

Valor líquido do lançamento — o valor efetivo do título.

Example:

1500.5

valorBruto
number<double>

Valor bruto do lançamento, antes dos impostos retidos.

Example:

1650.5

valorPISRetido
number<double>

Valor de PIS retido na nota.

valorCOFINSRetido
number<double>

Valor de COFINS retido na nota.

valorCSLLRetido
number<double>

Valor de CSLL retido na nota.

valorIRRetido
number<double>

Valor de IR retido na nota.

valorISSRetido
number<double>

Valor de ISS retido na nota.

valorINSSRetido
number<double>

Valor de INSS retido na nota.

codigoDaFormaDePagamento
integer<int16> | null
valorAbatimento
number<double>

Valor de abatimento aplicado ao lançamento.

tipoDeLancamento
string | null

Tipo de lançamento interno (ex.: Normal, Acréscimo, Desconto, Juros, Multa, Estorno).

tipoChavePix
string | null

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

chavePix
string | null
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, quando informado deve ser uma Classificação Auxiliar válida do módulo Financeiro.

observacao
string | null
flag
string | null

Flag/marcador livre do lançamento.

tags
string[] | null
idWS
string | null

Identificador externo do lançamento, usado por integrações.

numeroDaNFe
number | null

Número da NF-e vinculada ao lançamento, quando aplicável.

Response

Lançamento alterado com sucesso.

success
boolean
Example:

true

data
object

Lançamento de Contas a Pagar. Usado tanto na inclusão (POST) quanto na alteração (PUT) e nas respostas de consulta. Na inclusão, os campos de chave (codigoDoExercicio, numeroDaTransacao, sequenciaDaTransacao) são ignorados e gerados automaticamente; na alteração, eles são obrigatórios para identificar o lançamento.