Listar/Buscar Faturas

get

https://api.iugu.com/v1/invoices

Retorna uma lista das faturas em sua conta ordenadas pela data de criação, da mais à menos recente. Por padrão, este endpoint retorna no máximo 100 registros. O campo "totalItems" contém sempre a quantidade total de faturas cadastradas, independentemente dos parâmetros de pesquisa utilizados, e o resultado da pesquisa fica sempre dentro de "items".

Query Params

limit

int32

Limita o número de registros retornados em até 100, que é o padrão de retorno desta chamada. Também utilizado em paginação.

start

int32

Quantos registros pular do início da pesquisa, usado para paginação.

created_at_from

date-time

Registros criados a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

created_at_to

date-time

Registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

paid_at_from

date-time

Registros pagos a partir dessa data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

paid_at_to

date

Registros pagos até esta data passada no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

due_date

date

Data de Vencimento (AAAA-MM-DD)

query

string

Neste parâmetro pode ser passado um texto para pesquisa como e-mail, nome, anotações e o order_id. Necessário usar a paginação (limit, start, etc)

updated_since

date-time

Registros atualizados desde o momento passado no parâmetro. Formato (AAAA-MM-DDThh:mm:ss-03:00)

customer_id

string

ID do Cliente

status_filter

string

Usado para filtrar as faturas pelo status (pending, paid, canceled, partially_paid, externally_paid, refunded, expired, authorized)

Responses

Language

Credentials

Query

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400