Pular para o conteúdo principal

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:

    Valor único

    Example: cust_631f61201fc21101870d22a2

    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:

    Valor único

    Example: fund_5f92f01728e009f403d8502e

    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:

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

    Example: id,createdAt

    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:

    Valor único

    Example: inv_5f92f01728e009f403d8502e

Responses​

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.

Schema

    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

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: inv_5f92f01728e009f403d8502e
    status string

    Status da fatura

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

    Example: draft
    payer string

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

    beneficiary string

    Fundo que vai receber o pagamento.

    dueDate date

    A data de vencimento da fatura.

    amountDue double

    Valor devido.

    Example: 200000
    amountPaid double

    Valor pago.

    Example: 150050
    amountRemaining double

    Valor restante.

    Example: 95000
    type string

    Tipo da fatura

    Possible values: [pay_off, customer_recurring, company_recurring]

    Example: pay_off
    purpose string

    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.

    url string
    hasMore boolean

    data

    object[]

    Uma lista de itens de invoice

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: item_5f92f01728e009f403d8502e
    installment string

    Identificador que faz referência a uma parcela.

    Example: inst_631a1f531a40784a5b1df6ed
    invoice string

    Identificador que faz referência a uma fatura.

    Example: inv_631a1f531a40784a4b0df5ed
    amount double

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

    discount double

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

    fine double

    Valor da multa

    interest double

    Valor do juros

    description string

    Descrição do item.

    purposeKey string

    Chave de propósito do item da fatura.

    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.

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

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

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]

    • paymentIntents

    object

    Representa um conjunto de intenções de pagamento.

    hasMore boolean

    data

    object[]

    Uma lista de inteções de pagamento

  • Array [

    • id string

    Identificador exclusivo para o objeto.

    Example: pi_5f92f01728e009f403d8502e
    invoice string

    Identificador que faz referência a uma fatura.

    Example: inv_631a1f531a40784a4b0df5ed
    status string

    Possible values: [paid, void, open]

    Default value: open
    amount double

    Valor da que deverá ser pago.

    paymentDetails

    object

    paidAt date
    amountPaid double
    metadata object
    expireAt date
    method string

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

    Example: boleto

    methodData

    object

    anyOf

    externalId string
    type stringrequired
    Default value: boleto
    provider string

    Provedor utilizado para os boletos

    Possible values: [kobana, default, test_only]

    Example: kobana
    description string
    typeableLine string
    url string
    barcode string
    ourNumber string
    ourNumberRaw string
    customer string
    Example: cust_631a2a321a40784a4b0df641
    events object[]
    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.

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

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

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]

    • description string

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

    history

    object[]

  • Array [

    • description string
    createdAt date-time
    status string

    Status da fatura

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

    Example: draft
    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.

  • ]

    • paidAt date

    Data de pagamento da fatura.

    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.

    createdAt date-time

    Data de criação do objeto

    Example: 2023-08-25T22:38:41.134Z
    updatedAt date-time

    Data de alteração do objeto

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

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

    Default value: false
    Example: false

    createdBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

    updatedBy

    object

    clientId string

    Identificador do cliente que criou a assinatura.

    Example: client_identifier
    externalClientId string

    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.

    app string

    Nome da aplicação que criou a assinatura.

    Example: backoffice

  • ]

Loading...