Kunden-Beziehungen
6 Endpunkte unter /api/rest/2.0
Customer-to-customer relationships (parent, child, supplier, etc.)
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/customer-relations |
List all customer-relations |
POST |
/customer-relations |
Create a customer-relation |
GET |
/customer-relations/{id} |
Get a customer-relation |
PUT |
/customer-relations/{id} |
Update a customer-relation |
PATCH |
/customer-relations/{id} |
Partially update a customer-relation |
DELETE |
/customer-relations/{id} |
Delete a customer-relation |
Felder
Diese Felder liefert die API zu Kunden-Beziehungen. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
source_customer_id |
integer | Source customer ID (the customer that has the relation) |
target_customer_id |
integer | Target customer ID (the related customer) |
relation_type |
string | Type of relationship (parent, child, supplier, customer, invoiceaddress, deliveryaddress, etc.) |
created_by |
integer | ID of user who created the relation |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.