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 (mit Attendees und Kursleitern) zusätzlich customers.	GET /appointments, GET /appointments/{uuid}, GET /booking/available-slots, GET /booking/available-slots/batch, GET /booking/available-slots/next, POST /appointments/service
customers	Kunden	Kunden abrufen, erstellen, bearbeiten	GET /customers, GET /customers/{uuid}, GET /customers/last-opened, POST /customers, PUT /customers/{uuid}, GET /customer-values, GET /customer-values/{uuid}, POST /customer-values
notices	Notizen	Kundennotizen abrufen und erstellen	GET /customer-notices, GET /customer-notices/{uuid}, POST /customer-notices
services	Leistungen	Leistungen abrufen	GET /services, GET /services/{uuid}, GET /service/categories, GET /service/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
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}

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