Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
invoices

Retorna uma lista de notas fiscais.

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

Atributos para busca

<code>id</code>, <code>customer_id</code>, <code>bill_id</code>, <code>integration_id</code>, <code>status</code>, <code>integration_invoice_id</code>, <code>integration_reference</code>, <code>issued_at</code>, <code>created_at</code> e <code>integration_type</code>.

get/v1/invoices

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'customer_id' | 'bill_id' | 'integration_id' | 'status' | 'integration_invoice_id' | 'integration_reference' | 'issued_at' | 'created_at' | 'integration_type'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da nota fiscal

amountnumber required

Valor da nota fiscal

status'processing' | 'success' | 'failure' | 'canceled' | 'waiting' | 'processing_cancel' | 'cancel_failure' | 'scheduled' required

Status da nota fiscal

integration_invoice_idstring required

Código externo da integração

integration_referencestring required

Número ou referência da nota fiscal na instituição governamental

print_urlstring

URL para impressão da nota fiscal

descriptionstring

Descrição usada para a geração nota fiscal. Se não informada, a configuração padrão da integração será usada

settingsstring

Configurações adicionais usadas na integração

issued_atstring

Data e hora da emissão da nota fiscal

accrued_onstring

Data de competência da nota fiscal

scheduled_atstring

Data e hora do agendamento da nota fiscal

created_atstring required

Data e hora da geração da nota fiscal

updated_atstring required

Data e hora da última atualização da nota fiscal