Kunden
8 Endpunkte unter /api/rest/2.0
Customer management - companies and contacts
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 |
/customers |
List all customers |
POST |
/customers |
Create a customer |
GET |
/customers/{customer_id}/proceedings |
List available proceedings |
POST |
/customers/{customer_id}/proceedings/{proceeding_id}/execute |
Run a proceeding |
GET |
/customers/{id} |
Get a customer |
PUT |
/customers/{id} |
Update a customer |
PATCH |
/customers/{id} |
Partially update a customer |
DELETE |
/customers/{id} |
Delete a customer |
Felder
Diese Felder liefert die API zu Kunden. 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 |
|---|---|---|
customertype_id |
integer | Customer type ID |
agent_id |
integer | Primary agent/sales rep ID |
agent2_id |
integer | Secondary agent/sales rep ID |
salutation |
string | Salutation (Mr., Mrs., etc.) |
name |
string | Company or last name |
name_suffix |
string | Name suffix/addition |
title |
string | Academic title (Dr., Prof., etc.) |
title_suffix |
string | Title suffix (MBA, PhD, etc.) |
first_name |
string | First name |
street |
string | Street address |
postal_code |
string | Postal/ZIP code |
city |
string | City |
po_box |
string | PO Box number |
po_box_postal_code |
string | PO Box postal code |
po_box_city |
string | PO Box city |
country_code |
string | ISO 3166-1 alpha-2 country code |
phone |
string | Primary phone number |
phone2 |
string | Secondary phone number |
mobile |
string | Mobile phone number |
mobile2 |
string | Secondary mobile number |
fax |
string | Fax number |
email |
Primary email address | |
email2 |
Secondary email address | |
website |
uri | Website URL |
customer_number |
integer | Customer number. Pass "auto" or "create" to auto-assign the next available number (requires system setting kundennr + kundennrseq). |
creditor_number |
integer | Creditor/supplier number |
external_id |
string | External system ID |
supplier_customer_number |
string | Customer number at supplier |
branch_id |
integer | Industry/branch ID |
date_of_birth |
date | Date of birth or founding date |
latitude |
number | GPS latitude |
longitude |
number | GPS longitude |
geo_accuracy |
string | Geocoding accuracy level |
created_at |
date-time | Creation timestamp |
created_by |
integer | ID of user who created the record |
updated_at |
date-time | Last modification timestamp |
updated_by |
integer | ID of user who last modified the record |
last_activity_at |
date-time | Last activity timestamp |
language |
string | Language code |
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.