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 Jetztzahlen 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 Request
GET /rest/invoices?url_name=my-shop&status=pending&created_at_from=2024-01-01
Authorization: Basic <base64(api_key:api_password)>

Response​

invoicesArray
Array of invoice objects (up to 50 per page). Each invoice contains the same fields as described in Get Invoice, plus active and id.
paginationObject
Pagination metadata including page, items, count, pages, from, to, prev, next
errorString
Error details (null on success)
messageString
Success or error message
Example Response
{
"error": null,
"message": "Invoices have been successfully retrieved.",
"invoices": [
  {
    "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",
    "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
  }
],
"pagination": {
  "page": 1,
  "items": 50,
  "count": 150,
  "pages": 3,
  "from": 1,
  "to": 50,
  "prev": null,
  "next": 2
}
}
Last updated on