API-Referenz

Die Programmierschnittstelle besteht aus zwei Teilen. Funktionsaufrufe unter /api/method/<Modulpfad> führen Aufgaben aus, etwa einen Mahnlauf vorschauen oder eine Sendung verfolgen. Standard-Ressourcen unter /api/resource/<Belegtyp> lesen und ändern Belege wie Kunden, Artikel oder Rechnungen.

Beide Teile verwenden dieselbe Anmeldung und dieselben Rechte wie die Oberfläche. Wer in der Oberfläche etwas nicht sehen oder ändern darf, darf es auch über die Schnittstelle nicht.

So beginnen Sie

1. Legen Sie für einen Benutzer einen API-Schlüssel an (siehe Authentifizierung).
2. Rufen Sie eine lesende Funktion auf, zum Beispiel aus dem Modul Startseite.
3. Lesen Sie das Fehlermodell, bevor Sie schreibende Aufrufe einbauen.

Inhalt

• Authentifizierung
• Fehlermodell
• Standard-Ressourcen, Filter und Seitenweise Abruf
• Stabilität und Versionierung

Funktionen nach Modul

• AdressenAdressbericht, Dublettenprüfung und Anlegen von Kunden und Lieferanten. (2)
• AssistentFragen zu Aufträgen und Kunden, Datenqualität und tägliche Vorschläge. (9)
• AuftragsampelDie fünf Ampeln eines Auftrags: Lager, Zahlung, Adresse, Kunde, Versand. (1)
• AustrittspaketVollständiger Datenexport für Systemverwalter. (3)
• BankabgleichZuordnung von Zahlungseingängen zu offenen Rechnungen. (2)
• BeispieldatenBranchenprofile mit erfundenen Daten laden und wieder entfernen. (5)
• BetriebStatusseite für Systemverwalter. (1)
• Box und StreckengeschäftAufteilung von Aufträgen nach Lieferort, Datenfrische, Regeln und Auftragsbahn. (15)
• BranchenvorlagenVorlagen für Artikelgruppen, Lager, Zahlungsbedingungen und Regeln. (3)
• Chargen und HaltbarkeitMindesthaltbarkeitsbericht und Aufgaben für ablaufende Chargen. (2)
• DatenimportCSV-Dateien einlesen, zuordnen, prüfen und übernehmen. (3)
• DatenqualitätDubletten und Lücken in Stammdaten. (1)
• DATEVVorprüfung, Stapelhistorie und Stammdaten für den Steuerberater. (4)
• Demo und Erster BlickDemo-Zugang und Startzustand. (5)
• DiagrammquellenDatenquelle für das Diagramm der meistverkauften Artikel. (1)
• E-RechnungXRechnung und ZUGFeRD erzeugen, prüfen und Eingangsrechnungen einlesen. (11)
• EinkaufZulaufkalender für offene Bestellungen. (1)
• EinrichtungsassistentStand und Eingaben der ersten Einstellungen. (3)
• EinstellungsregisterKennzahl zu noch zu bestätigenden Einstellungen. (1)
• ForderungenForderungsalterung, Kontoauszug und CSV-Export. (3)
• FreigabenRegeln, Anfragen und Entscheidungen nach dem Vier-Augen-Prinzip. (7)
• GoBD-ExportDatenträgerüberlassung für Betriebsprüfungen. (1)
• InventurZählplan, Bestände und Bewertung. (2)
• Lager mobilScan, Wareneingang, Umlagerung, Auslagerung und Inventur am Handy. (15)
• LieferantenrückgabeRückgaben an Lieferanten mit erwarteter Gutschrift. (3)
• MahnwesenMahnlauf mit Vorschau, Entwürfen und Mahnsperre. (7)
• MarktplätzeImport, Journal, Fristen, Auszahlungsabgleich, Vorschau und Kanalbilanz. (16)
• PreislistenPreisvergleich, Importvorschau und Konditionen. (3)
• Prüfer-NachweisÄnderungsprotokoll, Archivprüfung, Vier-Augen-Regeln und Zugriffsprotokoll. (4)
• RahmenaufträgeRahmenaufträge mit Restmenge und Abrufprüfung. (2)
• RetourenRetourenverwaltung und das öffentliche Anmeldeformular. (9)
• RückverfolgungVerbleib und Herkunft von Chargen und Seriennummern. (3)
• SelbstprüfungGesundheitsprüfung für Systemverwalter. (1)
• Set-ArtikelBaubare Sets und Montage. (3)
• StartseiteKennzahlen der Startseite. (3)
• Stücklisten und FertigungStücklistenbaum, Fertigungsauftrag und Fertigungsbedarf. (4)
• Umzug und ParallellaufNummern-Alias, Umzugsplan und Vergleich mit dem Altsystem. (17)
• VersandVersandzentrum, Packtisch, Sendungen, Versandkosten und Sendungsverfolgung. (9)
• ZahlungsvorschlagZahlungsvorschlag mit Vier-Augen-Freigabe und SEPA-Datei. (4)

Maschinenlesbar: openapi.json (OpenAPI 3.1, 189 Funktionen).