Listar faturas

get

https://{tenant}.{environment}.educbank.com.br/api/ebpay/invoice

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

externalId

string

Filtrar por ExternalId

payerCpfCnpj

string

Retorna faturas onde o CPF/CNPJ do pagador for igual ao informado

payerName

string

Retorna faturas onde o nome do pagador for igual ao informado

enrollmentId

uuid

Retorna Faturas relacionadas à matrícula informada

initialDate

date-time

Data inicial no formato "AAAA-MM-DD"

referenceDate

string

Data inicial no formato "AAAA-MM"

endDate

date-time

Data final no formato "AAAA-MM-DD"

filterBy

string

Determina qual é o campo na qual as datas de início e fim serão aplicadas. ex: duedate, cancellationdate, paymentdate

studentExternalId

string

Id externo do aluno no sistema solicitante

state

string

Retorna faturas onde o status for igual ao informado. ex: Generated, Paid, Pending, Overdue

code

string

Retorna faturas onde o Code for igual ao informado.

string

Retorna faturas onde o Id for igual ao informado.

ebpayPlan

string

enum

Retorna faturas onde o Id for igual ao informado.

Allowed:

sortType

string

Determina como ordernar a lista em relação ao "sortType". ex: asc, desc

sorting

string

Determina a ordenação pelo campo informado. ex: studentname, schoolname, duedate

globalFilter

string

Podem ser passado os valores dos seguintes campos: Número do externalId, Nome do estudante.

showCanceledInvoices

boolean

Determina a exibição de faturas canceladas. True para exibir faturas canceladas

schoolId

uuid

paymentMethod

string

digitableLine

string

Retorna faturas onde a linha digitável for igual ao informado

tenantId

uuid

educbankPlanId

uuid

productId

uuid

categoryCode

string

enum

skipCount

int32

0 to 2147483647

maxResultCount

int32

1 to 2147483647

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

501Not Implemented