Invoice

Este objeto representa uma fatura.

id

string

Identificador exclusivo para o objeto.

status

enum<string>

Status da fatura

Available options:

draft,

open,

paid,

void,

uncollectible

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 do item da fatura.

Available options:

pay_off,

customer_recurring,

company_recurring

invoiceItems

object

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

Show child attributes

paymentIntents

object

Representa um conjunto de intenções de pagamento.

Show child attributes

description

string

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

history

object[]

Show child attributes

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

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

Show child attributes

updatedBy

object

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

Show child attributes