Häufig gestellte Fragen zu der sevDesk API

Einige unserer Modelle, wie unsere Länderliste (StaticCountry) oder Währungsliste (CurrencyExchangeRate) enthalten eine Vielzahl von Einträgen.
Standardmäßig gibt unsere API bei jeder Abfrage nur eine begrenzte Anzahl von Objekten zurück, so dass du nicht alle Einträge erhältst, wenn du ein Modell mit vielen Einträgen abfragst.
Um dies zu umgehen, musst du den Parameter limit verwenden.

Generell können 99% aller in der sevDesk-Weboberfläche verfügbaren Funktionen auch über die API nachgebildet werden.
Wir empfehlen dir, in der Entwicklerkonsole deines Browsers die Registerkarte Netzwerk zu öffnen und zu prüfen, welche Anfragen übertragen werden.
Auf diese Weise erhältst du schnell einen Überblick über die verwendeten Modelle.

Derzeit gibt es keine feste Grenze für die Anzahl der Anfragen, die du an die API senden kannst. Natürlich gibt es ein Sicherheitsnetz für böswillige Anfragen, aber eine normale Nutzung unserer API sollte nie in die Nähe dieses Szenarios kommen.
Wir empfehlen lediglich, Anfragen, die zu Fehlermeldungen führen, auf ein Minimum zu beschränken, da sonst dein API-Token gesperrt werden könnte.
Es ist immer besser, diese Anfragen zu protokollieren und unseren Support zu kontaktieren, falls du sie nicht beheben kannst.

API-Anfragen werden authentifiziert, indem dein API-Token als Wert für den Authorization-Header verwendet wird.

Die Authentifizierung ist fehlgeschlagen.
Dies wird höchstwahrscheinlich durch ein fehlendes oder falsches API-Token verursacht.
Wenn du ein gültiges Token angegeben hast und den Authentifizierungsablauf wie hier beschrieben befolgt, sollte kein Fehler auftreten.
Falls du Anfragen aus demselben Browser sendest, in dem eine sevDesk-Websitzung geöffnet ist, z. B. durch Verwendung unserer Swagger-Spezifikation, kann es auch zu Sitzungskonflikten kommen, die zu diesem Fehler führen.

Eine Adresse wird nicht automatisch auf die Rechnung gesetzt, wenn du einen Kontakt angehängt hast. Das liegt daran, dass ein Kontakt mehrere Adressen haben kann und manche Kunden auch eine eigene Adresse auf ihrer Rechnung wünschen.
Wenn du eine Adresse auf deiner generierten Rechnung haben möchtest, musst du die gesamte Adresse als Wert für das Rechnungsattribut Adresse angeben.
Ist dies nicht der Fall, wird auf der PDF-Rechnung keine Adresse erscheinen.

Bei der Erstellung von Rechnungen mit dem Endpunkt saveInvoice kannst du den Parameter takeDefaultAddress verwenden, um dies zu erreichen.
Mit ihm kannst du festlegen, dass die erste Adresse des Kontakts, den du für die Rechnung verwendest, automatisch für das Adressattribut der Rechnung übernommen wird, so dass du die Adresse nicht selbst eingeben musst.

Um die Vorlage des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden. Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=template&value={templateId}

Die erste Anforderung erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage die Vorlage deines Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Vorlagen-ID

Die folgenden Vorlagen-IDs können verwendet werden:

• Ohne Ansprechpartner / Kundennummer: 573ed07e6bd2d547d21e89e1
• Einfach: 573f03ad6bd2d516c63070f1
• Blau: 573f25c56bd2d51c2100cce1
• Standard: 57986aee6bd2d53306068da1
• Black: 573ef2706bd2d50366786471
• Swiss: 573efc416bd2d5065546eb11

Um alle Vorlagen, auch die von dir erstellten, abzufragen, kannst du auch die folgende Anfrage verwenden: https://my.sevdesk.de/api/v1/DocServer/getTemplatesWithThumb?token={apiToken}

Um die Sprache des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden. Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=language&value={languageCode}

Die erste Anfrage erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage die Sprache Ihres Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Code der zu verwendenden Sprache

Die folgenden Sprachcodes können verwendet werden.

• en_US (US - Englisch)
• de_DE (Deutsch)
• de_AT (Deutsch - Österreich)
• de_CH (Deutsch-Schweiz)
• es_ES (Spanisch)
• fr_FR (Französisch)
• it_IT (Italienisch)
• el_GR (Griechisch)

Um das Briefpapier des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden.

Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=letterpaper&value={letterpaperId}

Die erste Anforderung erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage das Briefpapier deines Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Briefpapier-ID

Die folgenden Briefpapier-IDs können verwendet werden:

• Blank: 57d7ff34f23ada297d265f21
• Ohne Briefpapier: ""

Um alle Briefbögen abzufragen, auch die von dir erstellten, kannst du auch die folgende Anfrage verwenden: https://my.sevdesk.de/api/v1/DocServer/getLetterpapersWithThumb?token={apiToken}

Im Moment bieten wir keine dedizierte Instanz für Entwickler an.

Wir sind jedoch gerne bereit, die Dauer eines kostenlosen Testkontos, um die Zeit zu verlängern, die du für die Entwicklung und Wartung deiner Anwendung benötigst.

Wende dich einfach an unseren Support und gib die folgenden Informationen an.

• Die SevClient-ID des Testkontos ODER die E-Mail-Adresse, mit der es registriert wurde
• Wie viel Zeit werden Sie für die Entwicklung und Pflege deiner Anwendung benötigen?
• Den Namen des Unternehmens, für das du eine Verbindung zu unserer API entwickelst ODER dessen sevDesk-Konto
• Eine kurze Beschreibung der Verbindung, die du entwickelst, und der geplanten Funktionen.

Einige unserer Modelle, wie unsere Länderliste (StaticCountry) oder Währungsliste (CurrencyExchangeRate) enthalten eine Vielzahl von Einträgen.
Standardmäßig gibt unsere API bei jeder Abfrage nur eine begrenzte Anzahl von Objekten zurück, so dass du nicht alle Einträge erhältst, wenn du ein Modell mit vielen Einträgen abfragst.
Um dies zu umgehen, musst du den Parameter limit verwenden.

Generell können 99% aller in der sevDesk-Weboberfläche verfügbaren Funktionen auch über die API nachgebildet werden.
Wir empfehlen dir, in der Entwicklerkonsole deines Browsers die Registerkarte Netzwerk zu öffnen und zu prüfen, welche Anfragen übertragen werden.
Auf diese Weise erhältst du schnell einen Überblick über die verwendeten Modelle.

Derzeit gibt es keine feste Grenze für die Anzahl der Anfragen, die du an die API senden kannst. Natürlich gibt es ein Sicherheitsnetz für böswillige Anfragen, aber eine normale Nutzung unserer API sollte nie in die Nähe dieses Szenarios kommen.
Wir empfehlen lediglich, Anfragen, die zu Fehlermeldungen führen, auf ein Minimum zu beschränken, da sonst dein API-Token gesperrt werden könnte.
Es ist immer besser, diese Anfragen zu protokollieren und unseren Support zu kontaktieren, falls du sie nicht beheben kannst.

API-Anfragen werden authentifiziert, indem dein API-Token als Wert für den Authorization-Header verwendet wird.

Die Authentifizierung ist fehlgeschlagen.
Dies wird höchstwahrscheinlich durch ein fehlendes oder falsches API-Token verursacht.
Wenn du ein gültiges Token angegeben hast und den Authentifizierungsablauf wie hier beschrieben befolgt, sollte kein Fehler auftreten.
Falls du Anfragen aus demselben Browser sendest, in dem eine sevDesk-Websitzung geöffnet ist, z. B. durch Verwendung unserer Swagger-Spezifikation, kann es auch zu Sitzungskonflikten kommen, die zu diesem Fehler führen.

Eine Adresse wird nicht automatisch auf die Rechnung gesetzt, wenn du einen Kontakt angehängt hast. Das liegt daran, dass ein Kontakt mehrere Adressen haben kann und manche Kunden auch eine eigene Adresse auf ihrer Rechnung wünschen.
Wenn du eine Adresse auf deiner generierten Rechnung haben möchtest, musst du die gesamte Adresse als Wert für das Rechnungsattribut Adresse angeben.
Ist dies nicht der Fall, wird auf der PDF-Rechnung keine Adresse erscheinen.

Bei der Erstellung von Rechnungen mit dem Endpunkt saveInvoice kannst du den Parameter takeDefaultAddress verwenden, um dies zu erreichen.
Mit ihm kannst du festlegen, dass die erste Adresse des Kontakts, den du für die Rechnung verwendest, automatisch für das Adressattribut der Rechnung übernommen wird, so dass du die Adresse nicht selbst eingeben musst.

Um die Vorlage des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden. Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=template&value={templateId}

Die erste Anforderung erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage die Vorlage deines Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Vorlagen-ID

Die folgenden Vorlagen-IDs können verwendet werden:

• Ohne Ansprechpartner / Kundennummer: 573ed07e6bd2d547d21e89e1
• Einfach: 573f03ad6bd2d516c63070f1
• Blau: 573f25c56bd2d51c2100cce1
• Standard: 57986aee6bd2d53306068da1
• Black: 573ef2706bd2d50366786471
• Swiss: 573efc416bd2d5065546eb11

Um alle Vorlagen, auch die von dir erstellten, abzufragen, kannst du auch die folgende Anfrage verwenden: https://my.sevdesk.de/api/v1/DocServer/getTemplatesWithThumb?token={apiToken}

Um die Sprache des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden. Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=language&value={languageCode}

Die erste Anfrage erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage die Sprache Ihres Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Code der zu verwendenden Sprache

Die folgenden Sprachcodes können verwendet werden.

• en_US (US - Englisch)
• de_DE (Deutsch)
• de_AT (Deutsch - Österreich)
• de_CH (Deutsch-Schweiz)
• es_ES (Spanisch)
• fr_FR (Französisch)
• it_IT (Italienisch)
• el_GR (Griechisch)

Um das Briefpapier des PDFs zu ändern, müssen die folgenden Anfragen gesendet werden.

Dadurch wird aus einem Entwurf ein PDF erzeugt, das später versendet werden kann.

• api/v1/Invoice/{id}/render
• api/v1/Invoice/{invoiceId}/changeParameter?key=letterpaper&value={letterpaperId}

Die erste Anforderung erstellt das Dokument auf unserem Dokumentenserver und liefert dir die Dokument-ID in der Antwort. Wie du in der URL sehen kannst, benötigt diese Anfrage die ID der Rechnung. In diesem Fall ändert die zweite Anfrage das Briefpapier deines Dokuments. Sie benötigt zwei Parameter in der URL:

• Dokument-ID (kann aus der ersten Anfrage übernommen werden)
• Briefpapier-ID

Die folgenden Briefpapier-IDs können verwendet werden:

• Blank: 57d7ff34f23ada297d265f21
• Ohne Briefpapier: ""

Um alle Briefbögen abzufragen, auch die von dir erstellten, kannst du auch die folgende Anfrage verwenden: https://my.sevdesk.de/api/v1/DocServer/getLetterpapersWithThumb?token={apiToken}

Im Moment bieten wir keine dedizierte Instanz für Entwickler an.

Wir sind jedoch gerne bereit, die Dauer eines kostenlosen Testkontos, um die Zeit zu verlängern, die du für die Entwicklung und Wartung deiner Anwendung benötigst.

Wende dich einfach an unseren Support und gib die folgenden Informationen an.

• Die SevClient-ID des Testkontos ODER die E-Mail-Adresse, mit der es registriert wurde
• Wie viel Zeit werden Sie für die Entwicklung und Pflege deiner Anwendung benötigen?
• Den Namen des Unternehmens, für das du eine Verbindung zu unserer API entwickelst ODER dessen sevDesk-Konto
• Eine kurze Beschreibung der Verbindung, die du entwickelst, und der geplanten Funktionen.