Lexware Office /voucherlist

Mit dem voucherlist-Endpunkt Belege filtern

Wenn du Belege per API effizient abrufen willst, ist der voucherlist-Endpunkt dein Einstiegspunkt. Hier bekommst du nicht nur eine paginierte Liste, sondern kannst auch gezielt nach Typ, Status, Zeitraum und mehr filtern. Egal ob Eingangsrechnung, Ausgangsrechnung oder Gutschrift – dieser Endpunkt liefert dir genau das, was du brauchst.

Zwei Pflichtfilter: voucherType und voucherStatus

Ohne diese beiden Filter geht nichts:

• voucherType: Gibt an, welche Art von Beleg du suchst – zum Beispiel purchaseinvoice, invoice oder creditnote. Du kannst mehrere Werte kommasepariert angeben oder einfach any, wenn du alles brauchst.

• voucherStatus: Hier geht es um den Status wie open, paid oder overdue. Wichtig: overdue lässt sich nicht mit anderen kombinieren, da es sich dynamisch aus dem Fälligkeitsdatum ergibt.

Alle möglichen Statuswerte im Detail

Damit du weißt, was dich hinter den einzelnen Stati erwartet, hier die vollständige Übersicht:

• draft: Der Beleg wurde erstellt, aber noch nicht finalisiert. Er ist in Lexware noch bearbeitbar.
• open: Der Beleg wurde finalisiert, ist aber noch nicht oder nur teilweise bezahlt.
• overdue: Der Beleg ist offen und das Fälligkeitsdatum liegt in der Vergangenheit.
• paid: Der Beleg wurde vollständig bezahlt.
• paidoff: Gilt nur für Gutschriften – diese wurde vollständig verrechnet.
• voided: Der Beleg wurde storniert.
• transferred: Der Beleg wurde über die Onlinebanking-Schnittstelle weitergeleitet. Sobald die Zahlung von der Bank bearbeitet wurde, wechselt der Status zu „paid“.
• sepadebit: Die Zahlung wurde freigegeben oder per Lastschrift eingezogen. Auch hier wechselt der Status später auf „paid“.
• accepted: Wird nur bei Angeboten verwendet. Das Angebot wurde angenommen.
• rejected: Ebenfalls nur bei Angeboten – es wurde abgelehnt.
• unchecked: Gilt für Buchhaltungsbelege, die per Dateiimport angelegt wurden, aber noch unvollständig sind und daher nicht gebucht werden können.

Alle voucherType-Werte und zugehörige Endpunkte

Je nachdem, welchen Typ du im Filter setzt, kannst du später gezielt mit spezialisierten Endpunkten weiterarbeiten. Hier die vollständige Übersicht:

• salesinvoice: Ausgangsrechnungen – verarbeitet über den Vouchers-Endpunkt
• salescreditnote: Ausgangsgutschriften – ebenfalls über Vouchers
• purchaseinvoice: Eingangsrechnungen – über Vouchers
• purchasecreditnote: Eingangs-Gutschriften – Vouchers
• invoice: Für generische Rechnungen – nutzt den Invoices-Endpunkt
• creditnote: Allgemeine Gutschriften – Credit Notes Endpoint
• orderconfirmation: Auftragsbestätigungen – Order Confirmations Endpoint
• quotation: Angebote – Quotations Endpoint
• downpaymentinvoice: Anzahlungsrechnungen – Down Payment Invoice Endpoint
• deliverynote: Lieferscheine – Delivery Notes Endpoint

Weitere Filteroptionen für maximale Flexibilität

Neben den Pflichtfeldern kannst du eine Reihe optionaler Parameter verwenden, um genau die Belege zu finden, die du brauchst:

• voucherDateFrom, voucherDateTo: Zeitraum, den der Beleg abdeckt
• createdDateFrom, createdDateTo: Wann wurde der Beleg erstellt?
• updatedDateFrom, updatedDateTo: Wann wurde der Beleg zuletzt geändert?
• archived: Archivstatus (true/false)
• contactId: Nur Belege eines bestimmten Kontakts anzeigen
• voucherNumber: Suche nach einer bestimmten Belegnummer

Gerade für Dashboards, Reports oder automatisierte Auswertungen ist diese Filtervielfalt Gold wert.

So sieht die API-Antwort aus

Die Antwort auf deinen API-Call ist paginiert und liefert nicht nur die Belege, sondern auch hilfreiche Meta-Daten:

• totalPages, totalElements: Wie viele Einträge gibt es insgesamt?
• numberOfElements, size, number: Wie viele Elemente befinden sich auf der aktuellen Seite, wie groß ist die Seite, und welche Seitenzahl ist gerade aktiv?

Für jeden einzelnen Beleg bekommst du natürlich auch alle Details:

• Betrag, Währung
• Fälligkeitsdatum, Erstelldatum, Änderungsdatum
• Name des Kontakts
• Archivierungsstatus und mehr

Fazit: voucherlist als Basis für deine Auswertungen

Wenn du strukturierte Belegdaten brauchst – sei es für offene Posten, Lieferantenanalysen oder Monatsabschlüsse – ist der voucherlist-Endpunkt dein bester Freund. Dank der zahlreichen Filteroptionen kannst du gezielt genau die Daten abrufen, die du brauchst.

Und wenn du dann mehr willst? Kein Problem: Mit dem passenden voucherType kannst du über spezialisierte Endpunkte wie invoices oder creditnotes tiefer einsteigen. Aber für den Einstieg in jede Belegabfrage bleibt voucherlist das zentrale Tool.