Contas a receber
Contas a receber são as receitas da empresa: mensalidades, vendas e convênios. Corresponde à tela Contas a receber do menu Financeiro. Cada conta a receber é um lançamento do tipo Crédito (receita), e o recebimento é registrado como uma baixa.
As regras são as mesmas de Contas a pagar, com as diferenças indicadas abaixo. Os endereços a seguir são relativos a https://api.pedagogo.app.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /financial/accounts-receivable | Lista as contas a receber |
| POST | /financial/accounts-receivable | Cadastra uma conta a receber, ou um conjunto de parcelas |
| GET | /financial/accounts-receivable/totals | Totais por situação (vencido, vence hoje, a vencer, recebido) |
| PUT | /financial/accounts-receivable/{uuid} | Altera uma conta a receber |
| DELETE | /financial/accounts-receivable/{uuid} | Apaga uma conta a receber |
| PATCH | /financial/accounts-receivable/{uuid}/change-status | Alterna a situação entre Recebido e Conciliado |
| PUT | /financial/accounts-receivable/{uuid}/payment | Registra o recebimento (baixa) |
| DELETE | /financial/accounts-receivable/{uuid}/payment | Estorna o recebimento |
| POST | /financial/accounts-receivable/batch-close | Dá baixa em várias contas de uma vez |
| GET | /financial/accounts-receivable/reports/excel | Exporta a listagem em Excel |
| GET | /financial/accounts-receivable/accounts | Contas cadastradas (lista de apoio) |
| GET | /financial/accounts-receivable/bank-accounts | Contas cadastradas (lista de apoio, mesmo conteúdo de accounts) |
| GET | /financial/accounts-receivable/categories | Categorias de receita (lista de apoio) |
| GET | /financial/accounts-receivable/companies | Empresas disponíveis (lista de apoio) |
| GET | /financial/accounts-receivable/cost-centers | Centros de custo (lista de apoio) |
| GET | /financial/accounts-receivable/payment-methods | Métodos de pagamento (lista de apoio) |
| GET | /financial/accounts-receivable/types | Tipos de lançamento (lista de apoio) |
| GET | /financial/accounts-receivable/customers | Clientes (lista de apoio) |
| GET | /financial/accounts-receivable/recurrences | Recorrências (lista de apoio) |
| GET | /financial/accounts-receivable/recurrences-types | Intervalos entre parcelas (lista de apoio) |
Diferenças em relação a contas a pagar
| Item | Contas a receber |
|---|---|
| Pessoa da conta | customer_vendor_id identifica o cliente, e não o fornecedor. Use um id de /financial/accounts-receivable/customers |
| Tipo de lançamento | Crédito (1). Em release_type_id, use 1 |
| Situação de quitação | Recebido, em vez de Pago |
Campo invoice | Quando a conta está ligada a uma nota fiscal, a resposta da listagem traz o objeto invoice com os dados da nota |
| Excel | Gerado com o nome "Contas a Receber" |
Listar
GET /financial/accounts-receivable
Lista as contas a receber da empresa cliente. Aceita os mesmos parâmetros de filtro de Contas a pagar, com customer_vendor e customer_vendor_id buscando o cliente.
Resposta (200): lista de contas a receber, com os mesmos campos de contas a pagar e, quando houver, o objeto invoice.
Totais
GET /financial/accounts-receivable/totals
Totais dos cards da tela, com as mesmas chaves de contas a pagar: expired, today, to_be_expired, paid e total. Aceita os mesmos parâmetros de filtro da listagem.
Cadastrar
POST /financial/accounts-receivable
Cadastra uma conta a receber. Aceita o mesmo corpo de contas a pagar, com estes campos de pessoa e tipo:
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
customer_vendor_id | Não | Número | Cliente (id de /financial/accounts-receivable/customers) |
description | Sim se customer_vendor_id não for informado | Texto | Descrição da receita |
Os demais campos (due_date, amount, company_id, bookkeeping_date, document_number, account_id, category_id, cost_center_id, recorrency_id, recorrency_type_id, initial_installment, final_installment, payday e payment_amount) são os de Contas a pagar, com due_date e amount obrigatórios.
Resposta (201): o lançamento criado, como em contas a pagar.
curl -X POST https://api.pedagogo.app/financial/accounts-receivable \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"due_date": "2026-12-10", "amount": 800.00, "description": "Mensalidade exemplo", "customer_vendor_id": 1, "category_id": 1}'
Alterar e apagar
PUT /financial/accounts-receivable/{uuid}
Altera uma conta a receber. Aceita o mesmo corpo de Contas a pagar. Para contas a receber, use release_type_id igual a 1.
Resposta (200): a conta alterada.
DELETE /financial/accounts-receivable/{uuid}
Apaga a conta a receber. A resposta e as regras são as de Contas a pagar: quando a conta já tem data de recebimento, success vem como false e a conta não é apagada.
Situação e recebimento
PATCH /financial/accounts-receivable/{uuid}/change-status
Alterna a situação entre Recebido e Conciliado. Só tem efeito em contas com data de recebimento.
Resposta (200): a conta.
PUT /financial/accounts-receivable/{uuid}/payment
Registra o recebimento (baixa). A conta passa para Recebido (status_id igual a 2), com a data 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 onde o recebimento entra |
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 recebimento |
amount | Sim | Número | Valor recebido. Deve ser maior que zero |
customer_vendor_id | Não | Número | Cliente |
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 recebimento.
DELETE /financial/accounts-receivable/{uuid}/payment
Estorna o recebimento. 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-receivable/batch-close
Dá baixa em várias contas a receber de uma vez. O corpo e o comportamento são os de Contas a pagar.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
uuids | Sim | Lista de textos | uuid das contas a receber |
account_id | Sim | Número | Conta onde o recebimento entra |
payment_method_id | Sim | Número | Forma de pagamento |
payday | Sim | Data | Data do recebimento 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-receivable/reports/excel
Gera uma planilha Excel com as contas a receber, com os mesmos filtros da listagem.
Resposta (200): arquivo .xlsx para download.
Listas de apoio
| Caminho | Descrição |
|---|---|
/financial/accounts-receivable/accounts | Contas cadastradas, como em /financial/accounts |
/financial/accounts-receivable/bank-accounts | Mesmo conteúdo de accounts |
/financial/accounts-receivable/categories | Categorias de receita (tipo Crédito) |
/financial/accounts-receivable/companies | Empresas disponíveis para o usuário |
/financial/accounts-receivable/cost-centers | Centros de custo cadastrados |
/financial/accounts-receivable/payment-methods | Métodos de pagamento cadastrados |
/financial/accounts-receivable/types | Tipos de lançamento. Crédito (1) e Débito (2) |
/financial/accounts-receivable/customers | Clientes cadastrados |
/financial/accounts-receivable/recurrences | Recorrências disponíveis (id e nome) |
/financial/accounts-receivable/recurrences-types | Intervalos entre parcelas (id e nome) |
Consulte Contas, Métodos de pagamento, Categorias e Centros de custo para os cadastros usados aqui.