Beschreibung

Diese Funktion gibt Ihnen eine Liste dessen aus, was wir Ihren Kunden in Rechnung gestellt haben.

URL

Monatsbasierte Suche: /invoices/getBillingData?month=YYYY-MM[&pid=PID][&callgrouping=0|1]
Rechnungsbasierte Suche: /invoices/getBillingData?invnumber=X&pid=PID[&callgrouping=0|1]

Parameter

NameBeschreibung
monthDer Monat im YYYY-MM-Format für den Sie Rechnungsdaten suchen möchten.
invnumberRechnungsnummer für die Sie nach Rechnungsdaten suchen möchten.
pidProfil-ID (Kundennummer). Optional für monatsbasierte Suchen, um sie auf einen einzelnen Kunden einzuschränken; verpflichtend für die rechnungsbasierte Suche.
callgroupingOptionaler Parameter. Setzen Sie diesen Wert auf 1, um Anrufdatensätze nach Ziel zu gruppieren. Bei einer monatsbasierten Suche ohne Angabe einer PID erfolgt die Gruppierung nach PID und dann nach Ziel.

Ausgabe

Diese Funktion gibt einen JSON-String aus in folgender Form:
{"return":{"code":XXX,"message":"...","data":[record1,record2,...]}}
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:

KeyBeschreibung
idEindeutige ID des Datensatzes.
pidDer PID, zu dem der Datensatz gehört.
tagEin Tag, der für Ihre Kunden festgelegt werden kann. Dies hilft Ihnen dabei, die Kundenprofile in Ihrem System zu identifizieren.
dateDatum und Zeit, zu der der Datensatz erstellt wurde.
typeTyp des Datensatzes.
productDer Produktname des Datensatzes.
descriptionEine Beschreibung des Produkts. Für anrufbezogene Datensätze enthält sie den Zielnamen (z. B. "Luxemburg mobil"). Für andere Datensätze kann es eine MAC-Adresse oder Seriennummer oder ein beschreibender Text sein.
srcHat nur in anrufbezogenen Datensätzen einen Wert. Enthält die Nummer von der der Anruf ausging. Wenn callgrouping aktiv ist, wird dieses Feld ignoriert.
dstHat nur in anrufbezogenen Datensätzen einen Wert. Enthält die angerufene Nummer Wenn callgrouping aktiv ist, wird dieses Feld ignoriert.
amountbuyIhr Preis pro Einheit in €. Wenn Sie Provisionen für den Datensatz erhalten, werden diese automatisch in diesem Feld berechnet.
amountEin empfohlener Preis in € für Ihre Rechnung an den Kunden.
countDie Zahl der Datensätze im Falle einer Zusammenfassung durch Aktivierung von callgrouping, anderenfalls wird dieses Feld ignoriert.
quantityQuantität oder Minuten im Fall von anrufbezogenen Datensätzen.
totalbuyDie Summe von amountbuy * quantity.
totalDie Summe von amount * quantity.
invoiceUnsere Rechnungsreferenz. Die Syntax ist *PID*INVNUMBER* und erscheint auf all unseren Rechnungs-PDFs. Sie können die INVNUMBER von diesen Referenzen in dieser API wie oben beschrieben verwenden.