Dieser Endpunkt dient zum Anlegen von Kunden-Datensätzen und ist verfügbar ab Version 2.64.0.

POST - /api/customer/create

Allgemeine Struktur des Aufrufs

Mithilfe der Übergabe des KundenObjekts, kann ein neuer Kunde angelegt werden oder ein bereits im System vorhandener Kunde editiert werden. Ein Kunde gilt als bereits im System vorhanden, wenn entweder die Kundennummer(kdnr) oder die externe Kundennummer(kdnr3) bereits im System ist.

Kunden die bereist im System vorhanden sind, werden nur innerhalb der übergebenen Felder editiert. Felder die in solch einen Fall nicht mit übergeben werden, bleiben unverändert. Ein Feld gilt als nicht übergeben wenn diese nicht innerhalb des Objekts übertragen wurde

Wenn der Kunde noch nicht im System vorhanden ist, wird dieser mit den übergebenen Informationen erstellt. Wenn keine Kundennummer (kdnr) mit übergeben wird, wird diese automatisch von System gesetzt.

Steht der Parameter AUFTRAGSSYSTEM auf 'veolia' wird der Kunde nicht im System angelegt. Stattdessen wird die Kundennummer aus dem Parameter FIBUKONTOLAUFKUNDE gesetzt und das Kundenobjekt mit den restlichen übergebenen Werten gefüllt und zurückgegeben.

Bei der Erstellung eines Kunden, werden alle nicht übergebenen Felder mit DefaultWerten gefüllt.

Ab Version 2.204.0 kann bei der Anlage auf mögliche Duplikate geprüft werden. Wenn mögliche Duplikate erkannt werden wird der Kunde nicht gespeichert ( "success": false ) und die gefundenen Duplikate werden zurück gegeben. Um den Kunden Trotzdem zu speichern muss 'checkduplicate' auf false gesetzt oder weg gelassen werden.

Aufruf ohne Prüfung auf Duplikate

{
  "api_version": 1,
  ...
  "data": {
    "kunden": {%KundenObjekt%}
  }
}

Aufruf mit Prüfung auf Duplikate

{
  "api_version": 1,
  "checkduplicate": true,
  ...
  "data": {
    "kunden": {%KundenObjekt%}
  }
}

Allgemeine Struktur der Antwort

Innerhalb der Antwort werden alle angelegten oder veränderten Objekte mit den gespeicherten Daten zurückgegeben.

Diese Objekte enthalten dann auch die vom System gesetzten Informationen wie z.B. die generierte Kundennummer. Die wichtigsten Details eines Kunden-Objekts sind der Dokumentation zu entnehmen.

Antwort bei erfolgreicher Speicherung

{
  "api_version": 1,
  "success": true,
  "msg": "Erfolg: Der Kunde konnte erfolgreich gespeichert werden",
  "warning": "",
  "data": {
    "kunden": {%KundenObjekt%}
  }
}

Antwort wenn Duplikate gefunden wurden

{
    "api_version": 1,
    "success": false,
    "msg": "Duplikat: Der Kunde wurde nicht gespreichert, da er möglicherweise ein Duplikat ist ",
    "warning": "Warnung",
    "data": {
        "kunden": [
            {%KundenObjekt%},
            {%KundenObjekt%}
        ]
    }
}

Browser nicht unterstützt