Beschreibung
Diese Funktion gibt Ihnen Details und Nummern von einem oder mehreren Profilen aus, zu denen Sie Zugang haben.
URL
/profiles/index[/PID]
Parameter
Key | Beschreibung |
---|---|
PID | Optionaler Parameter. Profil-ID (auch bekannt als Kundennummer). |
Ausgabe
Diese Funktion gibt einen JSON-String aus in folgender Form:{"return":{"code":XXX,"message":"...","data":[profile1,profile2,...]}}
code
code ist ein HTTP-Statuscode und message
ist ein beschreibender Text über den zurückgegebenen Code.
Wenn code
200 ist, wird ein key namens data
ausgegeben, der ein JSON-kodiertes Array von Datensätzen ist, die ihrerseits Arrays mit diesen Schlüsseln sind:
Key | Beschreibung |
---|---|
id | Profil-ID |
firstname | |
lastname | |
company | |
tag | Ein anpassbarer Tag für die Rechnungsstellung. |
Die Rechnungs-E-Mail-Adresse des Unternehmens. Es kann mehr als eine geben, sie werden durch ein Komma oder Semikolon getrennt. | |
vatnumber | Die Umsatzsteuernummer des Unternehmens. |
vatrate | Der Mehrwertsteuersatz in %. |
address | Die Rechnungsadresse des Unternehmens. |
zip | Die Postleitzahl des Unternehmens für die Rechnungsstellung. |
city | Der Rechnungsort des Unternehmens. |
country | Das Rechnungsland des Unternehmens. |
paymethod | Die Bezahlmethode des Profils. Diese Werte sind möglich:prepaid : das Profil mach Vorauszahlungen.invoice : das Profil nutzt Überweisungen.sepa : das Profil hat eine Einzugsermächtigung unterzeichnet.credit card : das Profil hat eine Kreditkarte hinterlegt, die belastet wird. |
credit | Das vorausbezahlte Guthaben des Profils in €. |
status | Der Status des Profils. |
closedate | Das Datum, an dem das Profil geschlossen wurde oder wird. |
fixnumbers | Ein JSON-kodiertes Array mit den festen Telefonnummern des Profils. |
mobilenumbers | Ein JSON-kodiertes Array mit den MIXmobile-Telefonnummern des Profils. Dieses Array hat 2 Keys:number : die mobile Telefonnummer.name : ein auf Ihre Anforderungen anpassbarer Name (z.B. zu Identifikationszwecken). |