GET
/
v1
/
invoices
/
{invoice}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

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.

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.

Response

200 - application/json
id
string

Identificador exclusivo para o objeto.

status
enum<string>

Status da fatura

Available options:
draft,
open,
paid,
void,
uncollectible,
refunded
payer
string

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

beneficiary
string

Fundo que vai receber o pagamento.

dueDate
string

A data de vencimento da fatura.

amountDue
number

Valor devido.

amountPaid
number

Valor pago.

amountRemaining
number

Valor restante.

type
enum<string>

Tipo da fatura

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

Propósito da fatura

Available options:
cancellation,
customer_refinance,
employment_terminated,
external_collector,
no_funds,
regular,
requested_by_company,
requested_by_customer,
requested_by_insurance
invoiceItems
object

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

paymentIntents
object

Representa um conjunto de intenções de pagamento.

description
string

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

history
object[]
paidAt
string

Data de pagamento 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
Listar faturasObter item da fatura