InvoiceItems

Uma lista de itens da fatura.

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

Representa uma parcela da fatura tanto para o pagamento, como para antecipação.

data.id

string

Identificador exclusivo para o objeto.

Example:

"item_5f92f01728e009f403d8502e"

data.installment

string

Identificador que faz referência a uma parcela.

Example:

"inst_631a1f531a40784a5b1df6ed"

data.invoice

string

Identificador que faz referência a uma fatura.

Example:

"inv_631a1f531a40784a4b0df5ed"

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

number

Valor do desconto que será dado na fatura referente a parcela informada

data.fine

number

Valor da multa

data.interest

number

Valor do juros

data.description

string

Descrição do item.

data.purposeKey

string

Chave de propósito do item 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

InvoiceItem FileLink

{
  "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"
      }
    }
  ]
}

Empréstimos

Empresas

Clientes

Fundos

Eventos

Cobrança

Arquivos

Configurações

Entidades

Automações

Modelos