request

Root-Element der Anfrage

1

Element

method

Attribut von request. Name der Webservice-Methode.

1

string

Fester Wert:

„fetchCustomers“

version

Attribut von request. Legt die Version der Anfrage fest.

1

integer

Fester Wert:

„1.0.0“

filter

Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt.

1..N

Element

mandator_id

Schränkt die Ergebnismenge der Abfrage auf Kunden eines bestimmten Mandanten ein.

1

Element

filter_method

Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest.

1

integer

customer_id

Schränkt die Ergebnismenge der Abfrage auf den Kunden mit der angegebenen ID ein.

0..1

Element

filter_method

Attribut von customer_id. Legt das Verhalten des Filters fest.  

1

string

Fester Wert:

„=“

filter_value

Attribut von customer_id. Legt den Filterwert fest.

1

integer

customer_number

Schränkt die Ergebnismenge der Abfrage auf den Kunden mit der angegebenen Kundennummer ein.

0..1

Element

filter_method

Attribut von customer_number. Legt das Verhalten des Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von customer_number. Legt den Filterwert fest.

1

integer

external_customer_id_1

Schränkt die Ergebnismenge der Abfrage auf Kunden mit der gegebenen externen Kundennummer ein.

0..1

string

Länge:

0 - 50 Zeichen

filter_method

Attribut von external_customer_id_1. Legt das Verhalten des Filters fest.

1

string

Feste Werte:

„=“, „like“, „IS“, „IS NOT“

filter_value

Attribut von external_customer_id_1. Legt den Filterwert des Filters fest.

1

integer

Falls filter_

method = „IS“  oder „IS NOT“:

„NULL“

allow_null

Attribut von external_customer_id_1. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

boolean

external_customer_id_2

Schränkt die Ergebnismenge der Abfrage auf Kunden mit der gegebenen externen Kundennummer ein.

0..1

string

Länge:

0 - 50 Zeichen

filter_method

Attribut von external_customer_id_2. Legt das Verhalten des Filters fest.

1

string

Feste Werte:

„=“, „like“, „IS“, „IS NOT“

filter_value

Attribut von external_customer_id_2. Legt den Filterwert des Filters fest.

1

integer

Falls filter_

method = „IS“  oder „IS NOT“:

„NULL“

allow_null

Attribut von external_customer_id_2. Legt fest ob auch Null-Werte in der Ergebnismenge berücksichtigt werden.

0..1

boolean

postal_code

Schränkt die Ergebnismenge der Abfrage nach einer Postleitzahl ein.

0..1

Element

filter_method

Attribut von postal_code. Legt das Verhalten des Postleitzahlen-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von postal_code. Legt den Filterwert des Postleitzahlen-Filters fest.

1

string

email_address

Schränkt die Ergebnismenge der Abfrage auf eine E-Mail-Adresse ein.

0..1

Element

filter_method

Attribut von email_address. Legt das Verhalten des E-Mail-Adressen-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von email_address. Legt den Filterwert des E-Mail-Adressen-Filters fest.

1

string

first_name

Schränkt die Ergebnismenge der Abfrage auf den Vornamen ein.

0..1

Element

filter_method

Attribut von first_name. Legt das Verhalten des Vornamen -Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von first_name. Legt den Filterwert des Vornamen-Filters fest.

1

string

last_name

Schränkt die Ergebnismenge der Abfrage auf den Nachnamen ein.

0..1

Element

filter_method

Attribut von last_name. Legt das Verhalten des Nachnamen-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von last_name. Legt den Filterwert des Nachnamen-Filters fest.

1

string

last_changed_at

Schränkt die Ergebnismenge der Abfrage nach dem letzten Änderungsdatum der Kundendatensätze ein.

0..1

Element

from_date

Attribut von last_changed. Selektiert alle Kundendaten die ab einschließlich des angegebenen Datums geändert wurden.

0..1

dateTime

to_date

Attribut von last_changed. Selektiert alle Kundendaten die bis einschließlich des angegebenen Datums geändert wurden.

0..1

dateTime

created_at

Schränkt die Ergebnismenge der Abfrage nach dem Erstellungsdatum der Kundendatensätze ein.

0..1

Element

from_date

Attribut von created_at. Selektiert alle Kundendaten die ab einschließlich des angegebenen Datums erstellt wurden.

0..1

dateTime

to_date

Attribut von created_at. Selektiert alle Kundendaten die bis einschließlich des angegebenen Datums erstellt wurden.

0..1

dateTime

firm

Schränkt die Ergebnismenge der Abfrage auf die Firma ein.

0..1

Element

filter_method

Attribut von firm. Legt das Verhalten des Firmen-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von firm. Legt den Filterwert des Firmen-Filters fest.

1

string

street

Schränkt die Ergebnismenge der Abfrage auf die Straße ein.

0..1

Element

filter_method

Attribut von street. Legt das Verhalten des Straßen-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von street. Legt den Filterwert des Straßen-Filters fest.

1

string

city

Schränkt die Ergebnismenge der Abfrage auf die Stadt ein.

0..1

Element

filter_method

Attribut von city. Legt das Verhalten des Städte-Filters fest.

1

string

Fester Wert:

„=“

filter_value

Attribut von city. Legt den Filterwert des Städte-Filters fest.

1

string

customer

Wrapper-Element, das die Daten eines Kunden zusammenfasst

0..N

Element

customer_id

ID des Kunden

1

integer

mandator_id

ID des Mandanten dem der Kunde zugeordnet ist.

1

integer

customer_type

Wrapper-Element, das den Kundentyp enthält.

1

Element

customer_type_id

Element von customer_type. ID des Kundentyps.

1

integer

Zulässige Werte:

1 (=Privatkunde) |

2 (=Geschäftskunde)

customer_type_identifier

Element von customer_type. Bezeichner des Kundentyps.

1

string

Zulässige Werte:

„business“|

„private“

customer_number

Kundennummer

1

integer

external_customer_id_1

Externe Kundennummer

0..1

string

Länge:

0 - 50 Zeichen

external_customer_id_2

Externe Kundennummer

0..1

string

Länge:

0 – 50 Zeichen

salutation

Wrapper-Element, das die Anrede enthält.

0..1

Element

salutation_id

Element von salutation. ID der Anrede.

1

integer

Zulässige Werte:

1 (= Herr)

2 (= Frau)

3 (= Firma)

salutation_identifier

Element von salutation. Bezeichner der Anrede.

1

string

Zulässige Werte:

„mr“|

„ms“|

„business“

firm

Firma des Kunden

0..1

string

Länge:

0 – 200 Zeichen

title

Titel des Kunden

0..1

string

Länge:

0 – 100 Zeichen

first_name

Vorname

0..1

string

Länge:

0 – 100 Zeichen

last_name

Nachname

0..1

string

Länge:

0 – 200 Zeichen

street

Straße

0..1

string

Länge:

0 – 200 Zeichen

house_number

Hausnummer

0..1

string

Länge:

0 – 50 Zeichen

street_addition

Zusatzinformation für die Adresse (z.B. bei Müller)

0..1

string

Länge:

0 – 200 Zeichen

postal_code

Postleitzahl

0..1

string

Länge:

0 – 50 Zeichen

city

Ort

0..1

string

Länge:

0 – 200 Zeichen

region

Region

0..1

string

Länge:

0 – 200 Zeichen

country_code_iso

Ländercode

0..1

string

ISO 3166 ALPHA-2 Codes (z.B. „DE“)

phone

Telefonnummer (Festnetz)

0..1

string

Länge:

0 – 50 Zeichen

mobile_phone

Telefonnummer (Mobil)

0..1

string

Länge:

0 – 50 Zeichen

fax

Faxnummer

0..1

string

Länge:

0 – 50 Zeichen

e_mail

E-Mail-Adresse

0..1

string

Länge:

0 – 100 Zeichen

depositor

Kontoinhaber

0..1

string

Länge:

0 – 150 Zeichen

bank_account_number

Kontonummer

0..1

string

Länge:

0 – 20 Zeichen

bank_code

Bankleitzahl

0..1

string

Länge:

0 – 20 Zeichen

bank_name

Name der Bank

0..1

string

Länge:

0 – 150 Zeichen

swift_code

SWIFT-Code

0..1

string

Länge:

0 – 20 Zeichen

iban_code

IBAN-Code

0..1

string

Länge:

0 – 40 Zeichen

homepage

Homepage des Kunden

0..1

string

Länge:

0 – 150 Zeichen

skype

Skype-ID

0..1

string

Länge:

0 – 50 Zeichen

msn

MSN-ID

0..1

string

Länge:

0 – 50 Zeichen

icq

ICQ-Nummer

0..1

string

Länge:

0 – 50 Zeichen

note

Notiz

0..1

string

birthday

Geburtstag

0..1

date

password

Passwort des Kunden

0..1

string

Länge:

0 – 50 Zeichen

created_by

Benutzer der Kunden angelegt hat

0..1

string

tax_id_number

Umsatzsteuer-Ident-Nr.

0..1

string

Länge:

0 – 50 Zeichen

tax_number

Steuer-ID

0..1

string

Länge

0 – 50 Zeichen

shipping_addresses

Wrapper-Element, das alle zum Kunden vorhandenen Lieferadressen enthält

0..1

Element

address

Wrapper-Element, das die Adressteile zusammenfasst

0..N

Element

specific_customer_data

Wrapper-Element, das alle pluginspezifischen Daten zusammenfast

0..1

Element

anonymizations

Wrapper-Element, das die Informationen aller Anonymisierungsvorgänge enthält

0..1

Element

anonymization

Wrapper-Element, das die Informationen zu einer Anonymisierung vorhält.

1

Element

date

Datum der Anonymisierung

1

dateTime

configuration

Bezeichnung der verwendeten Anonymisierungskonfiguration

1

string

address_id

ID der Adresse

1

integer

salutation

Wrapper-Element, das die Anrede enthält.

0..1

Element

salutation_id

Element von salutation. ID der Anrede.

0..1

integer

Zulässige Werte:

1 (= Herr)

2 (= Frau)

3 (= Firma)

salutation_identifier

Element von salutation. Bezeichner der Anrede.

0..1

string

Zulässige Werte:

„mr“ | „ms“ | „business“

firm

Firma des Kunden

0..1

string

Länge:

0 – 200 Zeichen

title

Titel des Kunden

0..1

string

Länge:

0 – 100 Zeichen

first_name

Vorname

0..1

string

Länge:

0 – 100 Zeichen

last_name

Nachname

0..1

string

Länge:

0 – 200 Zeichen

street

Straße

0..1

string

Länge:

0 – 200 Zeichen

house_number

Hausnummer

0..1

string

Länge:

0 – 50 Zeichen

street_addition

Zusatzinformation für die Adresse (z.B. bei Müller)

0..1

string

Länge:

0 – 200 Zeichen

postal_code

Postleitzahl

0..1

string

Länge:

0 – 50 Zeichen

city

Ort

0..1

string

Länge:

0 – 200 Zeichen

country_code_iso

Ländercode

0..1

string

ISO 3166 ALPHA-2

Codes (z.B. „DE“)

phone

Telefonnummer (Festnetz)

0..1

string

Länge:

0 – 50 Zeichen

anonymized_by

Bezeichnung des Anonymisierenden

0..1

string

anonymized_at

Zeitpunkt der letzten Daten-Anonymisierung

0..1

dateTime

3.2.9.75

Redaktionelle Überarbeitung

3.4.9.1

Erweiterung des Calls um Firmen-, Straßen- und Städte-Filter

4.11.18

Erweiterung des Response um Informationen zur Anonymisierung