REST DokumentationRechnungenGET Einzelne Rechnung anhand ihrer Rechnungsnummer abrufen

Einzelne Rechnung anhand ihrer Rechnungsnummer abrufen

Die Antwort enthält die Anzahl der Rechnungspositionen; die Positionen selbst werden separat über GET /invoices/{invoice}/items aufgelistet.

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

Request

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

Pfad-Parameter

  • Name
    invoice_number
    Type
    string
    Description

    Die Rechnungsnummer der Rechnung

Response

{
  "data": {
    "invoice_number": "20240001",
    "billing_kind": {
      "id": 1,
      "name": "Abrechnung"
    },
    "date": "2024-07-20T00:00:00.000000Z",
    "amount": 1.5,
    "net_amount": 965.84,
    "tax_amount": 168.45,
    "tax_breakdown": [
      {
        "rate": 19,
        "net_amount": 840.34,
        "tax_amount": 159.66
      },
      {
        "rate": 7,
        "net_amount": 125.5,
        "tax_amount": 8.79
      }
    ],
    "status": {
      "id": 1,
      "name": "Billed"
    },
    "currency": "EUR",
    "correction_date": "2026-10-20 17:01:39",
    "payment_terms_date": "2024-06-01",
    "payment_terms": 30,
    "address": "Musterstraße 123",
    "customer_address_id": 1,
    "contact_id": 1,
    "billing_address": {
      "id": 1,
      "name": "EU",
      "address": "Musterstraße 123",
      "zip_code": "10115",
      "city": "Berlin",
      "country": "Deutschland"
    },
    "debtor": "10042",
    "email_sent_at": "string",
    "email_recipient": "string",
    "customer_number": "K-12345",
    "title": "Dr.",
    "type": {
      "id": 1,
      "name": "Payment Request"
    },
    "note": "Familienurlaub",
    "creator_username": "max.mustermann",
    "created": "2024-07-20T11:30:00.000000Z",
    "modified": "2024-07-20T12:30:00.000000Z",
    "items": [
      {
        "id": 1,
        "project_id": 16,
        "customer_number": "K-12345",
        "quantity": 8,
        "unit_price": 95,
        "unit": "h",
        "currency": "EUR",
        "invoice_text": "Consulting"
      }
    ]
  }
}

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
    net_amount
    Type
    number, nullable
    Description

    Die Rechnungssumme ohne Steuer in der Währung der Rechnung; null, wenn sich die Aufteilung nicht ermitteln lässt.

  • Name
    tax_amount
    Type
    number, nullable
    Description

    Die in der Rechnungssumme enthaltene Steuer in der Währung der Rechnung; null, wenn sich die Aufteilung nicht ermitteln lässt.

  • Name
    tax_breakdown
    Type
    Liste von object, nullable
    Description

    Netto- und Steuerbetrag je Steuersatz, bei einem Steuersatz ein Eintrag; null, wenn sich die Aufteilung nicht ermitteln lässt.

  • Name
    tax_breakdown.rate
    Type
    number
    Description
  • Name
    tax_breakdown.net_amount
    Type
    number
    Description
  • Name
    tax_breakdown.tax_amount
    Type
    number
    Description
  • 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, nullable
    Description

    Das Datum, an dem eine korrigierende Gutschrift ausgestellt wurde; null, solange diese Rechnung nicht korrigiert wurde. Rohwert in deutscher Ortszeit (Europe/Berlin) ohne Zeitzone im Format Y-m-d H:i:s; ISO 8601 folgt in der nächsten API-Version.

  • 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
    customer_address_id
    Type
    integer, nullable
    Description

    Die Kundenadresse, an die die Rechnung geschrieben wurde; null, wenn keine hinterlegt ist. address liefert weiter den Text, wie er gedruckt wurde, auch wenn er von Hand geändert wurde.

  • Name
    contact_id
    Type
    integer, nullable
    Description

    Der Ansprechpartner des Kunden, an den die Rechnung gerichtet ist; null, wenn keiner hinterlegt ist.

  • Name
    billing_address
    Type
    object (CustomerAddress), nullable
    Description

    Die Kundenadresse, an die die Rechnung geschrieben wurde, in ihrem aktuellen Stand und in der Form der addresses des Kunden; null, wenn keine hinterlegt ist oder sie gelöscht wurde.

  • Name
    billing_address.id
    Type
    integer
    Description

    Eindeutige ID der Adresse.

  • Name
    billing_address.name
    Type
    string
    Description

    Der auf dieser Adresse gedruckte Empfängername.

  • Name
    billing_address.name_additional
    Type
    string, nullable
    Description

    Eine zusätzliche Namenszeile, die unter dem Namen gedruckt wird.

  • Name
    billing_address.address
    Type
    string, nullable
    Description

    Erste Adresszeile (Straße und Hausnummer).

  • Name
    billing_address.address_line_2
    Type
    string, nullable
    Description

    Optionale zweite Adresszeile.

  • Name
    billing_address.address_line_3
    Type
    string, nullable
    Description

    Optionale dritte Adresszeile.

  • Name
    billing_address.zip_code
    Type
    string, nullable
    Description

    Die Postleitzahl.

  • Name
    billing_address.city
    Type
    string, nullable
    Description

    Ort, in dem sich diese Adresse befindet.

  • Name
    billing_address.country
    Type
    string, nullable
    Description

    Der Ländername.

  • Name
    billing_address.is_default
    Type
    boolean, nullable
    Description

    Ob dies die Standardadresse des Kunden ist.

  • Name
    billing_address.is_billing_address
    Type
    boolean, nullable
    Description

    Ob Rechnungen an diese Adresse gesendet werden.

  • Name
    billing_address.is_shipping_address
    Type
    boolean, nullable
    Description

    Ob Lieferungen an diese Adresse gesendet werden.

  • Name
    billing_address.email
    Type
    string, nullable
    Description

    E-Mail-Adresse, an die Dokumente für diese Adresse gesendet werden.

  • Name
    billing_address.email_cc
    Type
    string, nullable
    Description

    Zusätzliche E-Mail-Adresse, die bei Dokumenten an diese Adresse in Kopie (CC) gesetzt wird.

  • Name
    billing_address.email_bcc
    Type
    string, nullable
    Description

    Zusätzliche E-Mail-Adresse, die bei Dokumenten an diese Adresse in Blindkopie (BCC) gesetzt wird.

  • Name
    billing_address.debtor
    Type
    string, nullable
    Description

    Die Debitorennummer dieser Adresse (Lizenzmodul Inovex); null, wenn leer.

  • Name
    billing_address.country_code
    Type
    string, nullable
    Description

    ISO-Ländercode für die E-Rechnung (ZUGFeRD/XRechnung).

  • Name
    billing_address.inactive
    Type
    boolean, nullable
    Description

    Ob diese Adresse inaktiv ist und nicht mehr verwendet wird.

  • Name
    billing_address.machine_readable_invoice_version
    Type
    object, nullable
    Description

    Maschinenlesbares E-Rechnungsformat (z. B. ZUGFeRD, XRechnung), das diese Adresse unterstützt, sofern vorhanden.

  • Name
    debtor
    Type
    string, nullable
    Description

    Die Debitorennummer der Rechnung, wie sie bei der Rechnungsstellung gespeichert wurde (Lizenzmodul Inovex); null, wenn keine vorliegt.

  • Name
    email_sent_at
    Type
    string, nullable
    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, nullable
    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

    Der Rechnungstyp: ZA (Zahlungsaufforderung), SR (Schlussrechnung) oder TSR (Teilschlussrechnung); null, wenn die Rechnung keinen hat.

  • 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, nullable
    Description

    Eine interne Notiz zur Rechnung, die nicht auf dem Dokument gedruckt wird.

  • Name
    creator_username
    Type
    string, nullable
    Description

    Der Benutzername des Mitarbeiters, der das Rechnungsdokument erstellt hat – nach einer Korrektur der des Mitarbeiters, der sie korrigiert hat; null, wenn kein Rechnungsdokument gespeichert ist.

  • 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.

  • Name
    items
    Type
    Liste von InvoiceItem
    Description

    Die Positionen der Rechnung, in der Form von GET /invoices/{invoice}/items; nur mit include=items vorhanden, eine leere Liste, wenn die Rechnung keine hat.

  • Name
    items.id
    Type
    integer
    Description

    Eindeutige Kennung der Rechnungsposition.

  • Name
    items.project_id
    Type
    integer, nullable
    Description

    Das Projekt, gegen das diese Position abgerechnet wird.

  • Name
    items.customer_number
    Type
    string, nullable
    Description

    Der Kunde, zu dem das Projekt der Position gehört.

  • Name
    items.from
    Type
    string (date-time), nullable
    Description

    Beginn des Leistungszeitraums, den diese Position abdeckt.

  • Name
    items.to
    Type
    string (date-time), nullable
    Description

    Ende des Leistungszeitraums, den diese Position abdeckt.

  • Name
    items.repetition
    Type
    integer, nullable
    Description

    Wie oft sich diese Position wiederholt, bei wiederkehrenden Positionen.

  • Name
    items.quantity
    Type
    number, nullable
    Description

    Die abgerechnete Menge, in der Einheit der Position.

  • Name
    items.unit_price
    Type
    number, nullable
    Description

    Der Preis pro Einheit, in der Währung der Position.

  • Name
    items.unit
    Type
    string, nullable
    Description

    Die Einheit, in der Menge und Preis angegeben sind.

  • Name
    items.currency
    Type
    string, nullable
    Description

    Der dreistellige Währungscode von unit_price und der abgeleiteten Beträge.

  • Name
    items.language
    Type
    string, nullable
    Description

    Die Sprache, in der der Rechnungstext verfasst ist.

  • Name
    items.status
    Type
    object
    Description

    Der Bearbeitungsstatus der Position — geplant, freigegeben, abgerechnet oder storniert.

  • Name
    items.kind
    Type
    object
    Description

    Was diese Position abrechnet — Arbeitsstunden, Belege, eine Pauschale oder einen manuellen Eintrag.

  • Name
    items.invoice_number
    Type
    string, nullable
    Description

    Die Rechnung, auf der diese Position abgerechnet wurde, sobald sie abgerechnet ist.

  • Name
    items.cancellation_credit_invoice_number
    Type
    string, nullable
    Description

    Die Rechnungsnummer der stornierten Rechnung, auf die sich diese Gutschriftposition bezieht; null bei allen anderen Positionen.

  • Name
    items.invoice_text
    Type
    string, nullable
    Description

    Der Text, der für diese Position auf der Rechnung gedruckt wird.

  • Name
    items.sorting
    Type
    integer, nullable
    Description

    Die Reihenfolge der Position unter den übrigen Positionen der Rechnung.

  • Name
    items.contains_working_hours
    Type
    boolean, nullable
    Description

    Ob diese Position erfasste Arbeitsstunden abrechnet.

  • Name
    items.contains_receipts
    Type
    boolean, nullable
    Description

    Ob diese Position erfasste Belege abrechnet.

  • Name
    items.contains_travel_expenses
    Type
    boolean, nullable
    Description

    Ob diese Position erfasste Reisekosten abrechnet.

  • Name
    items.planned_amount
    Type
    number, nullable
    Description

    Der prognostizierte Betrag dieser Position, solange sie nur geplant oder freigegeben ist.

  • Name
    items.planned_date
    Type
    string (date-time)
    Description

    Das geplante Rechnungsdatum, zu dem diese Position abgerechnet werden soll; die Listenfilter wirken auf dieses Feld, nicht auf from/to.

  • Name
    items.billed_amount
    Type
    number, nullable
    Description

    Der abgerechnete Nettobetrag; 0, solange die Position nur geplant oder freigegeben und noch nicht storniert ist.

  • Name
    items.billed_date
    Type
    string, nullable
    Description

    Das Datum der Rechnung, auf der diese Position tatsächlich abgerechnet wurde.

  • Name
    items.vat
    Type
    number, nullable
    Description

    Der auf diese Position angewendete Mehrwertsteuersatz in Prozent.

  • Name
    items.project_task_id
    Type
    integer, nullable
    Description

    Der Vorgang, gegen den diese Position abgerechnet wird, sofern das Projekt Vorgänge verwendet.

  • Name
    items.ticket_id
    Type
    integer, nullable
    Description

    Das Ticket, gegen das diese Position abgerechnet wird, sofern sie aus einem Ticket stammt.

  • Name
    items.article_id
    Type
    integer, nullable
    Description

    Der Artikel, den diese Position abrechnet, sofern sie aus dem Artikelkatalog erstellt wurde.

  • Name
    items.revenueAccounts
    Type
    Liste von object
    Description

    Die Buchhaltungskonten, auf die der Umsatz dieser Position aufgeteilt wird; nur vorhanden, wenn Erlöskonten geführt werden.

  • Name
    items.sales_manager
    Type
    string
    Description

    Der Mitarbeiter, der die Umsatzverantwortung für diese Position trägt. Nur in Instanzen mit der Erweiterung MOD_HHPBERLIN. Keine allgemein verfügbare Funktion.

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