Kunde anzeigen

Gibt die Details eines einzelnen Kunden zurück.

Request

GET /api/oauth/v2/resource/customers/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string	Ja	Eindeutige Kunden-ID

Response

Erfolg (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Anna",
    "lastName": "Muster",
    "email": "anna.muster@example.com",
    "phone": "00436641234567",
    "tel": "6641234567",
    "telCode": "0043",
    "phoneSecondary": "00436649876543",
    "telSecondary": "6649876543",
    "telCodeSecondary": "0043",
    "birthday": "1985-04-12",
    "socialNumber": "1234 120485",
    "customerNumber": "K-00123",
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige Kunden-ID
data.title	string | null	Titel (z.B. Dr., Mag.)
data.firstName	string | null	Vorname
data.lastName	string | null	Nachname
data.email	string | null	E-Mail-Adresse
data.phone	string | null	Vollständige Primärnummer: Ländervorwahl + nationale Nummer, verkettet im 00-Format (z.B. 00436641234567)
data.tel	string | null	Nationale Primärnummer ohne Vorwahl (z.B. 6641234567)
data.telCode	string | null	Ländervorwahl der Primärnummer im 00-Format (z.B. 0043)
data.phoneSecondary	string | null	Vollständige Zweitnummer: Vorwahl + Nummer, verkettet im 00-Format
data.telSecondary	string | null	Nationale Zweitnummer ohne Vorwahl
data.telCodeSecondary	string | null	Ländervorwahl der Zweitnummer im 00-Format
data.birthday	string | null	Geburtsdatum (YYYY-MM-DD)
data.socialNumber	string | null	Sozialversicherungsnummer
data.customerNumber	string | null	Kundennummer
data.tenancies	Array	Zugeordnete Mandanten
data.tenancies[].id	string (UUID)	Mandanten-ID
data.tenancies[].name	string	Name des Mandanten
data.tenancies[].abbreviation	string	Kürzel
data.tenancies[].color	string	Farbe als Hex-Code

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/customers/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope customers nicht vorhanden
404	not_found	Kunde nicht gefunden