Contas a pagar

Contas a pagar são as despesas da empresa: compras de fornecedores, contas de consumo e impostos. Corresponde à tela Contas a pagar do menu Financeiro. Cada conta a pagar é um lançamento do tipo Débito (despesa), e o pagamento é registrado como uma baixa.

Os endereços a seguir são relativos a https://api.pedagogo.app.

Endpoints

Método	Caminho	Descrição
GET	/financial/accounts-payable	Lista as contas a pagar
POST	/financial/accounts-payable	Cadastra uma conta a pagar, ou um conjunto de parcelas
GET	/financial/accounts-payable/totals	Totais por situação (vencido, vence hoje, a vencer, pago)
PUT	/financial/accounts-payable/{uuid}	Altera uma conta a pagar
DELETE	/financial/accounts-payable/{uuid}	Apaga uma conta a pagar
PATCH	/financial/accounts-payable/{uuid}/change-status	Alterna a situação entre Pago e Conciliado
PUT	/financial/accounts-payable/{uuid}/payment	Registra o pagamento (baixa)
DELETE	/financial/accounts-payable/{uuid}/payment	Estorna o pagamento
POST	/financial/accounts-payable/batch-close	Dá baixa em várias contas de uma vez
GET	/financial/accounts-payable/reports/excel	Exporta a listagem em Excel
GET	/financial/accounts-payable/accounts	Contas cadastradas (lista de apoio)
GET	/financial/accounts-payable/bank-accounts	Contas cadastradas (lista de apoio, mesmo conteúdo de accounts)
GET	/financial/accounts-payable/categories	Categorias de despesa (lista de apoio)
GET	/financial/accounts-payable/companies	Empresas disponíveis (lista de apoio)
GET	/financial/accounts-payable/cost-centers	Centros de custo (lista de apoio)
GET	/financial/accounts-payable/payment-methods	Métodos de pagamento (lista de apoio)
GET	/financial/accounts-payable/types	Tipos de lançamento (lista de apoio)
GET	/financial/accounts-payable/vendors	Fornecedores (lista de apoio)
GET	/financial/accounts-payable/recurrences	Recorrências (lista de apoio)
GET	/financial/accounts-payable/recurrences-types	Tipos de recorrência, ou intervalos entre parcelas (lista de apoio)

Listar

GET /financial/accounts-payable

Lista as contas a pagar da empresa cliente.

Parâmetros de URL

Parâmetro	Descrição
search	Texto livre. Busca na descrição, no tipo de lançamento, no tipo de conta, no nome do fornecedor e no centro de custo
customer_vendor	Texto. Busca pelo nome ou pela razão social do fornecedor
customer_vendor_id	Filtra por fornecedor (id)
start_date e end_date	Período de vencimento. Use os dois juntos para um intervalo, ou só um para uma data exata
payment_method_id	Filtra pela forma de pagamento
category_id	Filtra pela categoria
cost_center_id	Filtra pelo centro de custo
person_type	Filtra pelo tipo de pessoa do fornecedor
status_id	1 para em aberto. Qualquer outro valor filtra as contas pagas
paid	1 para pagas, 0 para em aberto
fast_filter	Situação rápida: overdue (vencido), due today (vence hoje), due (a vencer) ou paid (pago)
account_uuid	Filtra pela conta (uuid)
id_accounts	Filtra por uma ou mais contas. Lista de id separados por vírgula
account_type_id	Filtra pelo tipo de conta
column e order	Ordena pela coluna informada e pelo sentido (asc ou desc). Sem eles, a lista vem em ordem de vencimento
per_page e page	Paginação, conforme Convenções

Resposta (200): lista de contas a pagar, com id, uuid, due_date, payday, description, document_number, amount, payment_amount, status_id, status_name, days_late, customer_vendor_name, account, category, cost_center_name, payment_method, recorrency_id, recorrency_type_id e os nomes de quem criou e alterou o registro.

Totais

GET /financial/accounts-payable/totals

Totais dos cards da tela. Aceita os mesmos parâmetros de filtro da listagem.

Resposta (200):

Campo	Descrição
expired	Total vencido: vencimento até hoje e sem pagamento
today	Total que vence hoje e não foi pago
to_be_expired	Total a vencer: vencimento depois de hoje e sem pagamento
paid	Total pago
total	Soma dos quatro campos acima

Os valores são devolvidos sem sinal.

Cadastrar

POST /financial/accounts-payable

Cadastra uma conta a pagar. Com recorrência de parcelas, cria também os lançamentos seguintes, somando o intervalo escolhido a partir de due_date, até a parcela final.

Corpo

Campo	Obrigatório	Tipo	Descrição
due_date	Sim	Data	Data de vencimento
amount	Sim	Número	Valor da despesa
description	Sim se customer_vendor_id não for informado	Texto	Descrição da despesa
customer_vendor_id	Não	Número	Fornecedor (id de /financial/accounts-payable/vendors)
company_id	Não	Número	Empresa (id de /financial/accounts-payable/companies)
bookkeeping_date	Não	Data	Data da escrituração
document_number	Não	Texto	Número da nota ou do boleto
account_id	Não	Número	Conta (id de /financial/accounts-payable/accounts)
category_id	Não	Número	Categoria (id de /financial/accounts-payable/categories)
cost_center_id	Não	Número	Centro de custo (id de /financial/accounts-payable/cost-centers)
recorrency_id	Não	Número	Recorrência (id de /financial/accounts-payable/recurrences). Para parcelas, use o id de Parcelas, que é 1
recorrency_type_id	Sim se recorrency_id for informado	Número	Intervalo entre as parcelas (id de /financial/accounts-payable/recurrences-types)
initial_installment	Sim se recorrency_id for 1	Número	Parcela inicial
final_installment	Sim se recorrency_id for 1	Número	Parcela final
payday	Não	Data	Data do pagamento
payment_amount	Não	Número	Valor pago

Resposta (201): o lançamento criado. Com parcelas, é o lançamento informado na requisição, e os demais são gerados em seguida.

curl -X POST https://api.pedagogo.app/financial/accounts-payable \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"due_date": "2026-12-10", "amount": 150.00, "description": "Conta exemplo", "account_id": 1, "category_id": 1}'

Alterar e apagar

PUT /financial/accounts-payable/{uuid}

Altera uma conta a pagar. Envie somente os campos que mudam.

Corpo

Campo	Obrigatório	Tipo	Descrição
due_date	Não	Data	Data de vencimento
amount	Não	Número	Valor da despesa
description	Sim se customer_vendor_id não for informado	Texto	Descrição da despesa
customer_vendor_id	Não	Número	Fornecedor
company_id	Não	Número	Empresa
release_type_id	Não	Número	Tipo do lançamento. Para contas a pagar, use 2 (Débito)
bookkeeping_date	Não	Data	Data da escrituração
document_number	Não	Texto	Número do documento
account_id	Não	Número	Conta
category_id	Não	Número	Categoria
cost_center_id	Não	Número	Centro de custo
recorrency_id	Não	Número	Recorrência
recorrency_type_id	Não	Número	Intervalo entre as parcelas
initial_installment	Não	Número	Parcela inicial
final_installment	Não	Número	Parcela final
financial_release_id	Não	Número	Lançamento de origem da parcela
payday	Não	Data	Data do pagamento
payment_amount	Não	Número	Valor pago

Resposta (200): a conta alterada.

DELETE /financial/accounts-payable/{uuid}

Apaga a conta a pagar.

Resposta (200): um objeto com success e message. Quando a conta já tem data de pagamento, success vem como false, a conta não é apagada e a message explica o motivo.

Situação e pagamento

PATCH /financial/accounts-payable/{uuid}/change-status

Alterna a situação da conta entre Pago e Conciliado. Só tem efeito em contas com data de pagamento. Sem data de pagamento, a conta não muda.

Sem corpo.

Resposta (200): a conta.

PUT /financial/accounts-payable/{uuid}/payment

Registra o pagamento da conta (baixa). A conta passa para Pago (status_id igual a 2), com a data informada em payday. O servidor calcula payment_amount a partir de amount, fine, interest e discount, com o sinal conforme o tipo do lançamento.

Corpo

Campo	Obrigatório	Tipo	Descrição
account_id	Sim	Número	Conta de onde o pagamento sai
category_id	Sim	Número	Categoria
payment_method_id	Sim	Número	Forma de pagamento (id de /financial/settings/payment-methods)
payday	Sim	Data	Data do pagamento
amount	Sim	Número	Valor pago. Deve ser maior que zero
customer_vendor_id	Não	Número	Fornecedor
interest	Não	Número	Juros
fine	Não	Número	Multa
discount	Não	Número	Desconto

Resposta (200): a conta, após o pagamento.

DELETE /financial/accounts-payable/{uuid}/payment

Estorna o pagamento. Limpa a data de pagamento, o valor pago, juros, multa e desconto, e a conta volta para Em aberto (status_id igual a 1).

Sem corpo.

Resposta (200): a conta, após o estorno.

Baixa em lote

POST /financial/accounts-payable/batch-close

Dá baixa em várias contas de uma vez. Para cada conta informada, a conta recebe a conta bancária, a forma de pagamento, a data de pagamento e o valor pago igual ao valor da própria conta, e passa para Pago. Categoria e centro de custo só são trocados quando informados; sem eles, cada conta mantém os que já tem.

Corpo

Campo	Obrigatório	Tipo	Descrição
uuids	Sim	Lista de textos	uuid das contas a pagar
account_id	Sim	Número	Conta de onde o pagamento sai
payment_method_id	Sim	Número	Forma de pagamento
payday	Sim	Data	Data do pagamento de todas as contas
category_id	Não	Número	Categoria para todas as contas
cost_center_id	Não	Número	Centro de custo para todas as contas

Resposta (201): corpo null.

Excel

GET /financial/accounts-payable/reports/excel

Gera uma planilha Excel com as contas a pagar. Aceita os mesmos parâmetros de filtro da listagem.

Resposta (200): arquivo .xlsx para download.

Listas de apoio

As listas abaixo alimentam os campos dos formulários e dos filtros. Os id retornados são os que os campos aceitam.

Caminho	Descrição
/financial/accounts-payable/accounts	Contas cadastradas, como em /financial/accounts
/financial/accounts-payable/bank-accounts	Mesmo conteúdo de accounts
/financial/accounts-payable/categories	Categorias de despesa (tipo Débito)
/financial/accounts-payable/companies	Empresas disponíveis para o usuário
/financial/accounts-payable/cost-centers	Centros de custo cadastrados
/financial/accounts-payable/payment-methods	Métodos de pagamento cadastrados
/financial/accounts-payable/types	Tipos de lançamento. Crédito (1) e Débito (2)
/financial/accounts-payable/vendors	Fornecedores cadastrados
/financial/accounts-payable/recurrences	Recorrências disponíveis (id e nome)
/financial/accounts-payable/recurrences-types	Intervalos entre parcelas (id e nome)

Consulte Contas para a lista de contas, Configurações de métodos de pagamento para os métodos e Configurações de categorias e Centros de custo para os demais cadastros.