Paylogos

Listar faturas

Em desenvolvimento

GET

https://api.paylogos.com.br/v1/invoices

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.paylogos.com.br/v1/invoices?limit=20&sort=time-descending&offset=0&date_range&date_range[gt]&date_range[gte]&date_range[lt]&date_range[lte]'

Response Example

200 - Exemplo 1

{
    "resource": "string",
    "uri": "string",
    "limit": 0,
    "offset": 0,
    "has_more": true,
    "query_count": 0,
    "total": 0,
    "items": [
        {
            "id": "string",
            "subscription": "string",
            "on_behalf_of": "string",
            "customer": "string",
            "invoice_customer": {
                "uuid": "string",
                "first_name": "string",
                "last_name": "string",
                "taxpayer_id": "string",
                "email": "string"
            },
            "description": "string",
            "payment_methods": "credit",
            "due_date": "2019-08-24",
            "expiration_date": "2019-08-24",
            "amount": 0,
            "currency": "string",
            "paid_at": "2019-08-24T14:15:22Z",
            "voided_at": "2019-08-24T14:15:22Z",
            "retries": 0,
            "max_retries": 0,
            "status": "pending",
            "resource": "string",
            "metadata": {},
            "created_at": "string",
            "updated_at": "string",
            "uri": "string"
        }
    ]
}

Requisição

Parâmetros Query

limit

number

opcional

Limita o número de objetos retornados, podendo ser entre 1 e 100

Exemplo:

sort

string

opcional

Determinar como ordenar a lista em relação a data de criação do objeto

Padrão:

time-descending

Exemplo:

time-descending

offset

number

opcional

Determina o ponto de inicio dos registros retornados

Exemplo:

date_range

number

opcional

Filtro na lista base de objetos pela data de criação. O valor pode ser uma string com um horário em UTC timestamp, ou pode ser uma lista com os parametros abaixo

date_range[gt]

number

opcional

Retorna valores onde a data maior que o timestamp informado

date_range[gte]

number

opcional

Retorna valores onde a data for maior ou igual que o timestamp informado

date_range[lt]

number

opcional

Retorna valores onde a data for menor que o timestamp informado

date_range[lte]

number

opcional

Retorna valores onde a data for menor ou igual que o timestamp informado

Respostas

🟢200search results matching criteria

application/json

Body

resource

string

opcional

uri

string

opcional

limit

number

opcional

offset

number

opcional

has_more

boolean

opcional

query_count

number

opcional

total

number

opcional

items

array [object {21}]

opcional

string

opcional

subscription

string

opcional

on_behalf_of

string

opcional

customer

string

opcional

invoice_customer

object

opcional

description

string

opcional

Descrição da assinatura

payment_methods

string

opcional

Métodos de pagamentos

Padrão:

credit

Exemplo:

credit

due_date

string <date>

opcional

Data da cobrança

expiration_date

string <date>

opcional

Data de vencimento

amount

integer

opcional

Valor em centavos

currency

string

opcional

Moeda utilizada

paid_at

string <date-time>

opcional

Data do pagamento

voided_at

string <date-time>

opcional

Data do cancelamento

retries

integer

opcional

Quantidade de vezes que tentou efetuar o pagamento

max_retries

integer

opcional

Quantidade máxima de vezes que se deve tentar efetuar o pagamento

status

string

opcional

Status da cobrança

Exemplo:

pendingpaidover-duecanceledfailed

resource

string

opcional

metadata

object

opcional

created_at

string

opcional

Criado em

updated_at

string

opcional

Atualizado em

uri

string

opcional

🟠400bad input parameter

Modificado em 2025-06-11 21:02:10

Página anterior

Criar uma fatura avulsa

Próxima página

Listar os detalhes de uma fatura pelo identificador