Scopes

Scopes steuern, auf welche API-Bereiche ein OAuth-Client zugreifen darf. Du vergibst Scopes beim Erstellen eines API-Zugangs in den Offisy-Einstellungen.

Die Einrichtung eines API-Zugangs ist im Help Center beschrieben.

Verfügbare Scopes

Scope	Label	Beschreibung	Freigeschaltete Endpoints
full_access	Vollzugriff	Zugriff auf alle Endpoints	Alle
appointments	Termine	Termine abrufen und buchen. Für GET /appointments und GET /appointments/{uuid} ist immer zusätzlich users erforderlich. Für Kurs-Termine zusätzlich customers. Die Kurs-Endpoints selbst erfordern die Scopes courses und users.	GET /appointments, GET /appointments/{uuid}, GET /appointments/{uuid}/references, GET /booking/available-slots, GET /booking/available-slots/batch, GET /booking/available-slots/next, POST /appointments/service, POST /appointments/{uuid}/cancel
courses	Kurse	Kurse abrufen. Zusätzlich ist immer users erforderlich. Für die Teilnehmerliste (attendees) ist zusätzlich customers erforderlich. Fehlt customers, fehlt der Schlüssel attendees in der Antwort vollständig – er ist nicht [] und nicht null. Die Zahl currentAttendees bleibt immer enthalten. Die Teilnehmer-Endpoints erfordern immer die Scopes courses, users und customers. Alle Kurs-Endpoints setzen zusätzlich die Kurs-Lizenz voraus; ohne sie antworten sie mit 403.	GET /courses, GET /courses/{uuid}, GET /courses/{uuid}/attendees, GET /courses/{uuid}/attendees/{attendeeUuid}
customers	Kunden	Kunden abrufen, erstellen, bearbeiten	GET /customers, GET /customers/{uuid}, GET /customers/last-opened, POST /customers, PUT /customers/{uuid}, GET /customers/values, GET /customers/values/{uuid}, POST /customers/values, GET /customers/groups, GET /customers/groups/{uuid}, POST /customers/groups, PUT /customers/groups/{uuid}, DELETE /customers/groups/{uuid}, GET /customers/{uuid}/groups, POST /customers/{uuid}/groups/{groupUuid}, DELETE /customers/{uuid}/groups/{groupUuid}
notices	Notizen	Kundennotizen abrufen und erstellen	GET /customers/notices, GET /customers/notices/{uuid}, POST /customers/notices
todos	Aufgaben	Aufgaben abrufen, erstellen, bearbeiten und löschen. Für customerUuid ist immer zusätzlich customers erforderlich, für assignedToUuid zusätzlich users	GET /todos, GET /todos/{uuid}, POST /todos, PUT /todos/{uuid}, DELETE /todos/{uuid}, GET /todos/statuses, GET /todos/statuses/{uuid}, GET /todos/tags, GET /todos/tags/{uuid}, POST /todos/{uuid}/status, GET /todos/{uuid}/references, POST /todos/{uuid}/references, GET /todos/{uuid}/references/{referenceUuid}, DELETE /todos/{uuid}/references/{referenceUuid}
forms	Formulare	Zugriff auf Formulare und versendete Formulare, nur Metadaten (keine Formular-Antworten, keine Empfängerdaten)	GET /forms/{uuid}, GET /forms/customers/{uuid}
services	Leistungen	Leistungen abrufen	GET /services, GET /services/{uuid}, GET /services/categories, GET /services/categories/{uuid}
company	Unternehmen	Unternehmensprofil und Mandanten abrufen	GET /company, GET /tenancies, GET /tenancies/{uuid}
locations	Standorte	Standorte abrufen	GET /locations, GET /locations/{uuid}
users	Mitarbeiter	Mitarbeiter abrufen	GET /users, GET /users/{uuid}
executions	Leistungszuordnungen	Leistungszuordnungen abrufen – welche Mitarbeiter welche Leistung an welchem Standort anbieten	GET /executions
medicals	Medizinische Daten	Medizinische Patientendaten abrufen und erstellen	Abrechnungsleistungen: GET /fee-note-services, GET /fee-note-services/{uuid}, POST /fee-note-services, PUT /fee-note-services/{uuid}; Diagnosen: GET /diagnoses, GET /diagnoses/{uuid}, POST /diagnoses; Anamnesen: GET /evidences, GET /evidences/{uuid}, POST /evidences; Dauermedikationen: GET /long-term-medications, GET /long-term-medications/{uuid}, POST /long-term-medications; Sportbefreiungen: GET /sports-exemptions, GET /sports-exemptions/{uuid}, POST /sports-exemptions; Überweisungen: GET /referrals, GET /referrals/{uuid}, POST /referrals; Eingehende Überweisungen: GET /incoming-referrals, GET /incoming-referrals/{uuid}, POST /incoming-referrals; Verordnungen: GET /regulations, GET /regulations/{uuid}, POST /regulations; Arztbesuchsbestätigungen: GET /visit-confirmations, GET /visit-confirmations/{uuid}, POST /visit-confirmations; Arztbriefe: GET /doctor-letters, GET /doctor-letters/{uuid}, POST /doctor-letters; Patientenbriefe: GET /patient-letters, GET /patient-letters/{uuid}, POST /patient-letters; Transportscheine: GET /transports, GET /transports/{uuid}, POST /transports; Laborbefunde: GET /lab-results, GET /lab-results/{uuid}, POST /lab-results; Arbeitsunfähigkeiten: GET /illness-notifications, GET /illness-notifications/{uuid}, POST /illness-notifications; Gesundmeldungen: GET /health-notifications, GET /health-notifications/{uuid}, POST /health-notifications; Dateien: GET /files, GET /files/{uuid}, GET /files/{uuid}/download, POST /files
dunnings	Mahnwesen	Mahnungen abrufen und erstellen, Mahnstufen abrufen	GET /invoices/dunnings, GET /invoices/dunnings/{uuid}, POST /invoices/dunnings, GET /invoices/dunnings/types, GET /invoices/dunnings/types/{uuid}
invoices	Rechnungen	Rechnungen, Bareinnahmen und Honorarnoten abrufen	GET /invoices, GET /invoices/{uuid}, GET /cash-revenues, GET /cash-revenues/{uuid}, GET /fee-notes, GET /fee-notes/{uuid}
wares	Waren & Lager	Artikelstammdaten (GET /wares, GET /wares/{uuid}) und Warenkategorien (GET /wares/categories) abrufen – dafür reicht die Berechtigung. Bestand, Bewegungen, Bestellungen, Lagerorte und Lieferanten benötigen zusätzlich die Lagerverwaltung. Ohne sie liefert GET /wares weiterhin 200, aber ohne den stock-Block; die übrigen betroffenen Endpoints liefern 403.	GET /wares, GET /wares/{uuid}, GET /wares/movements, GET /wares/movements/{uuid}, GET /wares/purchases, GET /wares/purchases/{uuid}, GET /wares/categories, GET /wares/categories/{uuid}, GET /wares/storages, GET /wares/storages/{uuid}, GET /wares/distributors, GET /wares/distributors/{uuid}
reports	Auswertungen	Umsatz- und Produktivitätsauswertungen abrufen. Für die Gruppierung nach Kunde (groupBy=customer, customerId) ist zusätzlich customers erforderlich.	GET /fee-note-services/turnover, GET /fee-note-services/productivity

Hinweis: Ein Client mit dem Scope full_access besteht jede Scope-Prüfung automatisch – unabhängig davon, welcher Scope am jeweiligen Endpoint gefordert wird.