Skip to content

Kunde erstellen

Erstellt einen neuen Kunden.

Request

POST /api/oauth/v2/resource/customers

HeaderWert
AuthorizationBearer {access_token}
Content-Typeapplication/json

Body-Parameter

Hinweis: Mindestens eines der Felder firstName, lastName oder companyName ist erforderlich.

FeldTypPflichtBeschreibung
firstNamestringNeinVorname
lastNamestringNeinNachname
companyNamestringNeinFirmenname
titlestringNeinTitel (z.B. Dr., Mag.)
emailstringNeinE-Mail-Adresse
telstringNeinTelefonnummer
telCodestringNeinLändervorwahl (z.B. +43)
streetstringNeinStraße und Hausnummer
zipstringNeinPostleitzahl
citystringNeinStadt
countrystringNeinLändercode (ISO 3166-1 alpha-2, z.B. AT)
birthdaystringNeinGeburtsdatum (YYYY-MM-DD)
sexintegerNeinGeschlecht
noticestringNeinInterne Notiz
customerNumberstringNeinKundennummer
socialNumberstringNeinSozialversicherungsnummer

Response

Erfolg (201 Created)

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": null,
    "firstName": "Max",
    "lastName": "Mustermann",
    "email": "max.mustermann@example.com",
    "phone": "+43 676 9876543",
    "birthday": "1990-08-23",
    "socialNumber": null,
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

Siehe Kunde anzeigen für die vollständige Feldbeschreibung.

Beispiele
bash
curl -X POST "https://my.offisy.at/api/oauth/v2/resource/customers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Max",
    "lastName": "Mustermann",
    "companyName": "Muster GmbH",
    "title": "beispiel",
    "email": "anna.muster@example.com",
    "tel": "+43 664 1234567",
    "telCode": "+43 664 1234567",
    "street": "Musterstraße 1",
    "zip": "4020",
    "city": "Linz",
    "country": "AT",
    "birthday": "beispiel",
    "sex": "1",
    "notice": "beispiel",
    "customerNumber": "beispiel",
    "socialNumber": "1234010190"
  }'
Parameter
Zuerst Token anfordern

Mögliche Fehler

StatusCodeBeschreibung
400validation_errorUngültige Request-Daten (z.B. kein Name angegeben)
401invalid_clientUngültiger oder fehlender Access Token
403insufficient_scopeScope customers nicht vorhanden

Offisy GmbH