Invoice

Este objeto representa uma fatura.

idstring

Identificador exclusivo para o objeto.

Example: inv_5f92f01728e009f403d8502e

statusstring

Status da fatura

Possible values: [draft, open, paid, void, uncollectible, refunded]

Example: draft

payerstring

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

beneficiarystring

Fundo que vai receber o pagamento.

dueDatedate

A data de vencimento da fatura.

amountDuedouble

Valor devido.

Example: 200000

amountPaiddouble

Valor pago.

Example: 150050

amountRemainingdouble

Valor restante.

Example: 95000

typestring

Tipo da fatura

Possible values: [pay_off, customer_recurring, company_recurring]

Example: pay_off

purposestring

Propósito da fatura

Possible values: [cancellation, customer_refinance, employment_terminated, external_collector, no_funds, regular, requested_by_company, requested_by_customer, requested_by_insurance, internal_collector]

Example: regular

invoiceItems object

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

urlstring

hasMoreboolean

data object[]

Uma lista de itens de invoice

Array [

idstring

Identificador exclusivo para o objeto.

Example: item_5f92f01728e009f403d8502e

installmentstring

Identificador que faz referência a uma parcela.

Example: inst_631a1f531a40784a5b1df6ed

invoicestring

Identificador que faz referência a uma fatura.

Example: inv_631a1f531a40784a4b0df5ed

amountdouble

Valor da parcela que será considerado como pago. Pode ser menor (para realizar pagamento parcial da parcela) ou igual ao valor original da parcela.

discountdouble

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

finedouble

Valor da multa

interestdouble

Valor do juros

descriptionstring

Descrição do item.

purposeKeystring

Chave de propósito do item da fatura.

metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deletedboolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

paymentIntents object

Representa um conjunto de intenções de pagamento.

hasMoreboolean

data object[]

Uma lista de inteções de pagamento

Array [

idstring

Identificador exclusivo para o objeto.

Example: pi_5f92f01728e009f403d8502e

invoicestring

Identificador que faz referência a uma fatura.

Example: inv_631a1f531a40784a4b0df5ed

statusstring

Possible values: [paid, void, open]

Default value: open

amountdouble

Valor da que deverá ser pago.

paymentDetails object

paidAtdate

amountPaiddouble

metadataobject

expireAtdate

methodstring

Possible values: [pix, boleto, offline, payment_method, loan]

Example: boleto

methodData object

anyOf

boleto

offline

paymentMethod

loan

metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

]

descriptionstring

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

history object[]

Array [

descriptionstring

createdAtdate-time

statusstring

Status da fatura

Possible values: [draft, open, paid, void, uncollectible, refunded]

Example: draft

metadataobject

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.

]

paidAtdate

Data de pagamento da fatura.

paymentSourcestring

Identificador da origem do pagamento.

Example: inv_5f92f01728e009f403d8502e

preventTransferboolean

Identifica se a fatura pode desencadear distribuição de dinheiro. Padrão: false.

Example: false

metadataobject

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.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deletedboolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Invoice

{
  "id": "inv_5f92f01728e009f403d8502e",
  "status": "draft",
  "payer": "string",
  "beneficiary": "string",
  "dueDate": "2024-07-29",
  "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": 0,
        "discount": 0,
        "fine": 0,
        "interest": 0,
        "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": 0,
        "paymentDetails": {
          "paidAt": "2024-07-29",
          "amountPaid": 0,
          "metadata": {}
        },
        "expireAt": "2024-07-29",
        "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": "2024-07-29T15:51:28.071Z",
      "status": "draft",
      "metadata": {}
    }
  ],
  "paidAt": "2024-07-29",
  "paymentSource": "inv_5f92f01728e009f403d8502e",
  "preventTransfer": false,
  "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"
  }
}