Présentation des données de facturation #
La ressource Facturation permet de télécharger des factures et des données de facturation à partir de ~.Dimensions.~.
/{VERSION}/billingdata
Schéma des détails de la facture #
Les clients représentent un locataire sur le système auquel les utilisateurs finaux peuvent être affectés via le API.
| Clé | Description | Type | Disponibilité |
|---|---|---|---|
| TenantID | L'identifiant du compte revendeur parent | corde | Tout |
| ID de la facture | Un numéro unique pour identifier une facture particulière | corde | Tout |
| Numéro de facture | Le numéro de facture affiché sur le PDF facture | corde | Tout |
| nom de compte | Nom de l'entreprise pour le compte revendeur parent | corde | Tout |
| BillingPeriodStart | La date de début de la période de facturation | corde | Tout |
| facturationfin | La date de fin de la période de facturation | corde | Tout |
| Valeur de la facture | La valeur totale de la facture | double | Tout |
| facturearticles | Une collection d'éléments de facture | array(Élément de facture | Obtenir les détails de la facture Seulement |
Schéma de l'élément de facture #
Chaque entrée dans les données de facturation fournit les paramètres énumérés ci-dessous.
| Clé | Description | Type |
|---|---|---|
| id | L'identifiant du compte revendeur parent | corde |
| quantité | La quantité utilisée | double |
| valeur | Le coût de l'article | double |
| date d'arrivée | La date à partir de laquelle l'article est facturé | corde |
| à ce jour | La date à partir de laquelle l'article est facturé | corde |
| de calculordre | Numéro séquentiel indiquant l'ordre dans lequel les articles de la facture doivent être traités | Int |
| UtilisateurUtilisé | Indique comment la valeur de l'élément de facture est appliquée à la facture | Opérateur d'élément de facture |
| opérateurvaleurutilisé | Indique la valeur de l'opérateur ADJUSTPERCENTAGE | double |
| producttagname | Le nom de la fonctionnalité/du produit auquel l'élément de facture est destiné. Ce sera au format '{PRODUCT_NAME} #{PART_NUMBER}' | corde |
| facturationsortiebalises | Indication indiquant si l'élément de facture est destiné à un achat ou à un champ récapitulatif | tableau(chaîne) |
| chaînevaleurs | Fournit des informations sur le client et l'utilisateur final pour lequel l'achat est effectué | KeyValuePair< chaîne,chaîne> |
| numériquevaleurs | Fournit des informations sur le client et l'utilisateur final pour lequel l'achat est effectué | KeyValuePair< chaîne,double> |
Opérateurs d'élément de facture #
L'opérateur de chaque article indique comment l'effet est appliqué à la facture. PurchaseResult aura un PRIX pour identifier le coût de l'article. Les articles avec d'autres balises de sortie indiquent s'ils additionnent la valeur de la facture ou s'ils appliquent une valeur en pourcentage aux éléments précédents tels que la taxe de vente.
| Articles | Description |
|---|---|
| PRIX | Indique que l'article facturé affiche le prix unitaire d'un article |
| SOMME | Indique que l'élément de facture affiche un total de plusieurs éléments |
| AJUSTERPOURCENTAGE | Indique que l'élément de facture affiche un ajustement en pourcentage de la SOMME, cela indique généralement que la TVA est appliquée |
Éléments de balise de sortie de facturation #
Les balises de sortie de facturation sont utilisées pour indiquer si la saisie de données se rapporte à un achat ou s'il s'agit d'une entrée récapitulative fournissant des informations sur l'ensemble de la facture.
| Articles | Description |
|---|---|
| PurchaseResult | Indique que l'article facturé est un achat facturable |
| Résumé | Indique que l'élément de facture est un récapitulatif des achats, fournissant des informations sur le total de la facture. Lorsqu'il est seul sans les balises 'TotalVAT' ou 'TotalInclVAT', il indique le montant total de la facture avant l'ajout de la TVA. |
| TotalTVA incluse | Indique que l'élément de facture affiche le total de la facture, y compris la TVA applicable. |
| TotalTVA | Indique que l'élément de la facture affiche le montant total de la TVA applicable à la facture. |
Éléments de valeur de chaîne #
Les articles de valeur de chaîne fournissent des informations spécifiques au client et à l'utilisateur final de l'article acheté.
| Clé | Description | |
|---|---|---|
| TenantCode1 | L'ID de locataire du client | |
| TenantCodeext1 | La référence du revendeur pour le client | |
| TenantName1 | Le nom du client | corde |
| Code du revendeur | L'ID de locataire du revendeur | |
| ResellerCodeExt2 | La référence étendue pour le revendeur | |
| Nom du revendeur | Le nom du revendeur | |
| Identifiant utilisateur | L'identifiant de l'utilisateur | |
| Nom d’utilisateur | Le nom d'utilisateur de l'utilisateur | |
| rôle | Clé de rôle pour l'article facturé |
Éléments de valeur numérique #
Les éléments de valeur numérique fournissent des informations spécifiques au client et à l'utilisateur final de l'article acheté.
| Clé | Description |
|---|---|
| customer_licence_count | Le nombre total de ces licences dont dispose le client |
Interfaces disponibles #
| Interface | Description |
|---|---|
| Tout obtenir | Renvoie un encaissement de toutes les factures. |
| Obtenir une facture | Renvoie les détails d'une facture spécifique. |
| Obtenir les détails de la facture | Retours JSON & CSV sortie de données d'une facture spécifique dans un fichier ZIP. |
| Obtenir le récapitulatif de la facture | Renvoie le PDF Sortie de données d'une facture spécifique. |
-
Les champs 'TenantCode', 'TenantCodeExt' et 'TenantName' sont renseignés avec des informations sur le compte du client. ↩︎
-
Le ResellerCodeExt sera renseigné avec le numéro de référence qui a été configuré pour le revendeur. Celles-ci peuvent être mises à jour si nécessaire via le portail d'entreprise ou via le Client API, pour permettre la liaison des enregistrements du revendeur à des systèmes externes. ↩︎