Skip to main content
Die Express-API ist unter dem Präfix /api erreichbar. Die API-Referenz wird aus der zentralen Spezifikation lib/api-spec/openapi.yaml und den im Hauptrouter eingebundenen Routen erzeugt. Die Dokumentationskopie steht als OpenAPI-Datei bereit.

​
Zwei Dokumentationstiefen

  • Vertraglich beschrieben: Operationen aus der zentralen OpenAPI-Datei übernehmen deren Parameter und Datenschemata.
  • Route erfasst: Zusätzliche implementierte Operationen sind ausdrücklich mit x-documentation-status: route-only gekennzeichnet. Methoden und Pfade sind bekannt; vollständige Anfragen-/Antwortschemata sind dort noch nicht zentral definiert. Ein generischer Antwortblock ist keine Zusicherung bestimmter Felder oder erfolgreicher Verarbeitung.
Die Routenübersicht zeigt die Zuordnung und Quelldatei. Dieser Abgleich ist statisch; er führt keine API-Anfragen aus.
Die Dokumentation ist kein Freibrief für schreibende API-Aufrufe. Der Mintlify-Spielplatz ist absichtlich deaktiviert. Das schützt insbesondere Buchungen, Importe, Löschfunktionen und sevDesk-Übertragungen vor versehentlichen Testaufrufen aus der Dokumentation.

​
Beispiele

PACHTIFY_BASE_URL bezeichnet in Beispielen deine tatsächliche Installationsadresse, nicht die Dokumentationsdomain:
Der Healthcheck antwortet mit {"status":"ok"}. Geschützte Endpunkte erfordern eine gültige Anwendungssitzung. Es wird kein zusätzlicher allgemeiner Bearer-API-Key erfunden oder angeboten.

​
Datums- und Geldwerte

Termine werden als Kalenderdatum YYYY-MM-DD verwendet. Vermeide Zeitzonenverschiebungen bei der Umwandlung in JavaScript-Date. Die Geldberechnung verwendet Centwerte; formatiere angezeigte Eurobeträge nicht erneut als Grundlage für eine eigene Gleitkomma-Nachberechnung. Listen können Filter und Pagination verwenden. Nutze die je Operation beschriebenen Parameter und eine serverseitige Suche für große Objektmengen.