VIvindi
bills

Retorna uma lista de faturas.

Utilize este método para listar as faturas associadas à sua conta na Vindi. Leia a documentação sobre paginação e filtros de busca.

Atributos para busca

<code>id</code>, <code>code</code>, <code>installments</code>, <code>period_id</code>, <code>subscription_id</code>, <code>customer_id</code>, <code>amount</code>, <code>status</code>, <code>payment_method_id</code>, <code>seen_at</code>, <code>due_at</code>, <code>billing_at</code>, <code>created_at</code> e <code>updated_at</code>.

Itens da fatura

Uma fatura é composta de vários itens representados no array bill_items. Este endpoint lista apenas os 25 primeiros itens de cada fatura. Caso queira listar mais itens de uma fatura, utilize o método da API GET /bills/{id}/bill_items.

get/v1/bills

Request

  • Base URL
    //app.vindi.com.br/api (relative, and the document’s source URL is not known)
  • URL
    //app.vindi.com.br/api/v1/bills
  • Auth
    HTTP basic

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'code' | 'installments' | 'period_id' | 'subscription_id' | 'customer_id' | 'amount' | 'status' | 'payment_method_id' | 'seen_at' | 'due_at' | 'billing_at' | 'created_at' | 'updated_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da fatura

codestring

Código externo para referência via API

amountnumber required

Valor da fatura

installmentsinteger required

Número de parcelas

status'review' | 'pending' | 'paid' | 'canceled' | 'scheduled' required

Status da fatura

seen_atstring required

Última visualização da fatura

billing_atstring

Data opcional de emissão da cobrança

due_atstring

Data de vencimento da fatura

urlstring required

URL para pagamento da fatura

created_atstring required

Data e hora da geração da fatura

updated_atstring required

Data e hora da última atualização da fatura

metadataobject

Metadados da fatura

Changes

No recorded changes to this operation across all 1 revision of this API.