Description
Cette fonction vous donne une liste de ce que nous avons facturé à vos clients.
URL
Recherche par mois : /invoices/getBillingData?month=YYYY-MM[&pid=PID][&callgrouping=0|1]
Recherche par facture : /invoices/getBillingData?invnumber=X&pid=PID[&callgrouping=0|1]
Paramètres
Nom | Description |
---|---|
month | Le mois pour lequel vous souhaitez chercher les données de facturation dans le format YYYY-MM . |
invnumber | Le numéro de facture pour lequel vous souhaitez chercher les données de facturation. |
pid | L'ID du profil (numéro de client). Facultatif pour la recherche par mois afin de limiter la recherche à un client particulier ; obligatoire pour la recherche par facture. |
callgrouping | Paramètre facultatif. Mettez sur 1 pour regrouper les enregistrements d'appels par destination. Dans une recherche basée sur le mois sans donner de PID, le regroupement se fait par PID et ensuite par destination. |
Retour
Cette fonction renvoie une chaîne JSON sous la forme de{"return":{"code":XXX,"message":"...","data":[record1,record2,...]}}
code
est un code du statut HTTP et message
est un texte descriptif sur le code renvoyé.
Si code
est 200, il y aura une clé appelée data
dans le retour qui est un tableau codé JSON d'enregistrements qui sont eux-mêmes des tableaux avec ces clés :
Key | Description |
---|---|
id | ID unique de l'l'enregistrement. |
pid | Le PID auquel appartient l'l'enregistrement. |
tag | Un tag que vous pouvez définir pour vos clients. Cela peut vous aider à identifier le profile du client dans votre système. |
date | La date et l'heure à laquelle l'enregistrement a été généré. |
type | Le type d'l'enregistrement. |
product | Le nom du produit de l'l'enregistrement. |
description | Une description du produit. Pour les enregistrements liés aux appels, le retour contient le nom de la destination (p.ex. “Luxembourg mobile”). Pour les autres enregistrements, le retour peut contenir une adresse MAC ou un numéro de série ou un texte descriptif. |
src | À seulement une valeur pour les enregistrements liés aux appels. Contient le numéro qui a lancé l'appel. Si callgrouping est activé, ce champ doit être ignoré. |
dst | À seulement une valeur pour les enregistrements liés aux appels. Contient le numéro qui a été appelé. Si callgrouping est activé, ce champ doit être ignoré. |
amountbuy | Votre prix unitaire en €. Si vous recevez des commissions sur l'enregistrement, elles sont automatiquement calculées dans ce champ. |
amount | Un prix recommandé en € à facturer à votre client. |
count | Le nombre d'enregistrements dans le cas d'un groupement en activant callgrouping , sinon ce champ doit être ignoré. |
quantity | Quantité ou minutes dans le cas des enregistrements liés aux appels. |
totalbuy | Le total de amountbuy * quantity. |
total | Le total de amount * quantity. |
invoice | Notre référence de facture. La syntaxe est *PID*INVNUMBER* et est visible sur tous nos PDF de factures. Vous pouvez utiliser le INVNUMBER de ces références dans cette API comme décrit ci-dessus. |