Listar faturas

GET 
/v1/invoices

Retorna todas as faturas, ordenadas por data de criação, do mais recente para o mais antigo.

Request

Query Parameters

payer string

Um filtro com base no campo payer. O valor deve ser uma string ou uma lista separada por vírgula.

Examples:

single

Valor único

Example: cust_631f61201fc21101870d22a2

list

Lista

Example: cust_631f61201fc21101870d22a2,cust_636a54c6beba11ba7c0637f6

due_date_start date
Um filtro com base no campo dueDate. O valor deve ser uma data.
Example: 2022-12-01
due_date_end date
Um filtro com base no campo dueDate. O valor deve ser uma data.
Example: 2023-01-01
status any
O status da invoice. O valor deve ser uma string.
Example: active
type any
Tipo da fatura. O valor deve ser uma string.
Example: active
purpose any
O propósito da invoice. O valor deve ser uma string.
Example: active
beneficiary string

O beneficiário (fundo) da fatura. O valor deve ser uma string ou uma lista separada por vírgula.

Examples:

single

Valor único

Example: fund_5f92f01728e009f403d8502e

list

Lista

Example: fund_5f92f01728e009f403d8502e,fund_6671ff8a96f20b37da55d889

starting_after string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
ending_before string
Um cursor para uso na paginação. starting_after é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir starting_after=obj_foo para buscar a próxima página da lista.
Example: obj_5f92f01728e009f403d8502e
limit integer
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Default value: 10
Example: 10
fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

exclusao

Retorna todos os campos, exceto `id`.

Example: -id

expand string
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Example: data.loan
deleted boolean
Um filtro com base no campo deleted. O valor deve ser um booleano.
Example: true
paid_at_start date
Um filtro com base no campo paidAt. O valor deve ser uma data.
Example: 2022-12-01
paid_at_end date
Um filtro com base no campo paidAt. O valor deve ser uma data.
Example: 2022-12-01
id string

ID da fatura. O valor deve ser uma string ou uma lista separada por vírgula.

Examples:

single

Valor único

Example: inv_5f92f01728e009f403d8502e

list

Lista

Example: inv_5f92f01728e009f403d8502e,inv_5f92f01728e009f403d2512e

Responses

200

Retorna um objeto com data contendo um array de Invoice a partir do item starting_after. Se não houver mais itens, o array estará vazio. Nunca retorna um erro.

application/json

Schema

Schema

hasMoreboolean
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

Array [

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]

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

externalIdstring

typestringrequired

Default value: boleto

providerstring

Provedor utilizado para os boletos

Possible values: [kobana, default, test_only]

Example: kobana

descriptionstring

typeableLinestring

urlstring

barcodestring

ourNumberstring

ourNumberRawstring

customerstring

Example: cust_631a2a321a40784a4b0df641

eventsobject[]

offline

typestringrequired

Default value: offline

descriptionstring

paymentMethod

typestringrequired

Default value: paymentMethod

paymentMethodstringrequired

Example: pm_631a2a321a40784a4b0df641

descriptionstring

loan

loanstringrequired

Example: loan_645122117022fa52620deb01

typestringrequired

Default value: loan

descriptionstring

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.

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

]

Example (from schema)

{
  "hasMore": true,
  "data": [
    {
      "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",
      "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"
      }
    }
  ]
}