Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
required

Número da página, iniciando em 1.

Required range: 1 <= x <= 9007199254740991
Example:

1

pageSize
integer
default:50
required

Tamanho da página. Máximo de 200.

Required range: 1 <= x <= 200
Example:

50

status
enum<string>[]

Filtra pela situação da fatura. Repita o parâmetro para incluir múltiplos valores (?status=pending&status=late). late é derivado: casa faturas abertas cuja data de vencimento já passou.

Available options:
pending,
paid,
failed,
voided,
refunded,
charged-back,
late
Example:

"pending"

product
enum<string>[]

Filtra pelo produto faturado. Repita o parâmetro para incluir múltiplos valores.

Available options:
telecom,
asset-management,
saas-management
Example:

"telecom"

monthYear
string

Filtra faturas de um mês de referência específico, no formato YYYY-MM. Não pode ser combinado com fromMonthYear/toMonthYear.

Pattern: ^\d{4}-\d{2}$
Example:

"2026-07"

fromMonthYear
string

Filtra faturas com mês de referência a partir deste mês (inclusivo), no formato YYYY-MM.

Pattern: ^\d{4}-\d{2}$
Example:

"2026-01"

toMonthYear
string

Filtra faturas com mês de referência até este mês (inclusivo), no formato YYYY-MM.

Pattern: ^\d{4}-\d{2}$
Example:

"2026-07"

sortBy
enum<string>

Campo usado para ordenar o resultado. Padrão: dueDate.

Available options:
dueDate,
referenceMonth,
amountCents,
status,
createdAt
Example:

"dueDate"

sortOrder
enum<string>

Direção da ordenação. Padrão: desc.

Available options:
asc,
desc
Example:

"desc"

Response

data
object[]
required
pagination
object
required