API Reference

Auftrags-API

Serviceaufträge erstellen und verwalten

Die Auftrags-API ermöglicht das Erstellen, Aktualisieren und Verwalten von Serviceaufträgen. Aufträge sind die zentrale Entität in ManoPlan und repräsentieren einzelne Servicetermine, die Monteuren zugewiesen werden.

Endpunkte

Aufträge auflisten

GET
/api/jobs

Alle Aufträge Ihres Unternehmens abrufen

Auftrag abrufen

GET
/api/jobs/:id

Einen bestimmten Auftrag per ID abrufen

Auftrag erstellen

POST
/api/jobs

Einen neuen, noch nicht disponierten Serviceauftrag erstellen

Auftrag erstellen und disponieren

POST
/api/jobs/dispatch

Auftrag mit Termin, Fahrzeug oder Crew erstellen; erfordert Dispatch- und Auftrags-Schreibrecht

Auftrag aktualisieren

PATCH
/api/jobs/:id

Einen bestehenden Auftrag aktualisieren

Auftrag löschen

DELETE
/api/jobs/:id

Einen Auftrag löschen

Status aktualisieren

PATCH
/api/jobs/:id/status

Auftragsstatus aktualisieren

Auftragsstatus

Aufträge durchlaufen diese Statuswerte

newNeu - Auftrag erstellt, aber nicht geplant
plannedGeplant - Termin festgelegt
confirmedBestätigt - Kunde benachrichtigt
en_routeUnterwegs - Monteur auf dem Weg
in_progressIn Bearbeitung - Arbeit begonnen
completedAbgeschlossen - Arbeit beendet
billedAbgerechnet - Rechnung erstellt

Auftragsfelder

Verfügbare Felder beim Erstellen oder Aktualisieren von Aufträgen

customerIdKunden-ID (erforderlich)
categoryAuftragskategorie (z. B. Heizung, Elektro)
descriptionAuftragsbeschreibung
priorityPrioritätsstufe (niedrig, normal, hoch, dringend)
estimatedMinutesGeschätzte Dauer in Minuten
scheduledDateGeplanter Tag (YYYY-MM-DD; Dispatch-Endpunkt)
scheduledStartTimeGeplante Startzeit (ISO 8601; Dispatch-Endpunkt)
bufferMinutesZeitpuffer in Minuten (Dispatch-Endpunkt)
assignedVehicleIdZugewiesene Fahrzeug-ID (Dispatch-Endpunkt)
employeeIdsZugewiesene Mitarbeiter-IDs (Dispatch-Endpunkt)

Best Practices

  • Fügen Sie immer eine aussagekräftige Auftragsbeschreibung hinzu
  • Setzen Sie realistische Zeitschätzungen für bessere Planung
  • Nutzen Sie den Status-Endpunkt zur Verfolgung des Auftragsfortschritts
  • Fügen Sie Material-Sets für vollständige Auftragsdokumentation hinzu

Weitere API-Dokumentation

Customers API

Kundendaten verwalten

Routes API

Routen optimieren und verwalten

Jobs API testen

Erstellen und verwalten Sie Aufträge über die API