Beschreibung
Im API Endpunkt der customers können Kunden in verschiedenen Formen abgerufen werden.
Zum einen können Listen von Kunden in kompakter Form als auch einzelne Kunden mit detaillierten Daten abgerufen werden.
Kunden
Abrufbar unter api/[MANDANT]/customers im folgenden Format mit den folgenden Filtermöglichkeiten:
Format
Schlüssel |
Wert |
Datentyp |
id |
Kundennummer |
int |
name1 |
Name1 |
string |
Filter
Parameter |
Wert |
gültige Werte |
||||
letter |
Selektion nach Name1, Standard A |
string|int |
||||
active |
Aktiv/Passiv, Standard 1
|
int |
||||
group |
Kundengruppe |
string |
||||
searchTerm |
Volltextsuche |
string |
Beispiel JSON-Antwort
[
{
"id":10000,
"name1":"Achim Anmelder"
},
{
"id":10001,
"name1":"Agrargeräte24"
}
]
Kunde
Abrufbar unter api/[MANDANT]/customers/[KUNDENNUMMER] im folgenden Format:
Format
Schlüssel |
Wert |
Datentyp |
id |
Kundennummer |
int |
prefix |
Anrede |
string |
name1 |
Name1 |
string |
name2 |
Name2 |
string |
street |
Straße |
string |
countryCode |
Länderkennzeichen |
string |
zipCode |
PLZ |
string |
city |
Stadt |
string |
phone1 |
Telefon |
string |
phone2 |
Mobil |
string |
fax |
Fax |
string |
fistname |
Vorname |
string |
eMail Adresse |
string |
|
website |
Website |
string |
active |
Aktiv/Passiv Kennzeichen |
int |
newsletter |
Newsletter Kennzeichen |
int |
messageInternal |
Memo |
string |
Beispiel JSON-Antwort
{
"id":10000,
"prefix":"Herr",
"name1":"Achim",
"name2":"Anmelder",
"street":"Musterstr. 1",
"countrycode":"DE",
"zipcode":"12345",
"city":"Musterstadt",
"phone1":"0123 4567891",
"phone2":"0151 1234567",
"fax":"0123 4567892",
"firstname":null,
"email":"achim.anmelder@beispiel.de",
"website":"www.beispiel.de",
"active":1,
"newsletter":0,
"messageInternal":"Kunde benötigt Rückruf"
}