- Start
- API-Referenz
- API-Dokumentation (XML/ JSON)
- Objekte
Objekt Basic Customer
Beschreibung
Das Objekt BasicCustomer beschreibt den Kunden.
Aufbau
| JSON Keyword | XML Keyword | Häufigkeit | Typ | Format | Beschreibung |
|---|---|---|---|---|---|
| number | number | 1 | integer | int64 | Kundennummer |
| client | client | 1 | string | Kundengruppe | |
| group | group | 0 - 1 | integer | int64 | Kundengruppennummer |
| name | name | 1 | string | Name des Kunden, Max. 255 Zeichen | |
| type | type | 1 | enum | CustomerType | Typ des Kunden |
| organization | organization | 0 - 1 | string | Name des Unternehmens | |
| organization2 | organization2 | 0 - 1 | string | Name des Unternehmens | |
| vatNumber | vat_number | 0 - 1 | Mehrwertsteuernummer | ||
| gender | gender | 0 - 1 | enum | Gender | Geschlecht |
| title | title | 0 - 1 | string | Titel des Kunden | |
| addressLines | address | 0 - n | string | Anschrift des Kunden | |
| city | city | 1 | string | Wohnort des Kunden | |
| state | state | 0 - 1 | string | Bundesstaat des Wohnortes | |
| country | county | 1 | string | Land des Wohnorts | |
| phone | phone | 1 | string | phone | Telefonnummer des Kunden, Format +49-123-12345 |
| fax | fax | 0 - 1 | string | phone | Faxnummer des Kunden, Format +49-123-12345 |
| emails | 1 - n | string | E-Mail-Adressen des Kunden | ||
| billingEmails | billing_email | 0 - n | string | E.Mail-Adresse für die Abrechnung | |
| contacts | contact | 0 - n | object | Zusätzliche Kontaktdaten des Kunden | |
| payment | payment | 1 | enum | PaymentConstants | Beschreibt die Bezahlweise. |
| paymentMode | payment_mode | 1 | string | Beschreibt die Methode für die Bezahlweise. Bsp.: Sepa, Paypal. | |
| paymentCurrency | payment_currency | 1 | string | Währung, in der der Kunde bezahlt | |
| payment_currency_exchange_fee | 1 | number | double | Gebühr, die bei der Währungsumrechnung anfällt | |
| discountValid | discount_valid | 0 - 1 | string | date-time | Ende der Gültigkeit eines Promotion-Angebotes |
| invoiceLanguage | invoice_language | 0 - 1 | string | Sprache, in der die Rechnung erstellt wird. | |
| invoice_days | 0 - 1 | object | Tage bis die Rechnung fällig wird | ||
| invoice_paperbill | 1 | boolean | Weg des Rechnungsversands
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. | ||
| pin | pin | 1 | string | Pin-Nummer für Support-Anfragen | |
| taxable | taxable | 1 | boolean | Wird Mehrwertsteuer für diesen Kunden berechnet?
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. | |
| card | card | 1 | object | Card | Kreditkarte für die Abrechnung |
| contracts | customer_contract | 0 - n | object | CustomerContract | Die Verträge des Kunden |
| autodelete | 1 | boolean | Ist der Kunde eine Autodelete-Kunde?
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. | ||
| pending | pending | 1 | boolean | Sind die Daten des Kunden in noch in Prüfung?
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. Wenn die Daten noch in Prüfung sind, gibt es ein persisten Objekt, dass die aktuell geprüften Daten zurückgibt. | |
| verifications | 0 - 1 | object | BasicCustomerSpoolVerification | Zeigt die laufenden E-Mail-Verifizierungen an. | |
| account | account | 1 | object | Account | Abrechnungs-Konto des Kunden |
| locked | locked | 1 | boolean | Angabe, ob der Kunde gesperrt ist.
Vorgabewert = false Für XML können auch 0 (false) und 1 (true) verwendet werden. | |
| persistent | persistent | 1 | object | BasicCustomer | Aktuelle Daten des Kunden, falls eine Aktualisierung ansteht und die Daten noch nicht geprüft wurden pending ist in diesem Fall true |
| billingUsers | billing | 1 - n | string | Abrechnungs-Kontakte | |
| comments | comment | 0 - n | string | Kommentare zu diesem Kunden | |
| fname | fname | 1 | string | Vorname des Kunden | |
| lname | lname | 1 | string | Nachname des Kunden | |
| pcode | pcode | 1 | string | Postleitzahl der Kundenadresse | |
| sepa | sepa_mandate | 0 - 1 | object | SEPAMandate | SEPA-Mandat des Kunden |
| lastConfirmed | last_confirmed | 0 - 1 | string | date-time | Datum an dem die Kundendaten zuletzt bestätigt wurden. |
| pricelists | 0 - 1 | object | CustomerPriceLists | Liste der Preislisten für den Kunden | |
data_privacy_statement | 0 - 1 | boolean | Datenschutz gelesen und akzeptiert
Vorgabewert = false | ||
newsletter | newsletter | 0 - 1 | boolean | Zum Newsletter angemeldet oder nicht.
Vorgabewert = true | |
supplier_number | 0 - 1 | string | Lieferantennummer | ||
url | 0 - 1 | string | Optionale Url für den Kunden | ||
owner | owner | 1 | object | Benutzer, der diesem Kunden zugeordnet ist | |
updater | updater | 1 | object | Benutzer, der diesen Kunden zuletzt aktualisiert hat | |
created | created | 1 | string | date-time | Datum, wann der Kunde erstellt wurde |
updated | updated | 1 | string | date-time | Datum, wann der Kunde zuletzt aktualisiert wurde |