GET
/
v1
/
invoices

Authorizations

Authorization
string
headerrequired

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

Query Parameters

payer
string

Um filtro com base no campo payer. O valor deve ser uma string ou uma lista separada por vírgula.

due_date_start
string

Um filtro com base no campo dueDate. O valor deve ser uma data.

due_date_end
string

Um filtro com base no campo dueDate. O valor deve ser uma data.

status
enum<string>

O status da invoice. O valor deve ser uma string.

Available options:
draft,
open,
paid,
void,
uncollectible,
refunded
type
enum<string>

Tipo da fatura. O valor deve ser uma string.

Available options:
pay_off,
customer_recurring,
company_recurring
purpose
enum<string>

O propósito da invoice. O valor deve ser uma string.

Available options:
cancellation,
customer_refinance,
employment_terminated,
external_collector,
no_funds,
regular,
requested_by_company,
requested_by_customer,
requested_by_insurance
beneficiary
string

O beneficiário (fundo) da fatura. O valor deve ser uma string ou uma lista separada por vírgula.

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

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

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.

deleted
boolean

Um filtro com base no campo deleted. O valor deve ser um booleano.

paid_at_start
string

Um filtro com base no campo paidAt. O valor deve ser uma data.

paid_at_end
string

Um filtro com base no campo paidAt. O valor deve ser uma data.

id
string

ID da fatura. O valor deve ser uma string ou uma lista separada por vírgula.

Response

200 - application/json
hasMore
boolean

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

data
object[]

Uma lista de faturas

Pagar intenção de pagamentoObter fatura