Rechnungen auflisten, optional gefiltert und paginiert

Liefert nur die Kopfdaten der Rechnungen — Positionen werden separat über GET /invoices/{invoice}/items aufgelistet, Anhänge über GET /invoices/{invoice}/attachments.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

Request

GET /api/v1/invoices

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/invoices' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.
Name
invoice_number[]
Type
Liste von string, nullable
Description

Response

{
  "data": [
    {
      "invoice_number": "20240001",
      "billing_kind": {
        "id": 1,
        "name": "Abrechnung"
      },
      "date": "2024-07-20T00:00:00.000000Z",
      "amount": 1.5,
      "status": {
        "id": 1,
        "name": "Billed"
      },
      "currency": "EUR",
      "correction_date": "string",
      "payment_terms_date": "2024-06-01",
      "payment_terms": 30,
      "address": "Musterstraße 123",
      "email_sent_at": "string",
      "email_recipient": "string",
      "customer_number": "K-12345",
      "title": "Dr.",
      "type": {
        "id": 1,
        "name": "Payment Request"
      },
      "note": "Familienurlaub",
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

Name
invoice_number
Type
string
Description
Die Rechnungsnummer, eindeutig pro Rechnung und je Mandant formatiert.
Name
billing_kind
Type
object
Description
Wie die Rechnung ihre Positionen gruppiert — nach Projekt, nach Tätigkeit oder als manuelle Auswahl.
Name
billing_kind.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
billing_kind.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Abrechnung", "Credit Memo"
Name
date
Type
string
Description
Das Datum, an dem die Rechnung ausgestellt wurde.
Name
amount
Type
number
Description
Die Rechnungssumme inklusive Steuer (der Bruttobetrag).
Name
status
Type
object
Description
Der Bearbeitungsstatus der Rechnung — geplant, freigegeben, abgerechnet oder storniert.
Name
status.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
status.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Billed", "Canceled", "In Correction"
Name
currency
Type
string
Description
Der dreistellige Währungscode, in dem der Rechnungsbetrag angegeben ist.
Name
correction_date
Type
string
Description
Das Datum, an dem eine korrigierende Gutschrift ausgestellt wurde; nur vorhanden, sobald diese Rechnung korrigiert wurde.
Name
payment_terms_date
Type
string
Description
Das Fälligkeitsdatum der Zahlung, berechnet aus payment_terms.
Name
payment_terms
Type
integer
Description
Die Anzahl der Tage nach dem Rechnungsdatum, innerhalb derer die Zahlung fällig ist.
Name
address
Type
string
Description
Die auf der Rechnung gedruckte Rechnungsadresse.
Name
email_sent_at
Type
string
Description
Der Zeitstempel, zu dem die Rechnung per E-Mail an den Kunden gesendet wurde; nur vorhanden, sobald sie versendet wurde.
Name
email_recipient
Type
string
Description
Die E-Mail-Adresse, an die die Rechnung gesendet wurde; nur vorhanden, sobald eine E-Mail versendet wurde.
Name
customer_number
Type
string
Description
Der Kunde, dem diese Rechnung gestellt wurde.
Name
title
Type
string
Description
Die Titelzeile der Rechnung, gedruckt über ihren Positionen.
Name
type
Type
object, nullable
Description
Wie sich diese Rechnung auf eine andere bezieht — als Korrektur oder als Stornogutschrift; nur vorhanden, wenn es sich um eine solche handelt.
Name
type.id
Type
integer
Description
Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.
Name
type.name
Type
string
Description
Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.
Einer der Werte: "Payment Request", "Final Invoice", "Partial Final Invoice"
Name
note
Type
string
Description
Eine interne Notiz zur Rechnung, die nicht auf dem Dokument gedruckt wird.
Name
created
Type
string (date-time), nullable
Description
Wann der Rechnungsdatensatz erstmals erstellt wurde.
Name
modified
Type
string (date-time), nullable
Description
Wann der Rechnungsdatensatz zuletzt geändert wurde.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Rechnungen GET Einzelne Rechnung anhand ihrer Rechnungsnummer abrufen