PagnovoPagnovodocs
Dashboard

Referência da API

Listar faturas

Lista paginada de Invoices da sua conta, ordenadas por `createdAt DESC`. Inclui filtros úteis (status, customerId, subscriptionId, intervalo de datas, busca) e retorna **totais agregados** dos filtros aplicados (`totals.amount`, `totals.amountPaid` em centavos).

GET/v2/invoices
Paginação 0-indexed
page `page=0` é a primeira página. Default: 0.

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Parâmetros

status'DRAFT' | 'PENDING' | 'PAID' | 'OVERDUE' | 'REFUNDED' | 'CANCELED' | 'EXPIRED' (query)opcional

Filtra por status específico.

Exemplo: PAID

customerIdstring (query, UUID)opcional

Filtra invoices de um Customer específico.

Exemplo: c8a5f4d2-...

subscriptionIdstring (query, UUID)opcional

Filtra invoices geradas por uma Subscription.

Exemplo: sub_abc123-...

startDatestring (query, ISO 8601)opcional

Limite inferior do `createdAt` (>= `startDate`, início do dia).

Exemplo: 2026-06-01

endDatestring (query, ISO 8601)opcional

Limite superior do `createdAt` (< fim do dia de `endDate`).

Exemplo: 2026-06-30

searchstring (query)opcional

Busca case-insensitive em `description` e match parcial no `id`.

Exemplo: consultoria

pagenumber (query, 0-indexed)opcional

Página. Default: 0.

Exemplo: 0

limitnumber (query)opcional

Por página. Default: 20. Máximo: 100.

Exemplo: 20

Respostas

200

Lista paginada de Invoices com Customer/Subscription resumidos. totals.amount e totals.amountPaid agregam os filtros aplicados (em centavos).

JSON
{
  "result": [
    {
      "id": "inv_111aaa",
      "status": "PAID",
      "description": "Mensalidade Setembro",
      "amount": 4900,
      "amountPaid": 4900,
      "dueDate": "2026-09-15T00:00:00.000Z",
      "expiresAt": "2026-10-15T00:00:00.000Z",
      "paidAt": "2026-09-12T14:32:00.000Z",
      "canceledAt": null,
      "createdAt": "2026-09-01T00:00:00.000Z",
      "hostedUrl": "https://checkout.pagnovo.com/i/inv_111aaa",
      "customer": {
        "id": "c8a5f4d2-...",
        "name": "João Silva",
        "document": "12345678901",
        "email": "joao@exemplo.com"
      },
      "subscription": { "id": "sub_abc123-..." }
    }
  ],
  "totalCount": 47,
  "totals": {
    "amount": 230300,
    "amountPaid": 215600
  }
}

Exemplos

cURL
# Vencidas
curl -X GET "https://api.pagnovo.com/v2/invoices?status=OVERDUE" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"

# Faixa de datas
curl -X GET "https://api.pagnovo.com/v2/invoices?startDate=2026-06-01&endDate=2026-06-30" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"