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.

Path Parameters

id
string
required

Response

id
string
required

Identificador da fatura na plataforma Salvy.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

companyId
string
required

Identificador da empresa dona da fatura. Útil ao listar faturas de várias empresas com uma chave de organização.

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"123e4567-e89b-12d3-a456-426614174001"

status
enum<string>
required

Situação da fatura. Faturas em atraso permanecem pending ou failed; use isLate para identificá-las.

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

"pending"

isLate
boolean
required

Verdadeiro quando a fatura está aberta (pending ou failed) e a data de vencimento já passou.

Example:

false

amountCents
integer
required

Valor total da fatura, em centavos.

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

129900

dueDate
string<date>
required

Data de vencimento da fatura.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Example:

"2026-08-10"

referenceMonth
string | null
required

Mês de referência do consumo faturado, no formato YYYY-MM. Nulo em faturas antigas, anteriores ao registro do mês de referência.

Example:

"2026-07"

createdAt
string<date-time>
required

Data de criação da fatura.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Example:

"2026-08-01T03:00:00.000Z"

items
object[]
required

Itens que compõem o valor da fatura.

nfe
object | null
required

Nota fiscal emitida para a fatura. Nulo enquanto a nota não foi emitida, e em faturas cuja nota foi cancelada.