Skip to main content

List Invoices

GET/rest/invoices

Retrieve a paginated list of invoices with filtering options. This endpoint allows you to list and search through all invoices across your Pay by Link channels.

Query Parameters​

url_nameString
Filter by channel URL name. Returns only invoices from the specified channel.
statusString
Filter by status: pending, paid, partly_paid, processing
created_at_fromString
Filter invoices created from this date onwards (YYYY-MM-DD format)
created_at_toString
Filter invoices created up to this date (YYYY-MM-DD format)
pageInteger
Page number for pagination (default: 1)
Example RequestHTTP
GET /rest/invoices?url_name=my-shop&status=pending&created_at_from=2024-01-01
Authorization: Basic <base64(api_key:api_password)>

Response​

Each entry in invoices uses the same wrapper shape as Get Invoice: an invoice object plus message, error, paylink, and qrcode.

invoicesArray
Array of invoice response wrappers (up to 50 per page). Each entry contains invoice (same fields as Get Invoice), message, error, paylink, and qrcode.
paginationObject
Pagination metadata including page, items, count, pages, from, to, prev, next
errorString
Error details (null on success)
messageString
Success or error message
Example ResponseJSON
{
"error": null,
"message": "Invoices have been successfully retrieved.",
"invoices": [
  {
    "invoice": {
      "status": "pending",
      "active": true,
      "created_at": "2024-08-14T07:50:20Z",
      "updated_at": "2024-08-14T07:50:20Z",
      "debt_claim_number": "INV-2024-001",
      "print_date": "2024-08-14",
      "first_name": "Peter",
      "last_name": "Struwwel",
      "address": "Teststr 5",
      "address2": "12B",
      "postal_code": "10178",
      "city": "Berlin",
      "country": "Germany",
      "email": "dev@betterpayment.de",
      "amount": 10.55,
      "amount_cents": 1055,
      "currency": "EUR",
      "description": "Payment for drinks",
      "customer_id": "123456",
      "state": "BE",
      "phone": "+4917143214321",
      "redirect_after_payments": false,
      "success_url": "https://example.com/success",
      "error_url": "https://example.com/error",
      "tax_id": "123456789",
      "company": "Example GmbH",
      "expires_in": 24,
      "expires_in_unit": "hours",
      "expired": false,
      "uuid": "f34b3b2f-2680-4d62-a0c9-ce2e50ddbb8a",
      "channel_id": 123,
      "import_id": 456,
      "locale": "de",
      "effective_locale": "de",
      "send_initial_email": true,
      "initial_email_type": "initial",
      "effective_initial_email_type": "initial",
      "last_email": {
        "email_type": "reminder",
        "status": "sent",
        "sent_at": "2026-05-20T14:30:00Z",
        "recipient_email": "dev@betterpayment.de",
        "locale": "de"
      },
      "id": 789
    },
    "message": "Invoice has been successfully created.",
    "error": null,
    "paylink": "http://yourchannel.jetztzahlen.de/pay/f34b3b2f-2680-4d62-a0c9-ce2e50ddbb8a",
    "qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
  }
],
"pagination": {
  "page": 1,
  "items": 50,
  "count": 150,
  "pages": 3,
  "from": 1,
  "to": 50,
  "prev": null,
  "next": 2
}
}
Last updated on