Invoices

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,

refunded

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 da fatura

Available options:

pay_off,

customer_recurring,

company_recurring

Example:

"pay_off"

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

Example:

"regular"

data.invoiceItems

object

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

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.

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

string

Chave de propósito do item da fatura.

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

object

data.invoiceItems.data.updatedBy

object

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

data.paymentIntents.data.expireAt

string

data.paymentIntents.data.method

enum<string>

Available options:

pix,

boleto,

offline,

payment_method,

loan

Example:

"boleto"

data.paymentIntents.data.methodData

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

object

data.paymentIntents.data.updatedBy

object

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

data.updatedBy

object

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",
      "purpose": "regular",
      "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>",
            "purposeKey": "<string>",
            "metadata": {},
            "createdAt": "2023-08-25T22:38:41.134Z",
            "updatedAt": "2023-08-25T22:38:41.134Z",
            "deleted": false,
            "createdBy": {
              "clientId": "client_identifier",
              "externalClientId": "<string>",
              "app": "backoffice"
            },
            "updatedBy": {
              "clientId": "client_identifier",
              "externalClientId": "<string>",
              "app": "backoffice"
            }
          }
        ]
      },
      "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>",
              "ourNumberRaw": "<string>",
              "customer": "cust_631a2a321a40784a4b0df641",
              "events": [
                {}
              ]
            },
            "metadata": {},
            "createdAt": "2023-08-25T22:38:41.134Z",
            "updatedAt": "2023-08-25T22:38:41.134Z",
            "createdBy": {
              "clientId": "client_identifier",
              "externalClientId": "<string>",
              "app": "backoffice"
            },
            "updatedBy": {
              "clientId": "client_identifier",
              "externalClientId": "<string>",
              "app": "backoffice"
            }
          }
        ]
      },
      "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": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      },
      "updatedBy": {
        "clientId": "client_identifier",
        "externalClientId": "<string>",
        "app": "backoffice"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos