GET
/
v1
/
invoices
/
{invoice}
/
invoice-items
/
{invoice_item}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

invoice_item
string
required

ID do item da fatura

invoice
string
required

ID da fatura

Query Parameters

expand
string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

Response

200 - application/json
id
string

Identificador exclusivo para o objeto.

installment
string

Identificador que faz referência a uma parcela.

invoice
string

Identificador que faz referência a uma fatura.

amount
number

Valor da parcela que será considerado como pago. Pode ser menor (para realizar pagamento parcial da parcela) ou igual ao valor original da parcela.

discount
number

Valor do desconto que será dado na fatura referente a parcela informada

fine
number

Valor da multa

interest
number

Valor do juros

description
string

Descrição do item.

purposeKey
string

Chave de propósito do item da fatura.

metadata
object

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAt
string

Data de criação do objeto

updatedAt
string

Data de alteração do objeto

deleted
boolean
default: false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

createdBy
object
updatedBy
object
Obter faturaListar itens da fatura