07. 💸 Pagamentos

Gestão completa de pagamentos Controle de contas a pagar, fornecedores e fluxo de caixa. Funcionalidades:

  • Cadastro de contas a pagar

  • Controle de centro de custos

  • Registro de liquidações

  • Controle de fluxo de caixa

Lista pagamentos

get

Retorna lista de pagamentos com filtros

Autorizações
AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de consulta
numero_nota_fiscalstringOpcional

Número da nota fiscal

cpf_cnpj_fornecedorstringOpcional

CPF/CNPJ do fornecedor

data_vencimento_iniciostring · dateOpcional

Data de vencimento início

data_vencimento_fimstring · dateOpcional

Data de vencimento fim

data_emissao_iniciostring · dateOpcional

Data de emissão início

data_emissao_fimstring · dateOpcional

Data de emissão fim

statusstring · enumOpcional

Status da conta

Valores possíveis:
centro_custo_idintegerOpcional

ID do centro de custo

pageintegerOpcional

Número da página

Respostas
chevron-right
200

Lista de contas a pagar

application/json
get
/contas_a_pagars

Cria pagamento

post

Criar um novo pagamento

Endpoint utilizado para criar um novo pagamento no sistema. Permite registrar valores a pagar para fornecedores com informações completas de vencimento, forma de pagamento e relacionamentos com notas fiscais.

Campos obrigatórios:

  • fornecedor_id: ID do fornecedor

  • valor_original: Valor total a pagar

  • data_emissao: Data de emissão da conta

  • data_vencimento: Data de vencimento

Funcionalidades:

  • Associação com fornecedores

  • Vinculação com notas fiscais

  • Sistema de centro de custo

  • Categorização de despesas

  • Configuração de forma de pagamento

Autorizações
AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Corpo
data_vencimentostring · dateObrigatório

Data de vencimento

Example: 2023-02-20
data_competenciastring · dateObrigatório

Data de competência

Example: 2023-01-01
data_pagamentostring · dateOpcional

Data do pagamento

Example: 2023-02-15
descricaostringObrigatório

Descrição da conta

Example: Pagamento de fornecedor XYZ
valorstringObrigatório

Valor da conta

Example: 1500.0
observacaostringOpcional

Observações sobre a conta

Example: Pagamento aprovado pela diretoria
numero_documentostringOpcional

Número do documento interno

Example: DOC123456
numero_documento_fiscalstringOpcional

Número do documento fiscal

Example: NF123456
tipo_custostringOpcional

Tipo de custo (fixo/variável)

Example: fixo
custostringOpcional

Tipo de custo (alternativo a tipo_custo)

Example: variavel
valor_jurosstringOpcional

Valor dos juros

Example: 50.0
jurosnumber · floatOpcional

Valor dos juros (alternativo a valor_juros)

Example: 50
valor_descontostringOpcional

Valor do desconto

Example: 100.0
descontonumber · floatOpcional

Valor do desconto (alternativo a valor_desconto)

Example: 100
conta_corrente_idintegerOpcional

ID da conta corrente

Example: 5
codigo_conta_correntestringOpcional

UUID da conta corrente

Example: abc123-def456-789
documento_idintegerOpcional

ID do documento/forma de pagamento

Example: 7
forma_de_pagamentostringOpcional

Descrição da forma de pagamento

Example: Transferência Bancária
nota_fiscal_idintegerOpcional

ID da nota fiscal

Example: 54321
numero_da_nota_fiscalstringOpcional

Número da nota fiscal

Example: 000123456
moeda_idintegerOpcional

ID da moeda

Example: 1
codigo_iso_moedastringOpcional

Código ISO da moeda

Example: BRL
fornecedor_idintegerOpcional

ID do fornecedor

Example: 100
stakeholder_idintegerOpcional

ID do stakeholder (alternativo a fornecedor_id)

Example: 100
cpf_cnpj_fornecedorstringOpcional

CPF/CNPJ do fornecedor

Example: 12345678000190
codigo_processostringOpcional

Código do processo

Example: PROC001
compra_idintegerOpcional

ID da compra relacionada

Example: 999
tagsstring[]Opcional

Tags personalizadas

Example: ["Urgente","Prioritário"]
plano_de_conta_idintegerOpcional

ID do plano de conta

Example: 10
codigo_plano_de_contastringOpcional

Código completo do plano de conta

Example: 2.1.01.001
centro_de_custo_idintegerOpcional

ID do centro de custo

Example: 3
descricao_centro_de_custostringOpcional

Descrição do centro de custo

Example: Vendas
Respostas
post
/contas_a_pagars

Exibe pagamento

get

Visualizar detalhes de um pagamento específico

Endpoint utilizado para consultar informações detalhadas de um pagamento já existente no sistema. Retorna dados completos incluindo informações do fornecedor, nota fiscal relacionada, forma de pagamento e centro de custo associado.

Informações retornadas:

  • Dados financeiros completos (valores, datas, liquidações)

  • Informações do fornecedor associado

  • Detalhes da nota fiscal relacionada (se houver)

  • Forma de pagamento configurada

  • Centro de custo e categoria

  • Histórico de liquidações realizadas

  • Anexos (se houver)

Autorizações
AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota
idintegerObrigatório

ID do pagamento

Respostas
chevron-right
200

Pagamento encontrado

application/json
idintegerObrigatório

ID da conta a pagar

Example: 12345
observacaostring · nuloOpcional

Observação da conta

Example: Pagamento aprovado pela diretoria
numero_documentostring · nuloOpcional

Número do documento

Example: DOC123456
numero_documento_fiscalstring · nuloOpcional

Número do documento fiscal

Example: NF123456
usuariostring · nuloObrigatório

Email do usuário

Example: [email protected]
descricaostringObrigatório

Descrição da conta

Example: Pagamento de fornecedor XYZ
valorstringObrigatório

Valor da conta

Example: 1500.0
valor_multastringOpcional

Valor da multa

Example: 0.0
valor_jurosstringOpcional

Valor dos juros

Example: 0.0
valor_descontostringOpcional

Valor do desconto

Example: 0.0
valor_pagostring · nuloObrigatório

Valor já pago

Example: 750.0
valor_liquidostring · nuloObrigatório

Valor líquido

Example: 1450.0
data_pagamentostring · date · nuloOpcional

Data do pagamento

Example: 2023-02-15
data_vencimentostring · dateObrigatório

Data de vencimento

Example: 2023-02-20
data_competenciastring · dateObrigatório

Data de competência

Example: 2023-02-01
tipo_custostring · nuloOpcional

Tipo de custo

Example: fixo
status_conciliacaostringObrigatório

Status de conciliação

Example: nao_conciliado
plano_de_conta_idinteger · nuloOpcional

ID do plano de conta

Example: 10
conta_corrente_idinteger · nuloOpcional

ID da conta corrente

Example: 5
centro_de_custo_idinteger · nuloOpcional

ID do centro de custo

Example: 3
stakeholder_idinteger · nuloOpcional

ID do stakeholder

Example: 100
fornecedor_idinteger · nuloOpcional

ID do fornecedor (mesmo que stakeholder_id)

Example: 100
documento_idinteger · nuloOpcional

ID do documento/forma de pagamento

Example: 7
moeda_idinteger · nuloOpcional

ID da moeda

Example: 1
plano_de_contastring · nuloOpcional

Descrição do plano de conta

Example: Fornecedores - Matéria Prima
codigo_plano_de_contastring · nuloOpcional

Código completo do plano de conta

Example: 2.1.01.001
vendedor_pessoa_idinteger · nuloOpcional

ID da pessoa vendedora

Example: 50
processo_idinteger · nuloOpcional

ID do processo

Example: 20
taxa_cambiostringOpcional

Taxa de câmbio

Example: 1
status_financeirostringOpcional

Status financeiro da conta

Example: em_aberto
get
/contas_a_pagars/{id}

Atualiza pagamento

put

Atualizar um pagamento existente

Endpoint utilizado para atualizar informações de um pagamento já cadastrada no sistema. Permite modificar valores, datas, e registrar liquidações parciais ou totais.

Operações suportadas:

  • Atualização de valores e datas

  • Registro de liquidações (parciais/totais)

  • Modificação de descrições e códigos

  • Aplicação de descontos e juros

  • Atualização de dados de pagamento

Controle de liquidações:

  • valor_pago: Valor efetivamente pago

  • data_pagamento: Data do pagamento

  • forma_pagamento: Forma utilizada para pagamento

  • observacoes: Observações sobre o pagamento

Autorizações
AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota
idintegerObrigatório

ID do pagamento

Corpo
data_vencimentostring · dateOpcional

Data de vencimento

Example: 2023-02-20
data_competenciastring · dateOpcional

Data de competência

Example: 2023-01-01
data_pagamentostring · dateOpcional

Data do pagamento

Example: 2023-02-15
descricaostringOpcional

Descrição da conta

Example: Pagamento de fornecedor XYZ
valorstringOpcional

Valor da conta

Example: 1500.0
observacaostringOpcional

Observações sobre a conta

Example: Pagamento aprovado pela diretoria
numero_documentostringOpcional

Número do documento interno

Example: DOC123456
numero_documento_fiscalstringOpcional

Número do documento fiscal

Example: NF123456
tipo_custostringOpcional

Tipo de custo (fixo/variável)

Example: fixo
custostringOpcional

Tipo de custo (alternativo a tipo_custo)

Example: variavel
valor_jurosstringOpcional

Valor dos juros

Example: 50.0
jurosnumber · floatOpcional

Valor dos juros (alternativo a valor_juros)

Example: 50
valor_descontostringOpcional

Valor do desconto

Example: 100.0
descontonumber · floatOpcional

Valor do desconto (alternativo a valor_desconto)

Example: 100
conta_corrente_idintegerOpcional

ID da conta corrente

Example: 5
codigo_conta_correntestringOpcional

UUID da conta corrente

Example: abc123-def456-789
documento_idintegerOpcional

ID do documento/forma de pagamento

Example: 7
forma_de_pagamentostringOpcional

Descrição da forma de pagamento

Example: Transferência Bancária
nota_fiscal_idintegerOpcional

ID da nota fiscal

Example: 54321
numero_da_nota_fiscalstringOpcional

Número da nota fiscal

Example: 000123456
moeda_idintegerOpcional

ID da moeda

Example: 1
codigo_iso_moedastringOpcional

Código ISO da moeda

Example: BRL
fornecedor_idintegerOpcional

ID do fornecedor

Example: 100
stakeholder_idintegerOpcional

ID do stakeholder (alternativo a fornecedor_id)

Example: 100
cpf_cnpj_fornecedorstringOpcional

CPF/CNPJ do fornecedor

Example: 12345678000190
codigo_processostringOpcional

Código do processo

Example: PROC001
compra_idintegerOpcional

ID da compra relacionada

Example: 999
tagsstring[]Opcional

Tags personalizadas

Example: ["Urgente","Prioritário"]
plano_de_conta_idintegerOpcional

ID do plano de conta

Example: 10
codigo_plano_de_contastringOpcional

Código completo do plano de conta

Example: 2.1.01.001
centro_de_custo_idintegerOpcional

ID do centro de custo

Example: 3
descricao_centro_de_custostringOpcional

Descrição do centro de custo

Example: Vendas
Respostas
chevron-right
200

Pagamento atualizado

application/json
idintegerOpcional

ID da conta a pagar

Example: 12345
observacaostring · nuloOpcional

Observação da conta

numero_documentostring · nuloOpcional

Número do documento

numero_documento_fiscalstring · nuloOpcional

Número do documento fiscal

usuariostring · nuloOpcional

Email do usuário

descricaostringOpcional

Descrição da conta

valorstringOpcional

Valor da conta

valor_multastringOpcional

Valor da multa

valor_jurosstringOpcional

Valor dos juros

valor_descontostringOpcional

Valor do desconto

valor_pagostring · nuloOpcional

Valor já pago

valor_liquidostring · nuloOpcional

Valor líquido

data_pagamentostring · date · nuloOpcional

Data do pagamento

data_vencimentostring · dateOpcional

Data de vencimento

data_competenciastring · dateOpcional

Data de competência

tipo_custostring · nuloOpcional

Tipo de custo

status_conciliacaostringOpcional

Status de conciliação

plano_de_conta_idinteger · nuloOpcional

ID do plano de conta

conta_corrente_idinteger · nuloOpcional

ID da conta corrente

centro_de_custo_idinteger · nuloOpcional

ID do centro de custo

stakeholder_idinteger · nuloOpcional

ID do stakeholder

fornecedor_idinteger · nuloOpcional

ID do fornecedor

documento_idinteger · nuloOpcional

ID do documento

moeda_idinteger · nuloOpcional

ID da moeda

plano_de_contastring · nuloOpcional

Descrição do plano de conta

codigo_plano_de_contastring · nuloOpcional

Código completo do plano de conta

compraobject · nuloOpcional

Dados da compra relacionada

nota_fiscalobjectOpcional

Dados da nota fiscal relacionada

forma_pagamentoobject · nuloOpcional

Forma de pagamento

conta_correnteobjectOpcional

Dados da conta corrente

centro_de_custoobject · nuloOpcional

Centro de custo associado

processoobject · nuloOpcional

Processo associado

vendedor_pessoa_idinteger · nuloOpcional

ID da pessoa vendedora

processo_idinteger · nuloOpcional

ID do processo

taxa_cambiostringOpcional

Taxa de câmbio

status_financeirostringOpcional

Status financeiro da conta

tagsobject[]Opcional

Tags personalizadas

anexosobject[]Opcional

Lista de anexos

put
/contas_a_pagars/{id}

Excluir pagamento

delete

Excluir um pagamento existente

Endpoint utilizado para excluir um pagamento já cadastrado no sistema. O registro é marcado como excluído e pode ser restaurado posteriormente se necessário.

Importante:

  • Soft delete: o registro é marcado como excluído, não removido permanentemente

  • Possível restaurar o registro posteriormente

  • Mantém histórico de auditoria

  • Não afeta históricos já processados

Casos de uso:

  • Cancelamento de compras não efetivadas

  • Correção de lançamentos incorretos

  • Estorno de operações comerciais

  • Ajustes contábeis necessários

Autorizações
AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota
idintegerObrigatório

ID do pagamento

Respostas
chevron-right
200

Pagamento excluído

Sem conteúdo

delete
/contas_a_pagars/{id}

Sem conteúdo

Atualizado