Movimentação financeira
Movimentação financeira é a tela que reúne os lançamentos financeiros em uma só lista, para acompanhamento, baixa, estorno e conciliação. Também é onde se faz a transferência entre contas. Corresponde à tela Movimentação financeira do menu Financeiro.
Os lançamentos são as contas a pagar e a receber. As ações de baixa, estorno e conciliação funcionam como em Contas a pagar e Contas a receber. Os endereços a seguir são relativos a https://api.pedagogo.app.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /financial/financial-releases | Lista os lançamentos |
| GET | /financial/financial-releases/{uuid} | Consulta um lançamento |
| POST | /financial/financial-releases/transfer | Transferência entre contas |
| PATCH | /financial/financial-releases/{uuid}/change-status | Alterna a situação entre Pago e Conciliado |
| GET | /financial/financial-releases/companies | Empresas disponíveis (lista de apoio) |
| GET | /financial/financial-releases/categories | Categorias de despesa (lista de apoio) |
| GET | /financial/financial-releases/cost-centers | Centros de custo (lista de apoio) |
| GET | /financial/financial-releases/payment-methods | Métodos de pagamento (lista de apoio) |
| GET | /financial/financial-releases/release-types | Tipos de lançamento (lista de apoio) |
| GET | /financial/categories/release-types | Tipos de lançamento (lista de apoio, mesmo conteúdo de release-types) |
Listar
GET /financial/financial-releases
Lista os lançamentos da empresa cliente, em ordem de data de pagamento ou, quando não houver pagamento, de vencimento.
Parâmetros de URL
Os mesmos filtros de Contas a pagar, com estas diferenças:
| Parâmetro | Descrição |
|---|---|
release_type_id | Tipo de lançamento: 1 para crédito (receita) e 2 para débito (despesa) |
search | Texto livre sobre a descrição, o tipo de lançamento, o tipo de conta, o nome do cliente ou fornecedor e o centro de custo |
customer_vendor | Texto. Busca pelo nome ou pela razão social do cliente ou fornecedor |
customer_vendor_id | Filtra por cliente ou fornecedor (id) |
start_date e end_date | Período de vencimento |
status_id e paid | Situação, como em contas a pagar |
fast_filter | Situação rápida: overdue, due today, due ou paid |
account_uuid e id_accounts | Conta, como em contas a pagar |
per_page e page | Paginação, conforme Convenções |
Resposta (200): lista de lançamentos, com os campos de contas a pagar, incluindo release_type, account, account_type, customer_vendor_name e company_name.
GET /financial/financial-releases/{uuid}
Consulta um lançamento pelo uuid.
Resposta (200): o lançamento, com os mesmos campos da listagem.
Transferência entre contas
POST /financial/financial-releases/transfer
Transfere um valor de uma conta para outra. O servidor cria dois lançamentos, ambos já pagos, com a data informada: um na conta de origem, com o valor negativo, e outro na conta de destino, com o valor positivo. Os dois têm o tipo Transferência.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
from_account_id | Sim | Número | Conta de origem (id de /financial/accounts) |
to_account_id | Sim | Número | Conta de destino (id de /financial/accounts) |
due_date | Sim | Data | Data da transferência |
amount | Sim | Número | Valor transferido |
description | Sim | Texto | Descrição da transferência |
Resposta (200): corpo null.
curl -X POST https://api.pedagogo.app/financial/financial-releases/transfer \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"from_account_id": 1, "to_account_id": 2, "due_date": "2026-12-10", "amount": 500.00, "description": "Transferência exemplo"}'
Situação
PATCH /financial/financial-releases/{uuid}/change-status
Alterna a situação do lançamento entre Pago e Conciliado. Só tem efeito em lançamentos com data de pagamento.
Sem corpo.
Resposta (200): o lançamento.
Listas de apoio
| Caminho | Descrição |
|---|---|
/financial/financial-releases/companies | Empresas disponíveis para o usuário |
/financial/financial-releases/categories | Categorias de despesa, usadas no filtro Categoria |
/financial/financial-releases/cost-centers | Centros de custo cadastrados |
/financial/financial-releases/payment-methods | Métodos de pagamento cadastrados |
/financial/financial-releases/release-types | Tipos de lançamento. Crédito (1) e Débito (2) |
/financial/categories/release-types | Mesmo conteúdo de release-types |
As contas do filtro são as de /financial/accounts, descritas em Contas.