Freigeben über


Lexoffice (Unabhängiger Herausgeber) (Vorschau)

Die Lexware-API bietet programmgesteuerten Zugriff auf wichtige Lexware-Geschäftsfunktionen wie Artikel, Kontakte, Rechnungen, Bestellungen und Dateiverwaltung. Dieser unabhängige Publisher-Connector ermöglicht die sichere Integration mit der REST-API von Lexware, sodass Benutzer Geschäftsdaten erstellen und abrufen, Prozesse automatisieren und Lexware-Ressourcen mit Power Platform-Anwendungen verbinden können. Der Connector verwendet den OAuth 2.0-Autorisierungscodefluss für sichere Authentifizierung und API-Richtlinien.

Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:

Dienstleistung Class Regions
Copilot Studio Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Logik-Apps Norm Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche:
     – Azure Government-Regionen
     - Azure China-Regionen
     - US Department of Defense (DoD)
Power Apps Premium Alle Power Apps-Regionen mit Ausnahme der folgenden:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Power Automate Premium Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche:
     - US Government (GCC)
     - US Government (GCC High)
     - China Cloud betrieben von 21Vianet
     - US Department of Defense (DoD)
Kontakt
Name LowCode-Ermittlerunterstützung
URL https://lowcode-investigator.com/
Email kontakt@lowcodeinvestigator.com
Connectormetadaten
Herausgeber LowCodeInvestigator
Webseite https://office.lexware.de/
Datenschutzrichtlinie https://office.lexware.de/datenschutz/
Kategorien Unternehmensführung; Finanzieren

Lexware-API-Connector (unabhängiger Herausgeber)

Die Lexware-API ist eine RESTful-Schnittstelle, mit der Entwickler Lexware-Geschäftsfunktionen wie Kontakte, Rechnungen, Artikel und Dateien in ihre eigenen Anwendungen integrieren können. Dieser Connector ermöglicht die direkte Interaktion mit diesen Ressourcen durch sichere, authentifizierte API-Anforderungen.

Herausgeber: Unabhängiger Herausgeber

Voraussetzungen

  • Ein registriertes Lexware-Konto und eine ordnungsgemäße Lizenz
  • Ein gültiger API-Schlüssel (Zugriffstoken), der über das Lexware Developer Portal abgerufen wird
  • OAuth 2.0-Autorisierungscodefluss ist für die Authentifizierung erforderlich.

Unterstützte Vorgänge

Dieser Connector unterstützt die folgenden Lexware-API-Endpunkte:

  • Artikel: Erstellen, Abrufen, Aktualisieren, Löschen und Filtern von Artikeln
  • Kontakte: Verwalten von Kunden- und Lieferantendaten
  • Rechnungen: Erstellen und Abrufen von Rechnungsdaten, einschließlich Rendering-PDFs
  • Gutschriften, Lieferscheine, Bestellungen, Angebote und Gutscheine
  • Länder, Zahlungsbedingungen, Drucklayouts und Profile
  • Ereignisabonnements und -dateien
  • Vollständige Liste dokumentiert unter: Lexware API Docs

Abrufen von Anmeldeinformationen

Um die Lexware-API aufzurufen, benötigen Sie einen API-Schlüssel:

  1. Melden Sie sich bei Ihrem Lexware Office-Konto an.
  2. Navigieren Sie zu Erweiterungen → Weitere Apps → öffentliche API oder öffnen Sie
    Lexware Developer Portal direkt.
  3. Erstellen Sie einen neuen API-Schlüssel mit den gewünschten Berechtigungen.
  4. Kopieren Sie den generierten API-Schlüssel. Dieser Wert wird wie accessToken in der Verbindung verwendet.

API-Gateway

Verwenden Sie das neue Lexware-API-Gateway:

https://api.lexware.io

Ratenbeschränkungen

  • Max. 2 Anforderungen/Sekunde
  • Anforderungen, die diesen Grenzwert überschreiten, empfangen HTTP 429 Too Many Requests
  • Empfohlen: Verwenden des Token-Bucketalgorithmus oder exponentieller Backoff

Authentifizierung

Die Lexware-API verwendet den OAuth 2.0-Autorisierungscodefluss. Schließen Sie das Token in den Authorization: Bearer {accessToken} Header jeder Anforderung ein.

Anwendungsbeispiel

Erstellen eines Artikels:

curl https://api.lexware.io/v1/articles \
  -X POST \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Lexware Buchhaltung Premium 2024",
    "type": "PRODUCT",
    "unitName": "Download-Code",
    "articleNumber": "LXW-BUHA-2024-001",
    "price": {
      "netPrice": 61.90,
      "leadingPrice": "NET",
      "taxRate": 19
    }
  }'

Bekannte Probleme und Einschränkungen

  • Max. 2 Anforderungen/Sekunde
  • Für einige Endpunkte sind zusätzliche Berechtigungen oder Rollen erforderlich.

API-Dokumentation

Vollständige API-Referenz ist verfügbar unter:
https://developers.lexware.io/docs/

Verbindung herstellen

Der Connector unterstützt die folgenden Authentifizierungstypen:

Vorgabe Parameter zum Erstellen einer Verbindung. Alle Regionen Nicht teilbar

Vorgabe

Anwendbar: Alle Regionen

Parameter zum Erstellen einer Verbindung.

Dies ist keine gemeinsam nutzbare Verbindung. Wenn die Power-App mit einem anderen Benutzer geteilt wird, wird dieser andere Benutzer explizit aufgefordert, eine neue Verbindung herzustellen.

Name Typ Description Erforderlich
API-Schlüssel securestring Der API-Schlüssel für diese API Richtig

Drosselungsgrenzwerte

Name Aufrufe Verlängerungszeitraum
API-Aufrufe pro Verbindung 100 60 Sekunden

Aktionen

Abrufen aller Ereignisabonnements

Abrufen aller Ereignisabonnements

Abrufen aller Kontakte

Abrufen aller Kontakte

Abrufen aller Wiederkehrenden Vorlagen

Dient zum Abrufen einer Sammlung von Wiederkehrenden Vorlagen. Das Ergebnis gibt nur einen Teil der relevantesten Daten zurück, bei denen es sich um den referenzierten Kontakt (nur ID und Name), den Gesamtpreis, die Zahlungsbedingungen und die vollständigen Einstellungen für wiederkehrende Vorlagen handelt. Die Benennung von Objekten und Eigenschaften ist jedoch identisch.

Abrufen einer Anzahlungsrechnung

Gibt die Anzahlungsrechnung mit dem ID-Wert {id} zurück.

Abrufen einer Bestellbestätigung

Gibt die Bestellbestätigung mit dem ID-Wert {id} zurück.

Abrufen einer Gutschrift

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Kreditnotizen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Kreditnotizen können als Entwurf erstellt oder im geöffneten Modus abgeschlossen werden.

Abrufen einer Liste von Postenkategorien

Dieser Endpunkt bietet Lesezugriff auf die Liste der Postenkategorien für die (Buchführung) Gutscheine Einnahmen oder Ausgaben, die in lexoffice unterstützt werden.

Abrufen einer Rechnung

Gibt die Rechnung mit dem ID-Wert {id} zurück.

Abrufen einer Wiederkehrenden Vorlage

Gibt die Wiederkehrende Vorlage mit dem ID-Wert {id} zurück.

Abrufen einer Übermittlungsnotiz

Gibt die Liefernotiz mit dem ID-Wert {id} zurück.

Abrufen eines Anführungszeichens

Gibt das Angebot mit dem ID-Wert {id} zurück. Rendern eines Anführungszeichendokuments (PDF)

Abrufen eines Artikels

Gibt den Artikel mit dem ID-Wert {id} zurück.

Abrufen eines Dunnings

Gibt die Dunnung mit dem ID-Wert {id} zurück.

Abrufen eines Ereignisabonnements

Abrufen eines Ereignisabonnements

Abrufen eines Gutscheins

Auflisten von Verkaufsgutscheinen (z. B. Rechnungen, Gutschriften)

Abrufen eines Kontakts

Abrufen eines Kontakts nach ID

Abrufen und Filtern der Gutscheinliste

Gutscheinliste (Buchführung) Gutscheine (z. B. salesinvoices, salescreditnotes), Rechnungen (einschließlich Anzahlungsrechnungen), Gutschriften, Bestellbestätigungen, Angebote und Lieferscheine erhalten.

Abrufen von Profilinformationen

Das folgende Beispiel zeigt, wie Sie Ihre grundlegenden Profilinformationen abrufen. Es ist erforderlich, den Platzhalter {accessToken} vor dem Senden der Anforderung zu ersetzen.

Aktualisieren eines Artikels

Aktualisieren Sie einen vorhandenen Artikel mit der ID {id} mit den daten, die in der Nutzlast als JSON angegeben sind. Gibt ein Aktionsergebnis für den Erfolg zurück.

Aktualisieren eines Kontakts

Aktualisieren eines Kontakts

Erstellen einer Bestellbestätigung

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Bestellbestätigungen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Bestellbestätigungen werden immer im Entwurfsmodus erstellt und müssen nicht abgeschlossen werden.

Erstellen einer Dunnierung

Die erstellte Dunning wird nicht in der Hauptgutscheinliste in lexoffice angezeigt, wird aber an eine Rechnung angefügt und dort sichtbar. Um Ihren Kunden Zugriff auf die erstellte Dunning-Funktion zu bieten, verwenden Sie bitte unsere Deeplink-Funktion.

Erstellen einer Gutschrift

Kreditnotizen, die über die API übertragen werden, werden standardmäßig im Entwurfsmodus erstellt. Um eine abgeschlossene Gutschrift mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status einer Gutschrift kann nicht über die API geändert werden.

Erstellen einer Liefernotiz

Der erstellte Lieferschein wird in der Hauptgutscheinliste in lexoffice angezeigt. Übermittlungsnotizen, die über die API übertragen werden, werden nur im Entwurfsmodus erstellt.

Erstellen einer Rechnung

Rechnungen, die über die API übertragen werden, werden im Entwurfsmodus pro Standard erstellt. Um eine abgeschlossene Rechnung mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status einer Rechnung kann nicht über die API geändert werden.

Erstellen eines Angebots

Über die API übertragene Angebote werden standardmäßig im Entwurfsmodus erstellt. Um ein abgeschlossenes Angebot mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status eines Anführungszeichens kann nicht über die API geändert werden.

Erstellen eines Artikels

Der Inhalt des Artikels wird im Text der Anforderung als Anwendung/JSON erwartet.

Erstellen eines Gutscheins

Gutscheine erstellen (beschränkt auf Verkaufsgutscheine)

Erstellen eines Kontakts

Erstellen eines neuen Kontakts

Filtern von Artikeln

Gibt die Artikel zurück, die die durch Filter angegebenen Kriterien erfüllen, filter_1 mithilfe eines Pagingmechanismus zu filter_n. Wenn mehr als ein Filter angegeben wird, lautet der logische Verbinder AND. Filter, die nicht festgelegt sind, werden ignoriert. Informationen zum Überprüfen der maximalen Seitengröße für diesen Endpunkt finden Sie unter "Paging of Resources".

Gutschein aktualisieren

Aktualisieren eines Gutscheins

Herunterladen einer Datei

Verwenden Sie diesen Endpunkt, um Dateien herunterzuladen.

Hochladen einer Datei

Verwenden Sie diesen Endpunkt, um Dateien wie Gutscheine oder Rechnungen hochzuladen.

Hochladen einer Datei in einen Gutschein

Laden Sie Dateien (PDF oder Bild) in den von {id} identifizierten Gutschein hoch und weisen Sie sie zu.

Liste der Länder abrufen

Liste der Länder, die lexoffice bekannt sind.

Liste der Zahlungsbedingungen abrufen

Das folgende Beispiel zeigt, wie Sie eine Liste der aktuell konfigurierten Zahlungsbedingungen abrufen. Es ist erforderlich, den Platzhalter {accessToken} vor dem Senden der Anforderung zu ersetzen.

Löschen eines Artikels

Löscht den Artikel mit dem ID-Wert {id}. Gibt 204 bei Erfolg oder 404 zurück, wenn die ID nicht vorhanden ist.

Löschen eines Event-Subscription

Trigger-WebHook löschen

Rendern eines Anführungszeichendokuments (PDF)

Um die PDF-Datei eines Anführungszeichendokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Anführungszeichenressource zurückgegeben. Neu erstellte Anführungszeichen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Rendern eines Bestellbestätigungsdokuments (PDF)

Um die PDF-Datei eines Bestellbestätigungsdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Bestellbestätigungsressource zurückgegeben. Neu erstellte Bestellbestätigungen über die API müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Rendern eines Dunningdokuments (PDF)

Um die PDF-Datei eines Dunning-Dokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Dunningressource zurückgegeben. Neu erstellte Dunings über die API müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Rendern eines Gutschriftdokuments (PDF)

Um die PDF-Datei eines Gutschriftdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Gutschriftressource zurückgegeben. Neu erstellte Kreditnotizen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Rendern eines Rechnungsdokuments (PDF)

Um die PDF-Datei eines Rechnungsdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Rechnungsressource zurückgegeben. Neu erstellte Rechnungen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Rendern eines Übermittlungsnotizdokuments (PDF)

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Übermittlungsnotizen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Übermittlungsnotizen werden immer im Entwurfsmodus erstellt und müssen nicht abgeschlossen werden.

Zahlungsinformationen abrufen

Der Zahlungsendpunkt bietet Lesezugriff auf den Zahlungsstatus von Gutscheinen (Buchführung oder Verkauf), einschließlich Rechnungen und Gutschriften.

Abrufen aller Ereignisabonnements

Abrufen aller Ereignisabonnements

Gibt zurück

Abrufen aller Kontakte

Abrufen aller Kontakte

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Number
number integer

Geben Sie die Nummer an.

Email
email string

Geben Sie die E-Mail an.

Name
name string

Geben Sie den Namen an.

Hersteller
vendor boolean

Geben Sie den Anbieter an.

Customer
customer boolean

Geben Sie den Kunden an.

Seite
page integer

Geben Sie die Seite an.

Größe
size integer

Geben Sie die Größe an.

Sortieren
sort string

Geben Sie die Sortierung an.

Gibt zurück

Abrufen aller Wiederkehrenden Vorlagen

Dient zum Abrufen einer Sammlung von Wiederkehrenden Vorlagen. Das Ergebnis gibt nur einen Teil der relevantesten Daten zurück, bei denen es sich um den referenzierten Kontakt (nur ID und Name), den Gesamtpreis, die Zahlungsbedingungen und die vollständigen Einstellungen für wiederkehrende Vorlagen handelt. Die Benennung von Objekten und Eigenschaften ist jedoch identisch.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Seite
page integer

Geben Sie die Seite an.

Größe
size integer

Geben Sie die Größe an.

Sortieren
sort string

Geben Sie die Sortierung an.

Gibt zurück

Abrufen einer Anzahlungsrechnung

Gibt die Anzahlungsrechnung mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
closingInvoiceId
closingInvoiceId uuid
Erstellungsdatum
createdDate date-time
dueDate
dueDate date-time
documentFileId
files.documentFileId uuid
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
discountProzentsatz
paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
paymentConditions.paymentTermDuration integer
paymentTermLabel
paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
paymentConditions.paymentTermLabelTemplate string
Bemerkung
remark string
shippingType
shippingConditions.shippingType string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen einer Bestellbestätigung

Gibt die Bestellbestätigung mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
deliveryTerms
deliveryTerms string
documentFileId
files.documentFileId uuid
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
discountProzentsatz
lineItems.discountPercentage number
id
lineItems.id uuid
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
discountProzentsatz
paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
paymentConditions.paymentTermDuration integer
paymentTermLabel
paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
paymentConditions.paymentTermLabelTemplate string
Bemerkung
remark string
shippingDate
shippingConditions.shippingDate date-time
shippingType
shippingConditions.shippingType string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen einer Gutschrift

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Kreditnotizen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Kreditnotizen können als Entwurf erstellt oder im geöffneten Modus abgeschlossen werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount float
netAmount
lineItems.unitPrice.netAmount float
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
Bemerkung
remark string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount float
totalNetAmount
totalPrice.totalNetAmount float
totalTaxAmount
totalPrice.totalTaxAmount float
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen einer Liste von Postenkategorien

Dieser Endpunkt bietet Lesezugriff auf die Liste der Postenkategorien für die (Buchführung) Gutscheine Einnahmen oder Ausgaben, die in lexoffice unterstützt werden.

Gibt zurück

Abrufen einer Rechnung

Gibt die Rechnung mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
discountProzentsatz
lineItems.discountPercentage number
id
lineItems.id uuid
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
discountProzentsatz
paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
paymentConditions.paymentTermDuration integer
paymentTermLabel
paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
paymentConditions.paymentTermLabelTemplate string
Bemerkung
remark string
shippingDate
shippingConditions.shippingDate date-time
shippingType
shippingConditions.shippingType string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen einer Wiederkehrenden Vorlage

Gibt die Wiederkehrende Vorlage mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
contactId
address.contactId uuid
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
discountProzentsatz
lineItems.discountPercentage number
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
paymentTermDuration
paymentConditions.paymentTermDuration integer
paymentTermLabel
paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
paymentConditions.paymentTermLabelTemplate string
recurringTemplateSettings
recurringTemplateSettings object
Bemerkung
remark string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer

Abrufen einer Übermittlungsnotiz

Gibt die Liefernotiz mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
deliveryTerms
deliveryTerms string
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
Bemerkung
remark string
taxType
taxConditions.taxType string
title
title string
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen eines Anführungszeichens

Gibt das Angebot mit dem ID-Wert {id} zurück. Rendern eines Anführungszeichendokuments (PDF)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
contactId
address.contactId uuid
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
Ablaufdatum
expirationDate date-time
documentFileId
files.documentFileId uuid
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
Alternative
lineItems.alternative boolean
discountProzentsatz
lineItems.discountPercentage number
id
lineItems.id uuid
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
optional
lineItems.optional boolean
Menge
lineItems.quantity number
Unterelemente
lineItems.subItems array of object
Alternative
lineItems.subItems.alternative boolean
discountProzentsatz
lineItems.subItems.discountPercentage number
id
lineItems.subItems.id uuid
lineItemAmount
lineItems.subItems.lineItemAmount number
name
lineItems.subItems.name string
optional
lineItems.subItems.optional boolean
Menge
lineItems.subItems.quantity number
type
lineItems.subItems.type string
unitName
lineItems.subItems.unitName string
Währung
lineItems.subItems.unitPrice.currency string
grossAmount
lineItems.subItems.unitPrice.grossAmount number
netAmount
lineItems.subItems.unitPrice.netAmount number
taxRatePercentage
lineItems.subItems.unitPrice.taxRatePercentage number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
discountProzentsatz
paymentConditions.paymentDiscountConditions.discountPercentage number
discountRange
paymentConditions.paymentDiscountConditions.discountRange integer
paymentTermDuration
paymentConditions.paymentTermDuration integer
paymentTermLabel
paymentConditions.paymentTermLabel string
paymentTermLabelTemplate
paymentConditions.paymentTermLabelTemplate string
Bemerkung
remark string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen eines Artikels

Gibt den Artikel mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
articleNumber
articleNumber string
gtin
gtin string
id
id string
Hinweis
note string
Bruttopreis
price.grossPrice float
leadingPrice
price.leadingPrice string
netPrice
price.netPrice float
taxRate
price.taxRate float
title
title string
type
type string
unitName
unitName string
Ausgabe
version integer

Abrufen eines Dunnings

Gibt die Dunnung mit dem ID-Wert {id} zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dunningsid
dunningsid True string

Geben Sie die Dunningsid an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
discountProzentsatz
lineItems.discountPercentage number
lineItemAmount
lineItems.lineItemAmount number
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount number
netAmount
lineItems.unitPrice.netAmount number
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
relatedVouchers
relatedVouchers array of object
id
relatedVouchers.id uuid
voucherNumber
relatedVouchers.voucherNumber string
voucherType
relatedVouchers.voucherType string
Bemerkung
remark string
shippingDate
shippingConditions.shippingDate date-time
shippingType
shippingConditions.shippingType string
taxAmounts
taxAmounts array of object
netAmount
taxAmounts.netAmount number
taxAmount
taxAmounts.taxAmount number
taxRatePercentage
taxAmounts.taxRatePercentage number
taxType
taxConditions.taxType string
title
title string
Währung
totalPrice.currency string
totalGrossAmount
totalPrice.totalGrossAmount number
totalNetAmount
totalPrice.totalNetAmount number
totalTaxAmount
totalPrice.totalTaxAmount number
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherStatus
voucherStatus string

Abrufen eines Ereignisabonnements

Abrufen eines Ereignisabonnements

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Subscription Id (Abonnement-ID)
subscriptionId True string

Geben Sie die Abonnement-ID an.

Gibt zurück

Abrufen eines Gutscheins

Auflisten von Verkaufsgutscheinen (z. B. Rechnungen, Gutschriften)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate date-time
dueDate
dueDate date-time
files
files array of string
id
id uuid
organizationId
organizationId uuid
Bemerkung
remark string
shippingDate
shippingDate date-time
taxType
taxType string
totalGrossAmount
totalGrossAmount number
totalTaxAmount
totalTaxAmount number
type
type string
updatedDate
updatedDate date-time
useCollectiveContact
useCollectiveContact boolean
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherItems
voucherItems array of object
Menge
voucherItems.amount number
categoryId
voucherItems.categoryId uuid
taxAmount
voucherItems.taxAmount number
taxRatePercent
voucherItems.taxRatePercent number
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Abrufen eines Kontakts

Abrufen eines Kontakts nach ID

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
archiviert
archived boolean
id
id string
organizationId
organizationId string
Vorname
person.firstName string
lastName
person.lastName string
Anrede
person.salutation string
number
roles.customer.number integer
Ausgabe
version integer

Abrufen und Filtern der Gutscheinliste

Gutscheinliste (Buchführung) Gutscheine (z. B. salesinvoices, salescreditnotes), Rechnungen (einschließlich Anzahlungsrechnungen), Gutschriften, Bestellbestätigungen, Angebote und Lieferscheine erhalten.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gutscheintyp
voucherType True string

Geben Sie den Gutscheintyp an.

Gutscheinstatus
voucherStatus True string

Geben Sie den Gutscheinstatus an.

Archived
archived boolean

Geben Sie die archivierte Datei an.

Kontakt-ID
contactId string

Geben Sie die Kontakt-ID an.

Gutscheindatum ab
voucherDateFrom string

Geben Sie das Gutscheindatum an.

Gutscheindatum bis
voucherDateTo string

Geben Sie das Gutscheindatum an.

Erstellungsdatum von
createdDateFrom string

Geben Sie das Erstellungsdatum an.

Erstellungsdatum bis
createdDateTo string

Geben Sie das Erstellungsdatum an.

Datum aktualisiert von
updatedDateFrom string

Geben Sie das aktualisierte Datum an.

Datum aktualisiert bis
updatedDateTo string

Geben Sie das aktualisierte Datum an.

Gutscheinnummer
voucherNumber string

Geben Sie die Gutscheinnummer an.

Seite
page integer

Geben Sie die Seite an.

Größe
size integer

Geben Sie die Größe an.

Sortieren
sort string

Geben Sie die Sortierung an.

Gibt zurück

Abrufen von Profilinformationen

Das folgende Beispiel zeigt, wie Sie Ihre grundlegenden Profilinformationen abrufen. Es ist erforderlich, den Platzhalter {accessToken} vor dem Senden der Anforderung zu ersetzen.

Gibt zurück

Aktualisieren eines Artikels

Aktualisieren Sie einen vorhandenen Artikel mit der ID {id} mit den daten, die in der Nutzlast als JSON angegeben sind. Gibt ein Aktionsergebnis für den Erfolg zurück.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

articleNumber
articleNumber string

articleNumber

gtin
gtin string

gtin

Hinweis
note string

Hinweis

Bruttopreis
grossPrice True float

Bruttopreis

leadingPrice
leadingPrice True string

leadingPrice

netPrice
netPrice True float

netPrice

taxRate
taxRate float

taxRate

title
title string

title

type
type True string

type

unitName
unitName True string

unitName

Ausgabe
version True integer

Ausgabe

Gibt zurück

Aktualisieren eines Kontakts

Aktualisieren eines Kontakts

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Erstellen einer Bestellbestätigung

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Bestellbestätigungen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Bestellbestätigungen werden immer im Entwurfsmodus erstellt und müssen nicht abgeschlossen werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorherige Verkaufsgutschein-ID
precedingSalesVoucherId string

Geben Sie die vorherige Verkaufsgutschein-ID an.

Gibt zurück

Erstellen einer Dunnierung

Die erstellte Dunning wird nicht in der Hauptgutscheinliste in lexoffice angezeigt, wird aber an eine Rechnung angefügt und dort sichtbar. Um Ihren Kunden Zugriff auf die erstellte Dunning-Funktion zu bieten, verwenden Sie bitte unsere Deeplink-Funktion.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorherige Verkaufsgutschein-ID
precedingSalesVoucherId string

Geben Sie die vorherige Verkaufsgutschein-ID an.

Gibt zurück

Erstellen einer Gutschrift

Kreditnotizen, die über die API übertragen werden, werden standardmäßig im Entwurfsmodus erstellt. Um eine abgeschlossene Gutschrift mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status einer Gutschrift kann nicht über die API geändert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorherige Verkaufsgutschein-ID
precedingSalesVoucherId string

Geben Sie die vorherige Verkaufsgutschein-ID an.

Finalisieren
finalize True boolean

Geben Sie die Fertigstellung an.

Gibt zurück

Erstellen einer Liefernotiz

Der erstellte Lieferschein wird in der Hauptgutscheinliste in lexoffice angezeigt. Übermittlungsnotizen, die über die API übertragen werden, werden nur im Entwurfsmodus erstellt.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorherige Verkaufsgutschein-ID
precedingSalesVoucherId string

Geben Sie die vorherige Verkaufsgutschein-ID an.

Gibt zurück

Erstellen einer Rechnung

Rechnungen, die über die API übertragen werden, werden im Entwurfsmodus pro Standard erstellt. Um eine abgeschlossene Rechnung mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status einer Rechnung kann nicht über die API geändert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Vorherige Verkaufsgutschein-ID
precedingSalesVoucherId string

Geben Sie die vorherige Verkaufsgutschein-ID an.

Finalisieren
finalize True boolean

Geben Sie die Fertigstellung an.

Gibt zurück

Erstellen eines Angebots

Über die API übertragene Angebote werden standardmäßig im Entwurfsmodus erstellt. Um ein abgeschlossenes Angebot mit Status zu erstellen, muss der optionale Abfrageparameter finalisiert werden. Der Status eines Anführungszeichens kann nicht über die API geändert werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Finalisieren
finalize True boolean

Geben Sie die Fertigstellung an.

Gibt zurück

Erstellen eines Artikels

Der Inhalt des Artikels wird im Text der Anforderung als Anwendung/JSON erwartet.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
articleNumber
articleNumber string

articleNumber

Bruttopreis
grossPrice float

Bruttopreis

leadingPrice
leadingPrice string

leadingPrice

netPrice
netPrice float

netPrice

taxRate
taxRate float

taxRate

title
title string

title

type
type string

type

unitName
unitName string

unitName

Gibt zurück

Erstellen eines Gutscheins

Gutscheine erstellen (beschränkt auf Verkaufsgutscheine)

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
contactId
contactId string
dueDate
dueDate date
Bemerkung
remark string
shippingDate
shippingDate date
taxType
taxType True string
totalGrossAmount
totalGrossAmount float
totalTaxAmount
totalTaxAmount float
type
type True string
useCollectiveContact
useCollectiveContact boolean
voucherDate
voucherDate date
Menge
amount float
categoryId
categoryId string
taxAmount
taxAmount float
taxRatePercent
taxRatePercent integer
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Gibt zurück

Erstellen eines Kontakts

Erstellen eines neuen Kontakts

Gibt zurück

Filtern von Artikeln

Gibt die Artikel zurück, die die durch Filter angegebenen Kriterien erfüllen, filter_1 mithilfe eines Pagingmechanismus zu filter_n. Wenn mehr als ein Filter angegeben wird, lautet der logische Verbinder AND. Filter, die nicht festgelegt sind, werden ignoriert. Informationen zum Überprüfen der maximalen Seitengröße für diesen Endpunkt finden Sie unter "Paging of Resources".

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Artikelnummer
articleNumber string

Geben Sie die Artikelnummer an.

Gtin
gtin string

Geben Sie das Gtin an.

Typ
type string

Geben Sie den Typ an.

Seite
page integer

Geben Sie die Seite an.

Größe
size integer

Geben Sie die Größe an.

Sortieren
sort string

Geben Sie die Sortierung an.

Gibt zurück

Gutschein aktualisieren

Aktualisieren eines Gutscheins

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

contactId
contactId string
dueDate
dueDate date
files
files array of string

Liste der ausgelassenen FileIds

Bemerkung
remark string
shippingDate
shippingDate date
taxType
taxType True string
totalGrossAmount
totalGrossAmount float
totalTaxAmount
totalTaxAmount float
type
type True string
useCollectiveContact
useCollectiveContact boolean
Ausgabe
version integer
voucherDate
voucherDate date
Menge
amount float
categoryId
categoryId string
taxAmount
taxAmount float
taxRatePercent
taxRatePercent integer
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Gibt zurück

Herunterladen einer Datei

Verwenden Sie diesen Endpunkt, um Dateien herunterzuladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei-ID
fileId True string

Geben Sie die Datei-ID an.

Akzeptieren
Accept string

Geben Sie die Annahme an.

Gibt zurück

response
file

Hochladen einer Datei

Verwenden Sie diesen Endpunkt, um Dateien wie Gutscheine oder Rechnungen hochzuladen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Datei
file True file

Die hochzuladende Datei.

Typ
type True string

Beschreibung des Dateiinhalts.

Gibt zurück

Hochladen einer Datei in einen Gutschein

Laden Sie Dateien (PDF oder Bild) in den von {id} identifizierten Gutschein hoch und weisen Sie sie zu.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Datei
file True file

Die hochzuladende Datei.

Liste der Länder abrufen

Liste der Länder, die lexoffice bekannt sind.

Gibt zurück

Liste der Zahlungsbedingungen abrufen

Das folgende Beispiel zeigt, wie Sie eine Liste der aktuell konfigurierten Zahlungsbedingungen abrufen. Es ist erforderlich, den Platzhalter {accessToken} vor dem Senden der Anforderung zu ersetzen.

Gibt zurück

Löschen eines Artikels

Löscht den Artikel mit dem ID-Wert {id}. Gibt 204 bei Erfolg oder 404 zurück, wenn die ID nicht vorhanden ist.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Löschen eines Event-Subscription

Trigger-WebHook löschen

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Subscription Id (Abonnement-ID)
subscriptionId True string

Geben Sie die Abonnement-ID an.

Rendern eines Anführungszeichendokuments (PDF)

Um die PDF-Datei eines Anführungszeichendokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Anführungszeichenressource zurückgegeben. Neu erstellte Anführungszeichen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
documentFileId
documentFileId uuid

Rendern eines Bestellbestätigungsdokuments (PDF)

Um die PDF-Datei eines Bestellbestätigungsdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Bestellbestätigungsressource zurückgegeben. Neu erstellte Bestellbestätigungen über die API müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
documentFileId
documentFileId uuid

Rendern eines Dunningdokuments (PDF)

Um die PDF-Datei eines Dunning-Dokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Dunningressource zurückgegeben. Neu erstellte Dunings über die API müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Dunningsid
dunningsid True string

Geben Sie die Dunningsid an.

Gibt zurück

Name Pfad Typ Beschreibung
documentFileId
documentFileId uuid

Rendern eines Gutschriftdokuments (PDF)

Um die PDF-Datei eines Gutschriftdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Gutschriftressource zurückgegeben. Neu erstellte Kreditnotizen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
documentFileId
documentFileId uuid

Rendern eines Rechnungsdokuments (PDF)

Um die PDF-Datei eines Rechnungsdokuments herunterzuladen, benötigen Sie dessen documentFileId. Diese ID wird in der Regel von der Rechnungsressource zurückgegeben. Neu erstellte Rechnungen, die über die API geöffnet sind, müssen jedoch das Rendern der PDF-Dokumentdatei separat auslösen. Dies kann mit diesem Endpunkt erfolgen.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Id
id True string

Geben Sie die ID an.

Gibt zurück

Name Pfad Typ Beschreibung
documentFileId
documentFileId uuid

Rendern eines Übermittlungsnotizdokuments (PDF)

Dieser Endpunkt bietet Lese- und Schreibzugriff auf Übermittlungsnotizen sowie die Möglichkeit, das Dokument als PDF-Datei zu rendern, um es herunterzuladen. Übermittlungsnotizen werden immer im Entwurfsmodus erstellt und müssen nicht abgeschlossen werden.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Übermittlungs-Notiz-ID
DeliveryNoteid True string

Geben Sie die Zustellungsnotiz-ID an.

Gibt zurück

Name Pfad Typ Beschreibung
city
address.city string
countryCode
address.countryCode string
name
address.name string
Straße
address.street string
Ergänzung
address.supplement string
zip
address.zip string
archiviert
archived boolean
Erstellungsdatum
createdDate date-time
deliveryTerms
deliveryTerms string
id
id uuid
Einführung
introduction string
language
language string
lineItems
lineItems array of object
name
lineItems.name string
Menge
lineItems.quantity number
type
lineItems.type string
unitName
lineItems.unitName string
Währung
lineItems.unitPrice.currency string
grossAmount
lineItems.unitPrice.grossAmount float
netAmount
lineItems.unitPrice.netAmount float
taxRatePercentage
lineItems.unitPrice.taxRatePercentage number
organizationId
organizationId uuid
Bemerkung
remark string
taxType
taxConditions.taxType string
title
title string
updatedDate
updatedDate date-time
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

Zahlungsinformationen abrufen

Der Zahlungsendpunkt bietet Lesezugriff auf den Zahlungsstatus von Gutscheinen (Buchführung oder Verkauf), einschließlich Rechnungen und Gutschriften.

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Gutschein-ID
voucherId True string

Geben Sie die Gutschein-ID an.

Gibt zurück

Name Pfad Typ Beschreibung
Währung
currency string
openAmount
openAmount string
paymentItems
paymentItems array of object
Menge
paymentItems.amount float
Währung
paymentItems.currency string
paymentItemType
paymentItems.paymentItemType string
postingDate
paymentItems.postingDate date-time
paymentStatus
paymentStatus string
voucherStatus
voucherStatus string
voucherType
voucherType string

Trigger

Auswählen des benutzerdefinierten Triggers

Registrieren eines neuen Triggers für den Kontaktendpunkt

Auswählen des benutzerdefinierten Triggers

Registrieren eines neuen Triggers für den Kontaktendpunkt

Parameter

Name Schlüssel Erforderlich Typ Beschreibung
Ereignistyp
eventType True string

eventType

Gibt zurück

Name Pfad Typ Beschreibung
eventDate
eventDate string

eventDate

eventType
eventType string

eventType

organizationId
organizationId string

organizationId

resourceId
resourceId string

resourceId

Definitionen

EventSubscriptionResponse

Name Pfad Typ Beschreibung
subscriptionId
subscriptionId string
eventType
eventType string
organizationId
organizationId string
Erstellungsdatum
createdDate date-time
callbackUrl
callbackUrl string

Response_articles_get

Name Pfad Typ Beschreibung
Inhalt
content array of object

Inhalt

articleNumber
content.articleNumber string

articleNumber

gtin
content.gtin string

gtin

id
content.id string

id

Hinweis
content.note string

Hinweis

Bruttopreis
content.price.grossPrice float

Bruttopreis

leadingPrice
content.price.leadingPrice string

leadingPrice

netPrice
content.price.netPrice float

netPrice

taxRate
content.price.taxRate float

taxRate

title
content.title string

title

type
content.type string

type

unitName
content.unitName string

unitName

Ausgabe
content.version integer

Ausgabe

erste
first boolean

erste

last
last boolean

last

number
number integer

number

numberOfElements
numberOfElements integer

numberOfElements

size
size integer

size

sort
sort array of object

sort

aufsteigend
sort.ascending boolean

aufsteigend

direction
sort.direction string

direction

ignoreCase
sort.ignoreCase boolean

ignoreCase

nullHandling
sort.nullHandling string

nullHandling

property
sort.property string

property

totalElements
totalElements integer

totalElements

totalPages
totalPages integer

totalPages

Response_articles_id_get

Name Pfad Typ Beschreibung
articleNumber
articleNumber string

articleNumber

gtin
gtin string

gtin

id
id string

id

Hinweis
note string

Hinweis

Bruttopreis
price.grossPrice float

Bruttopreis

leadingPrice
price.leadingPrice string

leadingPrice

netPrice
price.netPrice float

netPrice

taxRate
price.taxRate float

taxRate

title
title string

title

type
type string

type

unitName
unitName string

unitName

Ausgabe
version integer

Ausgabe

Response_articles_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_contacts_get

Name Pfad Typ Beschreibung
Inhalt
content array of object

Inhalt

abrechnung
content.addresses.billing array of object

abrechnung

city
content.addresses.billing.city string

city

countryCode
content.addresses.billing.countryCode string

countryCode

Straße
content.addresses.billing.street string

Straße

Ergänzung
content.addresses.billing.supplement string

Ergänzung

zip
content.addresses.billing.zip string

zip

Versand
content.addresses.shipping array of object

Versand

city
content.addresses.shipping.city string

city

countryCode
content.addresses.shipping.countryCode string

countryCode

Straße
content.addresses.shipping.street string

Straße

Ergänzung
content.addresses.shipping.supplement string

Ergänzung

zip
content.addresses.shipping.zip string

zip

archiviert
content.archived boolean

archiviert

allowTaxFreeInvoices
content.company.allowTaxFreeInvoices boolean

allowTaxFreeInvoices

contactPersons
content.company.contactPersons array of object

contactPersons

E-Mail-Adresse
content.company.contactPersons.emailAddress string

E-Mail-Adresse

Vorname
content.company.contactPersons.firstName string

Vorname

lastName
content.company.contactPersons.lastName string

lastName

primär
content.company.contactPersons.primary boolean

primär

Anrede
content.company.contactPersons.salutation string

Anrede

name
content.company.name string

name

Steuernummer
content.company.taxNumber string

Steuernummer

vatRegistrationId
content.company.vatRegistrationId string

vatRegistrationId

Business
content.emailAddresses.business array of string

Business

office
content.emailAddresses.office array of string

office

other
content.emailAddresses.other array of string

other

id
content.id string

id

Hinweis
content.note string

Hinweis

organizationId
content.organizationId string

organizationId

Business
content.phoneNumbers.business array of string

Business

fax
content.phoneNumbers.fax array of string

fax

office
content.phoneNumbers.office array of string

office

other
content.phoneNumbers.other array of string

other

number
content.roles.customer.number integer

number

number
content.roles.vendor.number integer

number

Ausgabe
content.version integer

Ausgabe

erste
first boolean

erste

last
last boolean

last

number
number integer

number

numberOfElements
numberOfElements integer

numberOfElements

size
size integer

size

sort
sort array of object

sort

aufsteigend
sort.ascending boolean

aufsteigend

direction
sort.direction string

direction

ignoreCase
sort.ignoreCase boolean

ignoreCase

nullHandling
sort.nullHandling string

nullHandling

property
sort.property string

property

totalElements
totalElements integer

totalElements

totalPages
totalPages integer

totalPages

Response_contacts_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_countries_get_default

Name Pfad Typ Beschreibung
countryCode
countryCode string

countryCode

countryNameDE
countryNameDE string

countryNameDE

countryNameEN
countryNameEN string

countryNameEN

taxClassification
taxClassification string

taxClassification

Response_credit-notes_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_delivery-notes_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_dunnings_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_event-subscriptions_get

Name Pfad Typ Beschreibung
Inhalt
content array of object

Inhalt

callbackUrl
content.callbackUrl string

callbackUrl

Erstellungsdatum
content.createdDate string

Erstellungsdatum

eventType
content.eventType string

eventType

organizationId
content.organizationId string

organizationId

subscriptionId
content.subscriptionId string

subscriptionId

Response_files_post

Name Pfad Typ Beschreibung
id
id string

id

Response_invoices_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_order-confirmations_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_payment-conditions_get_items

Name Pfad Typ Beschreibung
id
id string

id

organizationDefault
organizationDefault boolean

organizationDefault

discountProzentsatz
paymentDiscountConditions.discountPercentage integer

discountProzentsatz

discountRange
paymentDiscountConditions.discountRange integer

discountRange

paymentTermDuration
paymentTermDuration integer

paymentTermDuration

paymentTermLabelTemplate
paymentTermLabelTemplate string

paymentTermLabelTemplate

Response_posting-categories_get_items

Name Pfad Typ Beschreibung
contactRequired
contactRequired boolean

contactRequired

groupName
groupName string

groupName

id
id string

id

name
name string

name

splitAllowed
splitAllowed boolean

splitAllowed

type
type string

type

Response_profile_get

Name Pfad Typ Beschreibung
businessFeatures
businessFeatures array of string

businessFeatures

companyName
companyName string

companyName

connectionId
connectionId string

connectionId

date
created.date string

date

userEmail
created.userEmail string

userEmail

userId
created.userId string

userId

Nutzername
created.userName string

Nutzername

features
features array of string

features

organizationId
organizationId string

organizationId

Smallbusiness
smallBusiness boolean

Smallbusiness

subscriptionStatus (englisch)
subscriptionStatus string

subscriptionStatus (englisch)

taxType
taxType string

taxType

Response_quotations_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_recurring-templates_get

Name Pfad Typ Beschreibung
Inhalt
content array of object

Inhalt

contactId
content.address.contactId string

contactId

name
content.address.name string

name

Erstellungsdatum
content.createdDate string

Erstellungsdatum

id
content.id string

id

organizationId
content.organizationId string

organizationId

discountProzentsatz
content.paymentConditions.paymentDiscountConditions.discountPercentage integer

discountProzentsatz

discountRange
content.paymentConditions.paymentDiscountConditions.discountRange integer

discountRange

paymentTermDuration
content.paymentConditions.paymentTermDuration integer

paymentTermDuration

paymentTermLabel
content.paymentConditions.paymentTermLabel string

paymentTermLabel

paymentTermLabelTemplate
content.paymentConditions.paymentTermLabelTemplate string

paymentTermLabelTemplate

Enddatum
content.recurringTemplateSettings.endDate string

Enddatum

executionInterval
content.recurringTemplateSettings.executionInterval string

executionInterval

executionStatus
content.recurringTemplateSettings.executionStatus string

executionStatus

Finalize
content.recurringTemplateSettings.finalize boolean

Finalize

id
content.recurringTemplateSettings.id string

id

lastExecutionFailed
content.recurringTemplateSettings.lastExecutionFailed boolean

lastExecutionFailed

nextExecutionDate
content.recurringTemplateSettings.nextExecutionDate string

nextExecutionDate

shippingType
content.recurringTemplateSettings.shippingType string

shippingType

startDate
content.recurringTemplateSettings.startDate string

startDate

title
content.title string

title

Währung
content.totalPrice.currency string

Währung

totalGrossAmount
content.totalPrice.totalGrossAmount integer

totalGrossAmount

totalNetAmount
content.totalPrice.totalNetAmount float

totalNetAmount

updatedDate
content.updatedDate string

updatedDate

erste
first boolean

erste

last
last boolean

last

number
number integer

number

numberOfElements
numberOfElements integer

numberOfElements

size
size integer

size

sort
sort array of object

sort

aufsteigend
sort.ascending boolean

aufsteigend

direction
sort.direction string

direction

ignoreCase
sort.ignoreCase boolean

ignoreCase

nullHandling
sort.nullHandling string

nullHandling

property
sort.property string

property

totalElements
totalElements integer

totalElements

totalPages
totalPages integer

totalPages

Response_voucherlist_get

Name Pfad Typ Beschreibung
Inhalt
content array of object

Inhalt

archiviert
content.archived boolean

archiviert

contactId
content.contactId string

contactId

Name des Kontakts
content.contactName string

Name des Kontakts

Erstellungsdatum
content.createdDate string

Erstellungsdatum

Währung
content.currency string

Währung

dueDate
content.dueDate string

dueDate

id
content.id string

id

openAmount
content.openAmount float

openAmount

totalAmount
content.totalAmount float

totalAmount

updatedDate
content.updatedDate string

updatedDate

voucherDate
content.voucherDate string

voucherDate

voucherNumber
content.voucherNumber string

voucherNumber

voucherStatus
content.voucherStatus string

voucherStatus

voucherType
content.voucherType string

voucherType

erste
first boolean

erste

last
last boolean

last

number
number integer

number

numberOfElements
numberOfElements integer

numberOfElements

size
size integer

size

sort
sort array of object

sort

aufsteigend
sort.ascending boolean

aufsteigend

direction
sort.direction string

direction

ignoreCase
sort.ignoreCase boolean

ignoreCase

nullHandling
sort.nullHandling string

nullHandling

property
sort.property string

property

totalElements
totalElements integer

totalElements

totalPages
totalPages integer

totalPages

Response_vouchers_post

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate string

Erstellungsdatum

id
id string

id

resourceUri
resourceUri string

resourceUri

updatedDate
updatedDate string

updatedDate

Ausgabe
version integer

Ausgabe

Response_contacts_id_put

Name Pfad Typ Beschreibung
archiviert
archived boolean
id
id uuid
organizationId
organizationId uuid
Vorname
person.firstName string
lastName
person.lastName string
Anrede
person.salutation string
number
roles.customer.number integer
Ausgabe
version integer

Response_vouchers_id_put

Name Pfad Typ Beschreibung
Erstellungsdatum
createdDate date-time
dueDate
dueDate date-time
files
files array of object
items
files object
id
id uuid
organizationId
organizationId uuid
Bemerkung
remark string
shippingDate
shippingDate date-time
taxType
taxType string
totalGrossAmount
totalGrossAmount number
totalTaxAmount
totalTaxAmount number
type
type string
updatedDate
updatedDate date-time
useCollectiveContact
useCollectiveContact boolean
Ausgabe
version integer
voucherDate
voucherDate date-time
voucherItems
voucherItems array of object
Menge
voucherItems.amount number
categoryId
voucherItems.categoryId uuid
taxAmount
voucherItems.taxAmount number
taxRatePercent
voucherItems.taxRatePercent number
voucherNumber
voucherNumber string
voucherStatus
voucherStatus string

file

Dies ist der grundlegende Datentyp "Datei".