À faturar
À faturar mostra, por empresa, os treinamentos já lançados que ainda não foram incluídos em nenhum faturamento. Corresponde à tela À faturar do menu Faturamento. A partir dela, abre-se um faturamento para a empresa e o período. Os alunos são incluídos depois, dentro do faturamento, pelos caminhos de alunos descritos aqui e em Faturados.
Os endereços a seguir são relativos a https://api.pedagogo.app.
Endpoints
| Método | Caminho | Descrição |
|---|---|---|
| GET | /invoicing/pending-billings | Lista as empresas com treinamentos pendentes de faturamento |
| POST | /invoicing/pending-billings | Cadastra um faturamento pendente para uma empresa e um período |
| GET | /invoicing/pending-billings/totals | Totais dos cards da tela |
| GET | /invoicing/pending-billings/{billing_uuid} | Consulta o faturamento aberto a partir da tela |
| GET | /invoicing/pending-billings/{billing_uuid}/billed-students | Alunos incluídos no faturamento |
| DELETE | /invoicing/pending-billings/{billing_uuid}/billed-students/{id} | Remove um aluno do faturamento |
| PUT | /invoicing/pending-billings/{billing_uuid}/students/{uuid} | Altera o aluno do treinamento incluído no faturamento |
| GET | /invoicing/pending-billings/{billing_uuid}/to-bill-students | Alunos da empresa que ainda podem ser incluídos |
| POST | /invoicing/pending-billings/{billing_uuid}/to-bill-students | Inclui alunos no faturamento |
| GET | /invoicing/pending-billings/{customer_vendor_id}/statement-of-trainigs | Demonstrativo em PDF dos treinamentos pendentes da empresa |
| GET | /invoicing/pending-billings/companies | Empresas e filiais disponíveis (lista de apoio) |
| GET | /invoicing/pending-billings/companies/{uuid} | Consulta uma empresa (lista de apoio) |
Os caminhos billed-students, students e to-bill-students dentro de /invoicing/pending-billings/{billing_uuid} têm o mesmo comportamento dos de /invoicing/billings/{billing_uuid}, descritos em Faturados.
Listar
GET /invoicing/pending-billings
Lista as empresas com treinamentos que ainda não estão em nenhum faturamento. Cada linha agrupa os treinamentos pendentes de uma empresa.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
start_date e end_date | Período pela data de início dos treinamentos. Informe os dois juntos |
search | Texto livre. Busca no nome ou na razão social da empresa |
business | Texto. Busca no nome ou na razão social da empresa |
customer_vendor_business_uuid | Filtra pela empresa (uuid) |
columnName e orderData | Ordena pela coluna informada e pelo sentido (asc ou desc). Sem eles, a lista vem em ordem alfabética pelo nome da empresa |
per_page e page | Paginação, conforme Convenções |
Resposta (200): lista de empresas, com id, uuid, customer_vendor_business_id, business (nome ou razão social), business_document (CNPJ ou CPF), start_date (menor data de início entre os treinamentos pendentes), end_date (maior data de início entre os treinamentos pendentes), amount (soma dos valores dos treinamentos pendentes) e students (quantidade de matrículas pendentes).
Totais
GET /invoicing/pending-billings/totals
Totais dos cards da tela. O campo Total respeita os filtros de pesquisa, empresa e período informados. Os três cartões mensais usam as datas do mês de referência, e não as do filtro.
Parâmetros de URL: os mesmos de GET /invoicing/pending-billings.
Resposta (200): lista de quatro objetos, cada um com uma chave e os campos amount, period, start_date e end_date. A chave Total não traz period, start_date nem end_date.
| Chave | Período |
|---|---|
Total | Conforme os filtros informados |
current_month | Mês atual |
previous_month | Mês anterior |
before_previous_month | Dois meses antes do atual |
[
{ "Total": { "amount": 12500.0 } },
{ "current_month": { "amount": 4000.0, "period": "11/2026", "start_date": "2026-11-01", "end_date": "2026-11-30" } },
{ "previous_month": { "amount": 5000.0, "period": "10/2026", "start_date": "2026-10-01", "end_date": "2026-10-31" } },
{ "before_previous_month": { "amount": 3500.0, "period": "09/2026", "start_date": "2026-09-01", "end_date": "2026-09-30" } }
]
Cadastrar
POST /invoicing/pending-billings
Cadastra um faturamento para a empresa e o período. O faturamento é criado sem alunos: os alunos são incluídos depois. Se a empresa já tiver um faturamento aberto, sem alunos e não concluído, esse faturamento é atualizado e devolvido.
Corpo
| Campo | Obrigatório | Tipo | Descrição |
|---|---|---|---|
customer_vendor_id | Sim | Número | Empresa cobrada (id da empresa) |
start_date | Sim | Data | Início do período do faturamento |
end_date | Sim | Data | Fim do período do faturamento |
company_id | Não | Número | Filial ou empresa emissora (id de /invoicing/pending-billings/companies) |
observations | Não | Texto | Observações do faturamento |
comments | Não | Texto | Comentários do faturamento |
Resposta (201): o faturamento criado, ou o faturamento aberto que foi atualizado. Consulte o uuid na resposta para incluir alunos em Faturados.
curl -X POST https://api.pedagogo.app/invoicing/pending-billings \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <token-de-sessao>" \
-d '{"customer_vendor_id": 1, "start_date": "2026-11-01", "end_date": "2026-11-30"}'
Consultar
GET /invoicing/pending-billings/{billing_uuid}
Devolve o faturamento com o uuid informado, com os dados da empresa cobrada e da empresa emissora.
Demonstrativo
GET /invoicing/pending-billings/{customer_vendor_id}/statement-of-trainigs
Demonstrativo em PDF dos treinamentos pendentes da empresa informada no caminho.
Parâmetros de URL
| Parâmetro | Descrição |
|---|---|
start_date | Data inicial do período (AAAA-MM-DD) |
end_date | Data final do período (AAAA-MM-DD) |
Resposta (200): arquivo PDF para download.
Empresas
GET /invoicing/pending-billings/companies
Empresas e filiais que o usuário pode escolher no campo Filial do cadastro de faturamento pendente. Resposta em lista, com id, uuid e nome.
GET /invoicing/pending-billings/companies/{uuid}
Consulta uma empresa ou filial pelo uuid.
Alunos do faturamento
Os endpoints de alunos sob /invoicing/pending-billings/{billing_uuid} seguem as regras de Faturados: to-bill-students lista os alunos da empresa no período que ainda não estão em faturamento, POST to-bill-students os inclui, billed-students lista os incluídos, DELETE billed-students/{id} remove um aluno, e PUT students/{uuid} altera o treinamento do aluno.