Retornar visão de matrícula x financeiro

get

https://api.proesc.com/api/v2/enrollment-financials

Retorna uma listagem paginada de matrículas com o status de matrícula (ativa/inativa)
cruzado com o status financeiro (inadimplente/adimplente), além dos dados pessoais
e de endereço do aluno.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

unit_id

string

Id da unidade para filtragem das informações .

status

string

enum

Filtra pelo status da matrícula.

Allowed:

delinquent

boolean

Filtra apenas matrículas inadimplentes (true) ou apenas adimplentes (false).
Independentemente deste filtro, cada matrícula retornada inclui o bloco
"pending_invoices" com as parcelas vencidas e em aberto (lista vazia quando não há
nenhuma), ou "paid_invoices" quando há filtro de data de pagamento.

limit

integer

1 to 50

Defaults to 20

The numbers of items to return.

page

integer

≥ 1

Número de página para listagem de dados

integer

Identificador único da pessoa, para busca exata.

cpf

string

CPF da pessoa, para busca exata. Aceita o valor formatado
(ex: "386.001.258-47") — a pontuação é removida automaticamente antes da busca.

name

string

Nome da pessoa para busca. A busca é feita via full-text search (acento-insensível,
por prefixo), não uma busca exata.

string

E-mail da pessoa, para busca exata.

registration_start_date

date

Data inicial de cadastro da pessoa (pessoas.created_at), no formato "YYYY-MM-DD".
Se informado sozinho, retorna apenas os registros cadastrados nesse dia. Se informado
junto de "registration_end_date", retorna os registros cadastrados dentro do intervalo
(inclusive).

registration_end_date

date

Data final de cadastro da pessoa (pessoas.created_at), no formato "YYYY-MM-DD".
Se informado sozinho, retorna apenas os registros cadastrados nesse dia. Se informado
junto de "registration_start_date", retorna os registros cadastrados dentro do intervalo
(inclusive).

origin_id

string

Código de origem da matrícula (matriculas.origem_id) para filtragem.
Em /grades, só retorna turmas com ao menos uma matrícula correspondente, e a
lista de matrículas de cada turma retorna apenas as que correspondem ao código.
Em /enrollment-financials, só retorna as matrículas com esse código.

payment_start_date

date

Data inicial de pagamento da parcela (parcelas.data_pagamento), formato "YYYY-MM-DD", inclusive.
Com este parâmetro e/ou "payment_end_date", a busca passa a ser por parcelas pagas e a
resposta traz "paid_invoices" no lugar de "pending_invoices".

payment_end_date

date

Data final de pagamento da parcela (parcelas.data_pagamento), formato "YYYY-MM-DD", inclusive.
Não pode ser anterior a "payment_start_date".

due_start_date

date

Data inicial de vencimento da parcela (parcelas.data_vencimento), formato "YYYY-MM-DD", inclusive.
Sem filtro de pagamento, considera só parcelas vencidas e em aberto.

due_end_date

date

Data final de vencimento da parcela (parcelas.data_vencimento), formato "YYYY-MM-DD", inclusive.
Não pode ser anterior a "due_start_date".

installment_number

integer

≥ 1

Número da parcela (parcelas.parcela). Sem filtro de pagamento, considera só parcelas
vencidas e em aberto.

Responses

400

Entrada inválida

422

Parâmetro inválido: data fora do formato "YYYY-MM-DD", data final anterior à inicial
"installment_number" que não é inteiro ou "origin_id" enviado como lista. A resposta
traz a lista em "errors".

200Resposta válida