Invoices - Base39

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.

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.

data.paymentIntents

object

Representa um conjunto de intenções de pagamento.

data.paymentIntents.hasMore

boolean

data.paymentIntents.data

object[]

Uma lista de inteções de pagamento

Representa uma intenção de pagamento.

data.description

string

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

data.history

object[]

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

data.updatedBy

object

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

Invoice Themes

{
  "hasMore": true,
  "data": [
    {
      "id": "inv_5f92f01728e009f403d8502e",
      "status": "draft",
      "payer": "<string>",
      "beneficiary": "<string>",
      "dueDate": "2023-12-25",
      "amountDue": 200000,
      "amountPaid": 150050,
      "amountRemaining": 95000,
      "type": "pay_off",
      "invoiceItems": {
        "url": "<string>",
        "hasMore": true,
        "data": [
          {
            "id": "item_5f92f01728e009f403d8502e",
            "installment": "inst_631a1f531a40784a5b1df6ed",
            "invoice": "inv_631a1f531a40784a4b0df5ed",
            "amount": 123,
            "discount": 123,
            "fine": 123,
            "interest": 123,
            "description": "<string>",
            "metadata": {},
            "createdAt": "2023-08-25T22:38:41.134Z",
            "updatedAt": "2023-08-25T22:38:41.134Z",
            "deleted": false
          }
        ]
      },
      "paymentIntents": {
        "hasMore": true,
        "data": [
          {
            "id": "pi_5f92f01728e009f403d8502e",
            "invoice": "inv_631a1f531a40784a4b0df5ed",
            "status": "open",
            "amount": 123,
            "paymentDetails": {
              "paidAt": "2023-12-25",
              "amountPaid": 123,
              "metadata": {}
            },
            "expireAt": "2023-12-25",
            "method": "boleto",
            "methodData": {
              "externalId": "<string>",
              "type": "boleto",
              "provider": "kobana",
              "description": "<string>",
              "typeableLine": "<string>",
              "url": "<string>",
              "barcode": "<string>",
              "ourNumber": "<string>",
              "customer": "cust_631a2a321a40784a4b0df641",
              "events": [
                {}
              ]
            },
            "metadata": {},
            "createdAt": "2023-08-25T22:38:41.134Z",
            "updatedAt": "2023-08-25T22:38:41.134Z"
          }
        ]
      },
      "description": "<string>",
      "history": [
        {
          "description": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "status": "draft",
          "metadata": {}
        }
      ],
      "paidAt": "2023-12-25",
      "metadata": {},
      "createdAt": "2023-08-25T22:38:41.134Z",
      "updatedAt": "2023-08-25T22:38:41.134Z",
      "deleted": false,
      "createdBy": {
        "clientId": "key_643969122d598f5b62d15fbc",
        "externalClientId": "optr_643969122d598f5b62d15fbd"
      },
      "updatedBy": {
        "clientId": "key_643969122d598f5b62d15fbc",
        "externalClientId": "optr_643969122d598f5b62d15fbd"
      }
    }
  ]
}

Referências