Stornogründe
6 Endpunkte unter /api/rest/2.0
Cancellation reasons for cancellation documents, return notes, and cancellation notices
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 |
/cancellation-reasons |
List all cancellationreasons |
POST |
/cancellation-reasons |
Create a cancellationreason |
GET |
/cancellation-reasons/{id} |
Get a cancellationreason |
PUT |
/cancellation-reasons/{id} |
Update a cancellationreason |
PATCH |
/cancellation-reasons/{id} |
Partially update a cancellationreason |
DELETE |
/cancellation-reasons/{id} |
Delete a cancellationreason |
Felder
Diese Felder liefert die API zu Stornogründe. 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 |
|---|---|---|
name |
string | Cancellation reason name/description |
reason_type |
string | Type of reason: cancellation (Stornobeleg), returnnote (Retourenbeleg), cancellationnotice (Kündigung) |
is_default |
boolean | Whether this is the default cancellation reason |
sort |
integer | Sort order for display |
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.