Listar faturas

Retorna todas as faturas.

Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.

Authorizations

Authorization

string

header

required

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

Query Parameters

payment_for

string

Campo para definir o dia de pagamento do boleto. Ao enviar este campo, será realizado um cálculo de valor presente (VP) para o dia de pagamento informado.

starting_after

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

ending_before

string

Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.

limit

integer

default:10

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

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

Um objeto com uma propriedade `data` que contém um array de itens começando após o item `starting_after`. Cada entrada no array é um objeto `Invoice`. Se não houver mais itens, o array estará vazio. Essa solicitação nunca deve retornar um erro.

Uma lista de faturas.

hasMore

boolean

Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.

Example:

true

data

object[]

Uma lista de faturas

Este objeto representa uma fatura.

Show child attributes

data.id

string

Identificador exclusivo para o objeto.

Example:

"inv_5f92f01728e009f403d8502e"

data.status

enum<string>

Status da fatura

Available options:

draft,

open,

paid,

void,

uncollectible

Example:

"draft"

data.payer

string

Responsável pelo pagamento. Pode ser um customer ou company.

data.beneficiary

string

Fundo que vai receber o pagamento.

data.dueDate

string

A data de vencimento da fatura.

data.amountDue

number

Valor devido.

Example:

200000

data.amountPaid

number

Valor pago.

Example:

150050

data.amountRemaining

number

Valor restante.

Example:

95000

data.type

enum<string>

Tipo do item da fatura.

Available options:

pay_off,

customer_recurring,

company_recurring

data.invoiceItems

object

Contém grupos de parcelas na fatura tanto para o pagamento, como para antecipação.

Show child attributes

data.invoiceItems.url

string

data.invoiceItems.hasMore

boolean

data.invoiceItems.data

object[]

Uma lista de itens de invoice

Representa uma parcela da fatura tanto para o pagamento, como para antecipação.

Show child attributes

data.invoiceItems.data.id

string

Identificador exclusivo para o objeto.

Example:

"item_5f92f01728e009f403d8502e"

data.invoiceItems.data.installment

string

Identificador que faz referência a uma parcela.

Example:

"inst_631a1f531a40784a5b1df6ed"

data.invoiceItems.data.invoice

string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

data.invoiceItems.data.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.

data.invoiceItems.data.discount

number

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

data.invoiceItems.data.fine

number

Valor da multa

data.invoiceItems.data.interest

number

Valor do juros

data.invoiceItems.data.description

string

Descrição do item.

data.invoiceItems.data.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.

data.invoiceItems.data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.invoiceItems.data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.invoiceItems.data.deleted

boolean

default:false

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

Example:

false

data.paymentIntents

object

Representa um conjunto de intenções de pagamento.

Show child attributes

data.paymentIntents.hasMore

boolean

data.paymentIntents.data

object[]

Uma lista de inteções de pagamento

Representa uma intenção de pagamento.

Show child attributes

data.paymentIntents.data.id

string

Identificador exclusivo para o objeto.

Example:

"pi_5f92f01728e009f403d8502e"

data.paymentIntents.data.invoice

string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

data.paymentIntents.data.status

enum<string>

default:open

Available options:

paid,

void,

open

data.paymentIntents.data.amount

number

Valor da que deverá ser pago.

data.paymentIntents.data.paymentDetails

object

Show child attributes

data.paymentIntents.data.paymentDetails.paidAt

string

data.paymentIntents.data.paymentDetails.amountPaid

number

data.paymentIntents.data.paymentDetails.metadata

object

data.paymentIntents.data.expireAt

string

data.paymentIntents.data.method

enum<string>

Available options:

boleto,

offline,

payment_method,

loan

Example:

"boleto"

data.paymentIntents.data.methodData

object

• boleto
• offline
• paymentMethod
• loan

Show child attributes

data.paymentIntents.data.methodData.type

string

default:boleto

required

data.paymentIntents.data.methodData.provider

string

default:kobana

required

data.paymentIntents.data.methodData.customer

string

required

Example:

"cust_631a2a321a40784a4b0df641"

data.paymentIntents.data.methodData.externalId

string

data.paymentIntents.data.methodData.description

string

data.paymentIntents.data.methodData.typeableLine

string

data.paymentIntents.data.methodData.url

string

data.paymentIntents.data.methodData.barcode

string

data.paymentIntents.data.methodData.ourNumber

string

data.paymentIntents.data.methodData.events

object[]

data.paymentIntents.data.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.

data.paymentIntents.data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.paymentIntents.data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.description

string

Uma string anexada ao objeto. Muitas vezes útil para exibição aos usuários.

data.history

object[]

Show child attributes

data.history.description

string

data.history.createdAt

string

data.history.status

enum<string>

Status da fatura

Available options:

draft,

open,

paid,

void,

uncollectible

Example:

"draft"

data.history.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.

data.paidAt

string

Data de pagamento da fatura.

data.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.

data.createdAt

string

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.updatedAt

string

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

data.deleted

boolean

default:false

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

Example:

false

data.createdBy

object

Esta estrutura de dados descreve a auditoria das operações de criação de faturas (invoices).

Show child attributes

data.createdBy.clientId

string

O clientId é o identificador da chave da API quando a operação de criação é realizada por um usuário ou o nome do tenant quando a operação é efetuada por um processo automatizado, evento ou outra fonte.

Example:

"key_643969122d598f5b62d15fbc"

data.createdBy.externalClientId

string

O campo externalClientId fornece informações adicionais ao clientId. É opcional e permite a inclusão de texto livre, sendo inteiramente responsabilidade do consumidor da API. Por exemplo, pode ser utilizado para incluir o identificador de um operador, empresa ou outro dado relevante.

Example:

"optr_643969122d598f5b62d15fbd"

data.updatedBy

object

Esta estrutura de dados descreve a auditoria das operações de alteração de faturas (invoices).

Show child attributes

data.updatedBy.clientId

string

O clientId é o identificador da chave da API quando a operação de alteração é realizada por um usuário ou o nome do tenant quando a operação é efetuada por um processo automatizado, evento ou outra fonte.

Example:

"key_643969122d598f5b62d15fbc"

data.updatedBy.externalClientId

string

O campo externalClientId fornece informações adicionais ao clientId. É opcional e permite a inclusão de texto livre, sendo inteiramente responsabilidade do consumidor da API. Por exemplo, pode ser utilizado para incluir o identificador de um operador, empresa ou outro dado relevante.

Example:

"optr_643969122d598f5b62d15fbd"