API – Kunden und Lieferanten

KUNDEN/LIEFERANTEN HERUNTERLADEN

Kunden/Lieferanten herunterladen: [GET] https://app.erpxt.de/api2/public/customers

Beschreibung der Struktur einer JSON-Anfrage:

Parameter Beschreibung
$id Sequenznummer der JSON-Antwort
Name Name Kunde/Lieferant
CustomerTaxNumber Steueridentifikationsnummer – abhängig vom Feld CustomerType
CustomerCode Code Kunde/Lieferant
Mail E-Mail-Adrese Kunde/Lieferant
PhoneNumber
Telefonnummer Kunde/Lieferant
CustomerType Kunde/Lieferant Art (0 – Endverbraucher  / 1 – Geschäftskunde)
Address Kunden/Lieferanten Adresse
       $id Sequenznummer der JSON-Antwort
       Street Straße
       BuildingNumber Hausnummer
       FlatNumber Adresse – Zusatzfeld
       PostalCode PLZ
       City Ort
       Id Die ID der Adresse in der Datenbank
Id Kunden/Lieferanten-ID in der Datenbank
CustomerKind 1 – Kunde / 2 – Lieferant / – Kunde und Lieferant

Beispiel für eine JSON-Antwort:

API_liste_kunden_Lieferanten2

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Es ist auch möglich, eine Karte eines bestimmten Kunden/Lieferanten herunterzuladen.

[GET] https://app.erpxt.de/api2/public/customers/XXX (wobei XXX die ID des Kunden/Lieferanten in der Datenbank ist)

Beispielabfrage: [GET] https://app.erpxt.de/api2/public/customers/1

API_kunden_lieferanten_id2

 

HINZUFÜGEN EINES NEUEN KUNDEN/LIEFERANTEN

Hinzufügen eines Kunden/Lieferanten: [POST] https://app.erpxt.de/api2/public/customers

Beschreibung der JSON-Abgrage, Struktur:

Parameter Beschreibung Ist der Parameter obligatorisch?
Name Name Kunde/Lieferant Ja
CustomerTaxNumber Steueridentifikationsnummer Nein
CustomerCode Kundennummer/Lieferantennummer Nein1
Mail E-Mail Kunde/Lieferant Nein
PhoneNumber
Telefonnummer Kunde/Lieferant Nein
CustomerType Art des Auftragnehmers (0 – Endverbraucher / 1 – Geschäftskunde) Nein2
Address Ein Abschnitt mit der Adresse Kunde/Lieferant
       Street Straße Nein
       BuildingNumber Hausnummer Nein
       FlatNumber Adresse – Zusatzfeld Nein
       PostalCode PLZ Nein
       City Ort Nein

1) Wenn kein Code vorhanden ist, wird dieser von dem Server gesendet.

2) Wenn kein Typ vorhanden ist, wird die Standardeinstellung (Geschäftskunde) verwendet.

Beispiel für eine JSON-Abfrage:

API_kunden_lieferanten_hinzufuegen

 

 

 

 

 

Als Antwort wird die ID des hinzugefügten Kunden/Lieferanten gesendet.

Beispielantwort:

API_kunden_lieferanten_hinzufuegen_antw

 

 

BEARBEITEN EINES KUNDEN/LIEFERANTEN

Kunden/Lieferanten-Edition: [PUT] https://app.erpxt.de/api2/public/customers

Beschreibung der JSON-Abfragen, Struktur:

Parameter Beschreibung Ist der Parameter obligatorisch?
Name Name Kunde/Lieferant Ja
CustomerTaxNumber Steueridentifikationsnummer Nein
CustomerCode Kundennummer/Lieferantennummer Nein
Mail E-Mail-Adresse Kunde/Lieferant Nein
PhoneNumber
Telefonnummer Kunde/Lieferant Nein
CustomerType Art des Auftragnehmers (0 – Endverbraucher / 1 – Geschäftskunde) Nein
Address Ein Abschnitt mit der Adresse Kunde/Lieferant
       Street Straße Nein
       BuildingNumber Hausnummer Nein
       FlatNumber Adresse – Zusatzfeld Nein
       PostalCode PLZ Nein
       City Ort Nein
       Id Id Adresse Nein
Id Id Kunde/Lieferant Ja

 

HINWEIS
Wenn optionale Parameter weggelassen werden, werden sie mit Standard- oder Leerwerten überschrieben.

Die Antwort erhält den Status und möglicherweise die Antwort JSON:

Beispiel für eine JSON-Abfrage (Hinzufügen einer E-Mail-Adresse für einen Kunden/Lieferanten mit der ID = 2):

API_kunden_lieferanten_bearbeiten2

 

 

 

 

Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen: Folgt in Kürze!

api_update_produkt_antw2

 

 

 

LÖSCHEN EINES KUNDEN/LIEFERANTEN

Löschen eines Auftragnehmers: [DEL] https://app.erpxt.de/api2/public/customers/XXX (wobei XXX die ID des Auftragnehmers in der Datenbank ist)

Beispielabfrage: [DEL] https://app.erpxt.de/api2/public/customers/3

Beispiel für eine JSON-Antwort – Status 204 No Content – Vorgang erfolgreich abgeschlossen:

api_update_produkt_antw2

 

 

 

 

Czy ten artykuł był pomocny?