Verkaufschancen
6 Endpunkte unter /api/rest/2.0
Sales opportunities (Verkaufschancen)
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 |
/sales |
List all sales |
POST |
/sales |
Create a sale |
GET |
/sales/{id} |
Get a sale |
PUT |
/sales/{id} |
Update a sale |
PATCH |
/sales/{id} |
Partially update a sale |
DELETE |
/sales/{id} |
Delete a sale |
Felder
Diese Felder liefert die API zu Verkaufschancen. 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 |
|---|---|---|
customer_id |
integer | Customer ID |
user_id |
integer | Assigned user ID |
external_id |
string | External ID for integration |
name |
string | Sale/opportunity name |
description |
string | Detailed description |
salestatus |
integer | Sale status (0=open, 1=won, 2=lost) |
sellingstatus |
integer | Selling status/phase |
relation_rating |
integer | Relation rating (0-100) |
proposition_rating |
integer | Proposition rating (0-100) |
trust_rating |
integer | Trust rating (0-100) |
competition_rating |
integer | Competition rating (0-100) |
needforaction_rating |
integer | Need for action rating (0-100) |
buyingprocess_rating |
integer | Buying process rating (0-100) |
price_rating |
integer | Price rating (0-100) |
amount |
number | Expected amount/value |
probability |
integer | Win probability percentage (0-100) |
close_date |
date | Expected close date |
last_active_at |
datetime | Last activity timestamp |
created_at |
datetime | Creation timestamp |
created_by |
integer | User ID who created the record |
updated_at |
datetime | Last update timestamp |
updated_by |
integer | User ID who last updated the record |
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.