Ansprechpartner
6 Endpunkte unter /api/rest/2.0
Contact persons associated with customers
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 |
/persons |
List all persons |
POST |
/persons |
Create a person |
GET |
/persons/{id} |
Get a person |
PUT |
/persons/{id} |
Update a person |
PATCH |
/persons/{id} |
Partially update a person |
DELETE |
/persons/{id} |
Delete a person |
Felder
Diese Felder liefert die API zu Ansprechpartner. 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 | Associated customer ID |
persontype_id |
integer | Person type ID |
salutation |
string | Salutation (Herr, Frau, etc.) |
title |
string | Academic title (Dr., Prof., etc.) |
title_suffix |
string | Title suffix (MBA, PhD, etc.) |
first_name |
string | First name |
last_name |
string | Last name |
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 | |
position |
string | Job position/title |
department |
string | Department |
date_of_birth |
date | Date of birth |
external_id |
string | External system ID |
is_invoice_recipient |
boolean | Person receives invoices |
suppress_letter_address |
boolean | Suppress in letter address generation |
in_addressbook |
boolean | Show in address book |
language |
string | Language code |
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 |
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.